Package com.google.ads.googleads.v21.services

Class GenerateKeywordHistoricalMetricsResult

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.services.GenerateKeywordHistoricalMetricsResult
All Implemented Interfaces:
GenerateKeywordHistoricalMetricsResultOrBuilder, 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 GenerateKeywordHistoricalMetricsResult extends com.google.protobuf.GeneratedMessageV3 implements GenerateKeywordHistoricalMetricsResultOrBuilder
 The result of generating keyword historical metrics.
Protobuf type google.ads.googleads.v21.services.GenerateKeywordHistoricalMetricsResult
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    GenerateKeywordHistoricalMetricsResult.Builder
    The result of generating keyword historical metrics.

    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
    CLOSE_VARIANTS_FIELD_NUMBER
     
    static final int
    KEYWORD_METRICS_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)
     
    String
    getCloseVariants(int index)
    The list of close variants from the requested keywords whose stats are combined into this GenerateKeywordHistoricalMetricsResult.
    com.google.protobuf.ByteString
    getCloseVariantsBytes(int index)
    The list of close variants from the requested keywords whose stats are combined into this GenerateKeywordHistoricalMetricsResult.
    int
    getCloseVariantsCount()
    The list of close variants from the requested keywords whose stats are combined into this GenerateKeywordHistoricalMetricsResult.
    com.google.protobuf.ProtocolStringList
    getCloseVariantsList()
    The list of close variants from the requested keywords whose stats are combined into this GenerateKeywordHistoricalMetricsResult.
    static GenerateKeywordHistoricalMetricsResult
    getDefaultInstance()
     
    GenerateKeywordHistoricalMetricsResult
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    KeywordPlanHistoricalMetrics
    getKeywordMetrics()
    The historical metrics for text and its close variants
    KeywordPlanHistoricalMetricsOrBuilder
    getKeywordMetricsOrBuilder()
    The historical metrics for text and its close variants
    com.google.protobuf.Parser<GenerateKeywordHistoricalMetricsResult>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getText()
    The text of the query associated with one or more keywords.
    com.google.protobuf.ByteString
    getTextBytes()
    The text of the query associated with one or more keywords.
    int
    hashCode()
     
    boolean
    hasKeywordMetrics()
    The historical metrics for text and its close variants
    boolean
    hasText()
    The text of the query associated with one or more keywords.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static GenerateKeywordHistoricalMetricsResult.Builder
    newBuilder()
     
    static GenerateKeywordHistoricalMetricsResult.Builder
    newBuilder(GenerateKeywordHistoricalMetricsResult prototype)
     
    GenerateKeywordHistoricalMetricsResult.Builder
    newBuilderForType()
     
    protected GenerateKeywordHistoricalMetricsResult.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static GenerateKeywordHistoricalMetricsResult
    parseDelimitedFrom(InputStream input)
     
    static GenerateKeywordHistoricalMetricsResult
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(byte[] data)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(com.google.protobuf.ByteString data)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(InputStream input)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(ByteBuffer data)
     
    static GenerateKeywordHistoricalMetricsResult
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<GenerateKeywordHistoricalMetricsResult>
    parser()
     
    GenerateKeywordHistoricalMetricsResult.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

    • TEXT_FIELD_NUMBER

      public static final int TEXT_FIELD_NUMBER
      See Also:

    • CLOSE_VARIANTS_FIELD_NUMBER

      public static final int CLOSE_VARIANTS_FIELD_NUMBER
      See Also:

    • KEYWORD_METRICS_FIELD_NUMBER

      public static final int KEYWORD_METRICS_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

    • hasText

      public boolean hasText()
       The text of the query associated with one or more keywords.
 Note that we de-dupe your keywords list, eliminating close variants
 before returning the keywords as text. For example, if your request
 originally contained the keywords "car" and "cars", the returned search
 query will only contain "cars". The list of de-duped queries will be
 included in close_variants field.
      optional string text = 1;
      Specified by:
      hasText in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      Whether the text field is set.

    • getText

      public String getText()
       The text of the query associated with one or more keywords.
 Note that we de-dupe your keywords list, eliminating close variants
 before returning the keywords as text. For example, if your request
 originally contained the keywords "car" and "cars", the returned search
 query will only contain "cars". The list of de-duped queries will be
 included in close_variants field.
      optional string text = 1;
      Specified by:
      getText in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      The text.

    • getTextBytes

      public com.google.protobuf.ByteString getTextBytes()
       The text of the query associated with one or more keywords.
 Note that we de-dupe your keywords list, eliminating close variants
 before returning the keywords as text. For example, if your request
 originally contained the keywords "car" and "cars", the returned search
 query will only contain "cars". The list of de-duped queries will be
 included in close_variants field.
      optional string text = 1;
      Specified by:
      getTextBytes in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      The bytes for text.

    • getCloseVariantsList

      public com.google.protobuf.ProtocolStringList getCloseVariantsList()
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Specified by:
      getCloseVariantsList in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      A list containing the closeVariants.

    • getCloseVariantsCount

      public int getCloseVariantsCount()
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Specified by:
      getCloseVariantsCount in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      The count of closeVariants.

    • getCloseVariants

      public String getCloseVariants(int index)
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Specified by:
      getCloseVariants in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The closeVariants at the given index.

    • getCloseVariantsBytes

      public com.google.protobuf.ByteString getCloseVariantsBytes(int index)
       The list of close variants from the requested keywords whose stats
 are combined into this GenerateKeywordHistoricalMetricsResult.
      repeated string close_variants = 3;
      Specified by:
      getCloseVariantsBytes in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the closeVariants at the given index.

    • hasKeywordMetrics

      public boolean hasKeywordMetrics()
       The historical metrics for text and its close variants
      .google.ads.googleads.v21.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
      Specified by:
      hasKeywordMetrics in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      Whether the keywordMetrics field is set.

    • getKeywordMetrics

      public KeywordPlanHistoricalMetrics getKeywordMetrics()
       The historical metrics for text and its close variants
      .google.ads.googleads.v21.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
      Specified by:
      getKeywordMetrics in interface GenerateKeywordHistoricalMetricsResultOrBuilder
      Returns:
      The keywordMetrics.

    • getKeywordMetricsOrBuilder

      public KeywordPlanHistoricalMetricsOrBuilder getKeywordMetricsOrBuilder()
       The historical metrics for text and its close variants
      .google.ads.googleads.v21.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
      Specified by:
      getKeywordMetricsOrBuilder in interface GenerateKeywordHistoricalMetricsResultOrBuilder

    • 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 GenerateKeywordHistoricalMetricsResult parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GenerateKeywordHistoricalMetricsResult.Builder newBuilder()

    • newBuilder

      public static GenerateKeywordHistoricalMetricsResult.Builder newBuilder(GenerateKeywordHistoricalMetricsResult prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GenerateKeywordHistoricalMetricsResult getDefaultInstance()

    • parser

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

    • getParserForType

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