Package com.google.ads.googleads.v18.resources

Class KeywordPlanAdGroup.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder>
com.google.ads.googleads.v18.resources.KeywordPlanAdGroup.Builder
All Implemented Interfaces:
KeywordPlanAdGroupOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
KeywordPlanAdGroup
public static final class KeywordPlanAdGroup.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder> implements KeywordPlanAdGroupOrBuilder
 A Keyword Planner ad group.
 Max number of keyword plan ad groups per plan: 200.
Protobuf type google.ads.googleads.v18.resources.KeywordPlanAdGroup

  • Method Details

    • 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.Builder<KeywordPlanAdGroup.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

      public KeywordPlanAdGroup.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder>

    • clearField

      public KeywordPlanAdGroup.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder>

    • clearOneof

      public KeywordPlanAdGroup.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder>

    • setRepeatedField

      public KeywordPlanAdGroup.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder>

    • addRepeatedField

      public KeywordPlanAdGroup.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder>

    • mergeFrom

      public KeywordPlanAdGroup.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeywordPlanAdGroup.Builder>

    • mergeFrom

      public KeywordPlanAdGroup.Builder mergeFrom(KeywordPlanAdGroup other)

    • isInitialized

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

    • mergeFrom

      public KeywordPlanAdGroup.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeywordPlanAdGroup.Builder>
      Throws:
      IOException

    • getResourceName

      public 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.

    • setResourceName

      public KeywordPlanAdGroup.Builder setResourceName(String value)
       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) = { ... }
      Parameters:
      value - The resourceName to set.
      Returns:
      This builder for chaining.

    • clearResourceName

      public KeywordPlanAdGroup.Builder clearResourceName()
       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) = { ... }
      Returns:
      This builder for chaining.

    • setResourceNameBytes

      public KeywordPlanAdGroup.Builder setResourceNameBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for resourceName to set.
      Returns:
      This builder for chaining.

    • 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 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.

    • setKeywordPlanCampaign

      public KeywordPlanAdGroup.Builder setKeywordPlanCampaign(String value)
       The keyword plan campaign to which this ad group belongs.
      optional string keyword_plan_campaign = 6 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The keywordPlanCampaign to set.
      Returns:
      This builder for chaining.

    • clearKeywordPlanCampaign

      public KeywordPlanAdGroup.Builder clearKeywordPlanCampaign()
       The keyword plan campaign to which this ad group belongs.
      optional string keyword_plan_campaign = 6 [(.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setKeywordPlanCampaignBytes

      public KeywordPlanAdGroup.Builder setKeywordPlanCampaignBytes(com.google.protobuf.ByteString value)
       The keyword plan campaign to which this ad group belongs.
      optional string keyword_plan_campaign = 6 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for keywordPlanCampaign to set.
      Returns:
      This builder for chaining.

    • 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.

    • setId

      public KeywordPlanAdGroup.Builder setId(long value)
       Output only. The ID of the keyword plan ad group.
      optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public KeywordPlanAdGroup.Builder clearId()
       Output only. The ID of the keyword plan ad group.
      optional int64 id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • 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 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.

    • setName

      public KeywordPlanAdGroup.Builder setName(String value)
       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;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public KeywordPlanAdGroup.Builder clearName()
       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;
      Returns:
      This builder for chaining.

    • setNameBytes

      public KeywordPlanAdGroup.Builder setNameBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • 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.

    • setCpcBidMicros

      public KeywordPlanAdGroup.Builder setCpcBidMicros(long value)
       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;
      Parameters:
      value - The cpcBidMicros to set.
      Returns:
      This builder for chaining.

    • clearCpcBidMicros

      public KeywordPlanAdGroup.Builder clearCpcBidMicros()
       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;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final KeywordPlanAdGroup.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder>

    • mergeUnknownFields

      public final KeywordPlanAdGroup.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeywordPlanAdGroup.Builder>