Package com.google.ads.googleads.v10.services

Class KeywordPlanKeywordHistoricalMetrics

  • All Implemented Interfaces:
    KeywordPlanKeywordHistoricalMetricsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class KeywordPlanKeywordHistoricalMetrics
extends com.google.protobuf.GeneratedMessageV3
implements KeywordPlanKeywordHistoricalMetricsOrBuilder
     A keyword historical metrics.
    Protobuf type google.ads.googleads.v10.services.KeywordPlanKeywordHistoricalMetrics
    See Also:
    Serialized Form

    • Field Detail

      • SEARCH_QUERY_FIELD_NUMBER

        public static final int SEARCH_QUERY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CLOSE_VARIANTS_FIELD_NUMBER

        public static final int CLOSE_VARIANTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KEYWORD_METRICS_FIELD_NUMBER

        public static final int KEYWORD_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • hasSearchQuery

        public boolean hasSearchQuery()
         The text of the query associated with one or more ad_group_keywords in the
 plan.
 Note that we de-dupe your keywords list, eliminating close variants before
 returning the plan's keywords as text. For example, if your plan originally
 contained the keywords 'car' and 'cars', the returned search query will
 only contain 'cars'.
 Starting V5, the list of de-duped queries will be included in
 close_variants field.
        optional string search_query = 4;
        Specified by:
        hasSearchQuery in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        Whether the searchQuery field is set.

      • getSearchQuery

        public java.lang.String getSearchQuery()
         The text of the query associated with one or more ad_group_keywords in the
 plan.
 Note that we de-dupe your keywords list, eliminating close variants before
 returning the plan's keywords as text. For example, if your plan originally
 contained the keywords 'car' and 'cars', the returned search query will
 only contain 'cars'.
 Starting V5, the list of de-duped queries will be included in
 close_variants field.
        optional string search_query = 4;
        Specified by:
        getSearchQuery in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        The searchQuery.

      • getSearchQueryBytes

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

      • getCloseVariantsList

        public com.google.protobuf.ProtocolStringList getCloseVariantsList()
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Specified by:
        getCloseVariantsList in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        A list containing the closeVariants.

      • getCloseVariantsCount

        public int getCloseVariantsCount()
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Specified by:
        getCloseVariantsCount in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        The count of closeVariants.

      • getCloseVariants

        public java.lang.String getCloseVariants​(int index)
         The list of close variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Specified by:
        getCloseVariants in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        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 variant queries for search_query whose search results
 are combined into the search_query.
        repeated string close_variants = 3;
        Specified by:
        getCloseVariantsBytes in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        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 the query associated with one or more
 ad_group_keywords in the plan.
        .google.ads.googleads.v10.common.KeywordPlanHistoricalMetrics keyword_metrics = 2;
        Specified by:
        hasKeywordMetrics in interface KeywordPlanKeywordHistoricalMetricsOrBuilder
        Returns:
        Whether the keywordMetrics field is set.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<KeywordPlanKeywordHistoricalMetrics> 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 KeywordPlanKeywordHistoricalMetrics getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder