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

Class KeywordPlanAdGroupKeyword.Builder

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

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public KeywordPlanAdGroupKeyword.Builder mergeFrom(KeywordPlanAdGroupKeyword other)

    • isInitialized

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

    • mergeFrom

      public KeywordPlanAdGroupKeyword.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<KeywordPlanAdGroupKeyword.Builder>
      Throws:
      IOException

    • getResourceName

      public String getResourceName()
       Immutable. The resource name of the Keyword Plan ad group keyword.
 KeywordPlanAdGroupKeyword resource names have the form:

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

    • getResourceNameBytes

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

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

    • setResourceName

      public KeywordPlanAdGroupKeyword.Builder setResourceName(String value)
       Immutable. The resource name of the Keyword Plan ad group keyword.
 KeywordPlanAdGroupKeyword resource names have the form:

 `customers/{customer_id}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_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 KeywordPlanAdGroupKeyword.Builder clearResourceName()
       Immutable. The resource name of the Keyword Plan ad group keyword.
 KeywordPlanAdGroupKeyword resource names have the form:

 `customers/{customer_id}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_id}`
      string resource_name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setResourceNameBytes

      public KeywordPlanAdGroupKeyword.Builder setResourceNameBytes(com.google.protobuf.ByteString value)
       Immutable. The resource name of the Keyword Plan ad group keyword.
 KeywordPlanAdGroupKeyword resource names have the form:

 `customers/{customer_id}/keywordPlanAdGroupKeywords/{kp_ad_group_keyword_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.

    • hasKeywordPlanAdGroup

      public boolean hasKeywordPlanAdGroup()
       The Keyword Plan ad group to which this keyword belongs.
      optional string keyword_plan_ad_group = 8 [(.google.api.resource_reference) = { ... }
      Specified by:
      hasKeywordPlanAdGroup in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      Whether the keywordPlanAdGroup field is set.

    • getKeywordPlanAdGroup

      public String getKeywordPlanAdGroup()
       The Keyword Plan ad group to which this keyword belongs.
      optional string keyword_plan_ad_group = 8 [(.google.api.resource_reference) = { ... }
      Specified by:
      getKeywordPlanAdGroup in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      The keywordPlanAdGroup.

    • getKeywordPlanAdGroupBytes

      public com.google.protobuf.ByteString getKeywordPlanAdGroupBytes()
       The Keyword Plan ad group to which this keyword belongs.
      optional string keyword_plan_ad_group = 8 [(.google.api.resource_reference) = { ... }
      Specified by:
      getKeywordPlanAdGroupBytes in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      The bytes for keywordPlanAdGroup.

    • setKeywordPlanAdGroup

      public KeywordPlanAdGroupKeyword.Builder setKeywordPlanAdGroup(String value)
       The Keyword Plan ad group to which this keyword belongs.
      optional string keyword_plan_ad_group = 8 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The keywordPlanAdGroup to set.
      Returns:
      This builder for chaining.

    • clearKeywordPlanAdGroup

      public KeywordPlanAdGroupKeyword.Builder clearKeywordPlanAdGroup()
       The Keyword Plan ad group to which this keyword belongs.
      optional string keyword_plan_ad_group = 8 [(.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setKeywordPlanAdGroupBytes

      public KeywordPlanAdGroupKeyword.Builder setKeywordPlanAdGroupBytes(com.google.protobuf.ByteString value)
       The Keyword Plan ad group to which this keyword belongs.
      optional string keyword_plan_ad_group = 8 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for keywordPlanAdGroup to set.
      Returns:
      This builder for chaining.

    • hasId

      public boolean hasId()
       Output only. The ID of the Keyword Plan keyword.
      optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasId in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public long getId()
       Output only. The ID of the Keyword Plan keyword.
      optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getId in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      The id.

    • setId

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

    • clearId

      public KeywordPlanAdGroupKeyword.Builder clearId()
       Output only. The ID of the Keyword Plan keyword.
      optional int64 id = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      This builder for chaining.

    • hasText

      public boolean hasText()
       The keyword text.
      optional string text = 10;
      Specified by:
      hasText in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      Whether the text field is set.

    • getText

      public String getText()
       The keyword text.
      optional string text = 10;
      Specified by:
      getText in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       The keyword text.
      optional string text = 10;
      Specified by:
      getTextBytes in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      The bytes for text.

    • setText

      public KeywordPlanAdGroupKeyword.Builder setText(String value)
       The keyword text.
      optional string text = 10;
      Parameters:
      value - The text to set.
      Returns:
      This builder for chaining.

    • clearText

      public KeywordPlanAdGroupKeyword.Builder clearText()
       The keyword text.
      optional string text = 10;
      Returns:
      This builder for chaining.

    • setTextBytes

      public KeywordPlanAdGroupKeyword.Builder setTextBytes(com.google.protobuf.ByteString value)
       The keyword text.
      optional string text = 10;
      Parameters:
      value - The bytes for text to set.
      Returns:
      This builder for chaining.

    • getMatchTypeValue

      public int getMatchTypeValue()
       The keyword match type.
      .google.ads.googleads.v18.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5;
      Specified by:
      getMatchTypeValue in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      The enum numeric value on the wire for matchType.

    • setMatchTypeValue

      public KeywordPlanAdGroupKeyword.Builder setMatchTypeValue(int value)
       The keyword match type.
      .google.ads.googleads.v18.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5;
      Parameters:
      value - The enum numeric value on the wire for matchType to set.
      Returns:
      This builder for chaining.

    • getMatchType

      public KeywordMatchTypeEnum.KeywordMatchType getMatchType()
       The keyword match type.
      .google.ads.googleads.v18.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5;
      Specified by:
      getMatchType in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      The matchType.

    • setMatchType

      public KeywordPlanAdGroupKeyword.Builder setMatchType(KeywordMatchTypeEnum.KeywordMatchType value)
       The keyword match type.
      .google.ads.googleads.v18.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5;
      Parameters:
      value - The matchType to set.
      Returns:
      This builder for chaining.

    • clearMatchType

      public KeywordPlanAdGroupKeyword.Builder clearMatchType()
       The keyword match type.
      .google.ads.googleads.v18.enums.KeywordMatchTypeEnum.KeywordMatchType match_type = 5;
      Returns:
      This builder for chaining.

    • hasCpcBidMicros

      public boolean hasCpcBidMicros()
       A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency
 is the same as the account currency code. This will override any CPC bid
 set at the keyword plan ad group level. Not applicable for negative
 keywords. (negative = true) This field is Optional.
      optional int64 cpc_bid_micros = 11;
      Specified by:
      hasCpcBidMicros in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      Whether the cpcBidMicros field is set.

    • getCpcBidMicros

      public long getCpcBidMicros()
       A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency
 is the same as the account currency code. This will override any CPC bid
 set at the keyword plan ad group level. Not applicable for negative
 keywords. (negative = true) This field is Optional.
      optional int64 cpc_bid_micros = 11;
      Specified by:
      getCpcBidMicros in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      The cpcBidMicros.

    • setCpcBidMicros

      public KeywordPlanAdGroupKeyword.Builder setCpcBidMicros(long value)
       A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency
 is the same as the account currency code. This will override any CPC bid
 set at the keyword plan ad group level. Not applicable for negative
 keywords. (negative = true) This field is Optional.
      optional int64 cpc_bid_micros = 11;
      Parameters:
      value - The cpcBidMicros to set.
      Returns:
      This builder for chaining.

    • clearCpcBidMicros

      public KeywordPlanAdGroupKeyword.Builder clearCpcBidMicros()
       A keyword level max cpc bid in micros (for example, $1 = 1mm). The currency
 is the same as the account currency code. This will override any CPC bid
 set at the keyword plan ad group level. Not applicable for negative
 keywords. (negative = true) This field is Optional.
      optional int64 cpc_bid_micros = 11;
      Returns:
      This builder for chaining.

    • hasNegative

      public boolean hasNegative()
       Immutable. If true, the keyword is negative.
      optional bool negative = 12 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      hasNegative in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      Whether the negative field is set.

    • getNegative

      public boolean getNegative()
       Immutable. If true, the keyword is negative.
      optional bool negative = 12 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getNegative in interface KeywordPlanAdGroupKeywordOrBuilder
      Returns:
      The negative.

    • setNegative

      public KeywordPlanAdGroupKeyword.Builder setNegative(boolean value)
       Immutable. If true, the keyword is negative.
      optional bool negative = 12 [(.google.api.field_behavior) = IMMUTABLE];
      Parameters:
      value - The negative to set.
      Returns:
      This builder for chaining.

    • clearNegative

      public KeywordPlanAdGroupKeyword.Builder clearNegative()
       Immutable. If true, the keyword is negative.
      optional bool negative = 12 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final KeywordPlanAdGroupKeyword.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<KeywordPlanAdGroupKeyword.Builder>

    • mergeUnknownFields

      public final KeywordPlanAdGroupKeyword.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<KeywordPlanAdGroupKeyword.Builder>