Package com.google.ads.googleads.v13.resources

Class KeywordPlanAdGroup

  • All Implemented Interfaces:
    KeywordPlanAdGroupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class KeywordPlanAdGroup
extends com.google.protobuf.GeneratedMessageV3
implements KeywordPlanAdGroupOrBuilder
     A Keyword Planner ad group.
 Max number of keyword plan ad groups per plan: 200.
    Protobuf type google.ads.googleads.v13.resources.KeywordPlanAdGroup
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  KeywordPlanAdGroup.Builder
      A Keyword Planner ad group.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      long getCpcBidMicros()
      A default ad group max cpc bid in micros in account currency for all biddable keywords under the keyword plan ad group.
      static KeywordPlanAdGroup getDefaultInstance()  
      KeywordPlanAdGroup getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      long getId()
      Output only.
      java.lang.String getKeywordPlanCampaign()
      The keyword plan campaign to which this ad group belongs.
      com.google.protobuf.ByteString getKeywordPlanCampaignBytes()
      The keyword plan campaign to which this ad group belongs.
      java.lang.String getName()
      The name of the keyword plan ad group.
      com.google.protobuf.ByteString getNameBytes()
      The name of the keyword plan ad group.
      com.google.protobuf.Parser<KeywordPlanAdGroup> getParserForType()  
      java.lang.String getResourceName()
      Immutable.
      com.google.protobuf.ByteString getResourceNameBytes()
      Immutable.
      int getSerializedSize()  
      boolean hasCpcBidMicros()
      A default ad group max cpc bid in micros in account currency for all biddable keywords under the keyword plan ad group.
      int hashCode()  
      boolean hasId()
      Output only.
      boolean hasKeywordPlanCampaign()
      The keyword plan campaign to which this ad group belongs.
      boolean hasName()
      The name of the keyword plan ad group.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static KeywordPlanAdGroup.Builder newBuilder()  
      static KeywordPlanAdGroup.Builder newBuilder​(KeywordPlanAdGroup prototype)  
      KeywordPlanAdGroup.Builder newBuilderForType()  
      protected KeywordPlanAdGroup.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static KeywordPlanAdGroup parseDelimitedFrom​(java.io.InputStream input)  
      static KeywordPlanAdGroup parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static KeywordPlanAdGroup parseFrom​(byte[] data)  
      static KeywordPlanAdGroup parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static KeywordPlanAdGroup parseFrom​(com.google.protobuf.ByteString data)  
      static KeywordPlanAdGroup parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static KeywordPlanAdGroup parseFrom​(com.google.protobuf.CodedInputStream input)  
      static KeywordPlanAdGroup parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static KeywordPlanAdGroup parseFrom​(java.io.InputStream input)  
      static KeywordPlanAdGroup parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static KeywordPlanAdGroup parseFrom​(java.nio.ByteBuffer data)  
      static KeywordPlanAdGroup parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<KeywordPlanAdGroup> parser()  
      KeywordPlanAdGroup.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getResourceName

        public java.lang.String getResourceName()
         Immutable. The resource name of the Keyword Planner ad group.
 KeywordPlanAdGroup resource names have the form:

 `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceName in interface KeywordPlanAdGroupOrBuilder
        Returns:
        The resourceName.

      • getResourceNameBytes

        public com.google.protobuf.ByteString getResourceNameBytes()
         Immutable. The resource name of the Keyword Planner ad group.
 KeywordPlanAdGroup resource names have the form:

 `customers/{customer_id}/keywordPlanAdGroups/{kp_ad_group_id}`
        string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
        Specified by:
        getResourceNameBytes in interface KeywordPlanAdGroupOrBuilder
        Returns:
        The bytes for resourceName.

      • hasKeywordPlanCampaign

        public boolean hasKeywordPlanCampaign()
         The keyword plan campaign to which this ad group belongs.
        optional string keyword_plan_campaign = 6 [(.google.api.resource_reference) = { ... }
        Specified by:
        hasKeywordPlanCampaign in interface KeywordPlanAdGroupOrBuilder
        Returns:
        Whether the keywordPlanCampaign field is set.

      • getKeywordPlanCampaign

        public java.lang.String getKeywordPlanCampaign()
         The keyword plan campaign to which this ad group belongs.
        optional string keyword_plan_campaign = 6 [(.google.api.resource_reference) = { ... }
        Specified by:
        getKeywordPlanCampaign in interface KeywordPlanAdGroupOrBuilder
        Returns:
        The keywordPlanCampaign.

      • getKeywordPlanCampaignBytes

        public com.google.protobuf.ByteString getKeywordPlanCampaignBytes()
         The keyword plan campaign to which this ad group belongs.
        optional string keyword_plan_campaign = 6 [(.google.api.resource_reference) = { ... }
        Specified by:
        getKeywordPlanCampaignBytes in interface KeywordPlanAdGroupOrBuilder
        Returns:
        The bytes for keywordPlanCampaign.

      • hasId

        public boolean hasId()
         Output only. The ID of the keyword plan ad group.
        optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasId in interface KeywordPlanAdGroupOrBuilder
        Returns:
        Whether the id field is set.

      • getId

        public long getId()
         Output only. The ID of the keyword plan ad group.
        optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getId in interface KeywordPlanAdGroupOrBuilder
        Returns:
        The id.

      • hasName

        public boolean hasName()
         The name of the keyword plan ad group.

 This field is required and should not be empty when creating keyword plan
 ad group.
        optional string name = 8;
        Specified by:
        hasName in interface KeywordPlanAdGroupOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public java.lang.String getName()
         The name of the keyword plan ad group.

 This field is required and should not be empty when creating keyword plan
 ad group.
        optional string name = 8;
        Specified by:
        getName in interface KeywordPlanAdGroupOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the keyword plan ad group.

 This field is required and should not be empty when creating keyword plan
 ad group.
        optional string name = 8;
        Specified by:
        getNameBytes in interface KeywordPlanAdGroupOrBuilder
        Returns:
        The bytes for name.

      • hasCpcBidMicros

        public boolean hasCpcBidMicros()
         A default ad group max cpc bid in micros in account currency for all
 biddable keywords under the keyword plan ad group.
 If not set, will inherit from parent campaign.
        optional int64 cpc_bid_micros = 9;
        Specified by:
        hasCpcBidMicros in interface KeywordPlanAdGroupOrBuilder
        Returns:
        Whether the cpcBidMicros field is set.

      • getCpcBidMicros

        public long getCpcBidMicros()
         A default ad group max cpc bid in micros in account currency for all
 biddable keywords under the keyword plan ad group.
 If not set, will inherit from parent campaign.
        optional int64 cpc_bid_micros = 9;
        Specified by:
        getCpcBidMicros in interface KeywordPlanAdGroupOrBuilder
        Returns:
        The cpcBidMicros.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static KeywordPlanAdGroup parseDelimitedFrom​(java.io.InputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static KeywordPlanAdGroup parseDelimitedFrom​(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static KeywordPlanAdGroup parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public KeywordPlanAdGroup.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public KeywordPlanAdGroup.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected KeywordPlanAdGroup.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<KeywordPlanAdGroup> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public KeywordPlanAdGroup getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder