Package com.google.ads.googleads.v21.resources

Class KeywordPlanAdGroupKeyword

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v21.resources.KeywordPlanAdGroupKeyword
All Implemented Interfaces:
KeywordPlanAdGroupKeywordOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class KeywordPlanAdGroupKeyword extends com.google.protobuf.GeneratedMessageV3 implements KeywordPlanAdGroupKeywordOrBuilder
 A Keyword Plan ad group keyword.
 Max number of keyword plan keywords per plan: 10000.
Protobuf type google.ads.googleads.v21.resources.KeywordPlanAdGroupKeyword
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    KeywordPlanAdGroupKeyword.Builder
    A Keyword Plan ad group keyword.

    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.GeneratedMessage.ExtendableMessage

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter, com.google.protobuf.GeneratedMessage.ExtendableMessage.FieldEntry

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CPC_BID_MICROS_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    KEYWORD_PLAN_AD_GROUP_FIELD_NUMBER
     
    static final int
    MATCH_TYPE_FIELD_NUMBER
     
    static final int
    NEGATIVE_FIELD_NUMBER
     
    static final int
    RESOURCE_NAME_FIELD_NUMBER
     
    static final int
    TEXT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    long
    getCpcBidMicros()
    A keyword level max cpc bid in micros (for example, $1 = 1mm).
    static KeywordPlanAdGroupKeyword
    getDefaultInstance()
     
    KeywordPlanAdGroupKeyword
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getId()
    Output only.
    String
    getKeywordPlanAdGroup()
    The Keyword Plan ad group to which this keyword belongs.
    com.google.protobuf.ByteString
    getKeywordPlanAdGroupBytes()
    The Keyword Plan ad group to which this keyword belongs.
    KeywordMatchTypeEnum.KeywordMatchType
    getMatchType()
    The keyword match type.
    int
    getMatchTypeValue()
    The keyword match type.
    boolean
    getNegative()
    Immutable.
    com.google.protobuf.Parser<KeywordPlanAdGroupKeyword>
    getParserForType()
     
    String
    getResourceName()
    Immutable.
    com.google.protobuf.ByteString
    getResourceNameBytes()
    Immutable.
    int
    getSerializedSize()
     
    String
    getText()
    The keyword text.
    com.google.protobuf.ByteString
    getTextBytes()
    The keyword text.
    boolean
    hasCpcBidMicros()
    A keyword level max cpc bid in micros (for example, $1 = 1mm).
    int
    hashCode()
     
    boolean
    hasId()
    Output only.
    boolean
    hasKeywordPlanAdGroup()
    The Keyword Plan ad group to which this keyword belongs.
    boolean
    hasNegative()
    Immutable.
    boolean
    hasText()
    The keyword text.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static KeywordPlanAdGroupKeyword.Builder
    newBuilder()
     
    static KeywordPlanAdGroupKeyword.Builder
    newBuilder(KeywordPlanAdGroupKeyword prototype)
     
    KeywordPlanAdGroupKeyword.Builder
    newBuilderForType()
     
    protected KeywordPlanAdGroupKeyword.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static KeywordPlanAdGroupKeyword
    parseDelimitedFrom(InputStream input)
     
    static KeywordPlanAdGroupKeyword
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(byte[] data)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(com.google.protobuf.ByteString data)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(InputStream input)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(ByteBuffer data)
     
    static KeywordPlanAdGroupKeyword
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<KeywordPlanAdGroupKeyword>
    parser()
     
    KeywordPlanAdGroupKeyword.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    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

  • Field Details

    • RESOURCE_NAME_FIELD_NUMBER

      public static final int RESOURCE_NAME_FIELD_NUMBER
      See Also:

    • KEYWORD_PLAN_AD_GROUP_FIELD_NUMBER

      public static final int KEYWORD_PLAN_AD_GROUP_FIELD_NUMBER
      See Also:

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • TEXT_FIELD_NUMBER

      public static final int TEXT_FIELD_NUMBER
      See Also:

    • MATCH_TYPE_FIELD_NUMBER

      public static final int MATCH_TYPE_FIELD_NUMBER
      See Also:

    • CPC_BID_MICROS_FIELD_NUMBER

      public static final int CPC_BID_MICROS_FIELD_NUMBER
      See Also:

    • NEGATIVE_FIELD_NUMBER

      public static final int NEGATIVE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

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

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

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

    • getMatchTypeValue

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

    • getMatchType

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

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

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

    • isInitialized

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

    • writeTo

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

    • getSerializedSize

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

    • equals

      public boolean equals(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 KeywordPlanAdGroupKeyword parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static KeywordPlanAdGroupKeyword parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static KeywordPlanAdGroupKeyword parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KeywordPlanAdGroupKeyword parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KeywordPlanAdGroupKeyword parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static KeywordPlanAdGroupKeyword parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KeywordPlanAdGroupKeyword parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static KeywordPlanAdGroupKeyword parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static KeywordPlanAdGroupKeyword.Builder newBuilder()

    • newBuilder

      public static KeywordPlanAdGroupKeyword.Builder newBuilder(KeywordPlanAdGroupKeyword prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static KeywordPlanAdGroupKeyword getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<KeywordPlanAdGroupKeyword> parser()

    • getParserForType

      public com.google.protobuf.Parser<KeywordPlanAdGroupKeyword> 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.GeneratedMessage

    • getDefaultInstanceForType

      public KeywordPlanAdGroupKeyword getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder