Package com.google.ads.googleads.v18.services

Class GenerateKeywordHistoricalMetricsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.GenerateKeywordHistoricalMetricsRequest
All Implemented Interfaces:
GenerateKeywordHistoricalMetricsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class GenerateKeywordHistoricalMetricsRequest extends com.google.protobuf.GeneratedMessageV3 implements GenerateKeywordHistoricalMetricsRequestOrBuilder
 Request message for
 [KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics][google.ads.googleads.v18.services.KeywordPlanIdeaService.GenerateKeywordHistoricalMetrics].
Protobuf type google.ads.googleads.v18.services.GenerateKeywordHistoricalMetricsRequest
See Also:

  • Field Details

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:

    • KEYWORDS_FIELD_NUMBER

      public static final int KEYWORDS_FIELD_NUMBER
      See Also:

    • LANGUAGE_FIELD_NUMBER

      public static final int LANGUAGE_FIELD_NUMBER
      See Also:

    • INCLUDE_ADULT_KEYWORDS_FIELD_NUMBER

      public static final int INCLUDE_ADULT_KEYWORDS_FIELD_NUMBER
      See Also:

    • GEO_TARGET_CONSTANTS_FIELD_NUMBER

      public static final int GEO_TARGET_CONSTANTS_FIELD_NUMBER
      See Also:

    • KEYWORD_PLAN_NETWORK_FIELD_NUMBER

      public static final int KEYWORD_PLAN_NETWORK_FIELD_NUMBER
      See Also:

    • AGGREGATE_METRICS_FIELD_NUMBER

      public static final int AGGREGATE_METRICS_FIELD_NUMBER
      See Also:

    • HISTORICAL_METRICS_OPTIONS_FIELD_NUMBER

      public static final int HISTORICAL_METRICS_OPTIONS_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()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getCustomerId

      public String getCustomerId()
       The ID of the customer with the recommendation.
      string customer_id = 1;
      Specified by:
      getCustomerId in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
      Returns:
      The customerId.

    • getCustomerIdBytes

      public com.google.protobuf.ByteString getCustomerIdBytes()
       The ID of the customer with the recommendation.
      string customer_id = 1;
      Specified by:
      getCustomerIdBytes in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
      Returns:
      The bytes for customerId.

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

    • getIncludeAdultKeywords

      public boolean getIncludeAdultKeywords()
       If true, adult keywords will be included in response.
 The default value is false.
      bool include_adult_keywords = 5;
      Specified by:
      getIncludeAdultKeywords in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
      Returns:
      The includeAdultKeywords.

    • 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 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.v18.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
      Specified by:
      getKeywordPlanNetworkValue in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
      Returns:
      The enum numeric value on the wire for keywordPlanNetwork.

    • getKeywordPlanNetwork

      public KeywordPlanNetworkEnum.KeywordPlanNetwork getKeywordPlanNetwork()
       Targeting network.
 If not set, Google Search And Partners Network will be used.
      .google.ads.googleads.v18.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
      Specified by:
      getKeywordPlanNetwork in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
      Returns:
      The keywordPlanNetwork.

    • hasAggregateMetrics

      public boolean hasAggregateMetrics()
       The aggregate fields to include in response.
      .google.ads.googleads.v18.common.KeywordPlanAggregateMetrics aggregate_metrics = 8;
      Specified by:
      hasAggregateMetrics in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
      Returns:
      Whether the aggregateMetrics field is set.

    • getAggregateMetrics

      public KeywordPlanAggregateMetrics getAggregateMetrics()
       The aggregate fields to include in response.
      .google.ads.googleads.v18.common.KeywordPlanAggregateMetrics aggregate_metrics = 8;
      Specified by:
      getAggregateMetrics in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
      Returns:
      The aggregateMetrics.

    • getAggregateMetricsOrBuilder

      public KeywordPlanAggregateMetricsOrBuilder getAggregateMetricsOrBuilder()
       The aggregate fields to include in response.
      .google.ads.googleads.v18.common.KeywordPlanAggregateMetrics aggregate_metrics = 8;
      Specified by:
      getAggregateMetricsOrBuilder in interface GenerateKeywordHistoricalMetricsRequestOrBuilder

    • hasHistoricalMetricsOptions

      public boolean hasHistoricalMetricsOptions()
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 3;
      Specified by:
      hasHistoricalMetricsOptions in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
      Returns:
      Whether the historicalMetricsOptions field is set.

    • getHistoricalMetricsOptions

      public HistoricalMetricsOptions getHistoricalMetricsOptions()
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 3;
      Specified by:
      getHistoricalMetricsOptions in interface GenerateKeywordHistoricalMetricsRequestOrBuilder
      Returns:
      The historicalMetricsOptions.

    • getHistoricalMetricsOptionsOrBuilder

      public HistoricalMetricsOptionsOrBuilder getHistoricalMetricsOptionsOrBuilder()
       The options for historical metrics data.
      .google.ads.googleads.v18.common.HistoricalMetricsOptions historical_metrics_options = 3;
      Specified by:
      getHistoricalMetricsOptionsOrBuilder in interface GenerateKeywordHistoricalMetricsRequestOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static GenerateKeywordHistoricalMetricsRequest parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GenerateKeywordHistoricalMetricsRequest.Builder newBuilder()

    • newBuilder

      public static GenerateKeywordHistoricalMetricsRequest.Builder newBuilder(GenerateKeywordHistoricalMetricsRequest prototype)

    • toBuilder

      public GenerateKeywordHistoricalMetricsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder 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

    • getDefaultInstance

      public static GenerateKeywordHistoricalMetricsRequest getDefaultInstance()

    • parser

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

    • 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