Package com.google.ads.googleads.v15.services

Class GenerateKeywordHistoricalMetricsRequest

  • All Implemented Interfaces:
    GenerateKeywordHistoricalMetricsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class GenerateKeywordHistoricalMetricsRequest
extends com.google.protobuf.GeneratedMessageV3
implements GenerateKeywordHistoricalMetricsRequestOrBuilder
     Request message for
 [KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics][google.ads.googleads.v15.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics].
    Protobuf type google.ads.googleads.v15.services.GenerateKeywordHistoricalMetricsRequest
    See Also:
    Serialized Form

    • Field Detail

      • CUSTOMER_ID_FIELD_NUMBER

        public static final int CUSTOMER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • INCLUDE_ADULT_KEYWORDS_FIELD_NUMBER

        public static final int INCLUDE_ADULT_KEYWORDS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • GEO_TARGET_CONSTANTS_FIELD_NUMBER

        public static final int GEO_TARGET_CONSTANTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • KEYWORD_PLAN_NETWORK_FIELD_NUMBER

        public static final int KEYWORD_PLAN_NETWORK_FIELD_NUMBER
        See Also:
        Constant Field Values

      • AGGREGATE_METRICS_FIELD_NUMBER

        public static final int AGGREGATE_METRICS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HISTORICAL_METRICS_OPTIONS_FIELD_NUMBER

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

      • 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

      • getKeywordsList

        public com.google.protobuf.ProtocolStringList getKeywordsList()
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Specified by:
        getKeywordsList in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        A list containing the keywords.

      • getKeywordsCount

        public int getKeywordsCount()
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Specified by:
        getKeywordsCount in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The count of keywords.

      • getKeywords

        public java.lang.String getKeywords​(int index)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Specified by:
        getKeywords in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The keywords at the given index.

      • getKeywordsBytes

        public com.google.protobuf.ByteString getKeywordsBytes​(int index)
         A list of keywords to get historical metrics.
 Not all inputs will be returned as a result of near-exact deduplication.
 For example, if stats for "car" and "cars" are requested, only "car" will
 be returned.
 A maximum of 10,000 keywords can be used.
        repeated string keywords = 2;
        Specified by:
        getKeywordsBytes in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the keywords at the given index.

      • hasLanguage

        public boolean hasLanguage()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 4;
        Specified by:
        hasLanguage in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        Whether the language field is set.

      • getLanguage

        public java.lang.String getLanguage()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 4;
        Specified by:
        getLanguage in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The language.

      • getLanguageBytes

        public com.google.protobuf.ByteString getLanguageBytes()
         The resource name of the language to target.
 Each keyword belongs to some set of languages; a keyword is included if
 language is one of its languages.
 If not set, all keywords will be included.
        optional string language = 4;
        Specified by:
        getLanguageBytes in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The bytes for language.

      • getGeoTargetConstantsList

        public com.google.protobuf.ProtocolStringList getGeoTargetConstantsList()
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Specified by:
        getGeoTargetConstantsList in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        A list containing the geoTargetConstants.

      • getGeoTargetConstantsCount

        public int getGeoTargetConstantsCount()
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Specified by:
        getGeoTargetConstantsCount in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The count of geoTargetConstants.

      • getGeoTargetConstants

        public java.lang.String getGeoTargetConstants​(int index)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Specified by:
        getGeoTargetConstants in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The geoTargetConstants at the given index.

      • getGeoTargetConstantsBytes

        public com.google.protobuf.ByteString getGeoTargetConstantsBytes​(int index)
         The resource names of the location to target. Maximum is 10.
 An empty list MAY be used to specify all targeting geos.
        repeated string geo_target_constants = 6;
        Specified by:
        getGeoTargetConstantsBytes in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the geoTargetConstants at the given index.

      • getKeywordPlanNetworkValue

        public int getKeywordPlanNetworkValue()
         Targeting network.
 If not set, Google Search And Partners Network will be used.
        .google.ads.googleads.v15.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
        Specified by:
        getKeywordPlanNetworkValue in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        The enum numeric value on the wire for keywordPlanNetwork.

      • hasAggregateMetrics

        public boolean hasAggregateMetrics()
         The aggregate fields to include in response.
        .google.ads.googleads.v15.common.KeywordPlanAggregateMetrics aggregate_metrics = 8;
        Specified by:
        hasAggregateMetrics in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
        Returns:
        Whether the aggregateMetrics 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 GenerateKeywordHistoricalMetricsRequest parseFrom​(java.nio.ByteBuffer data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • newBuilderForType

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

      • getParserForType

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