com.google.ads.googleads.v17.services.GenerateKeywordHistoricalMetricsRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/ads/googleads/v17/services/keyword_plan_idea_service.proto

// Protobuf Java Version: 3.25.3
package com.google.ads.googleads.v17.services;

public interface GenerateKeywordHistoricalMetricsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.GenerateKeywordHistoricalMetricsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * The ID of the customer with the recommendation.
   * 
   *
   * string customer_id = 1;
   * @return The customerId.
   */
  java.lang.String getCustomerId();
  /**
   *    * The ID of the customer with the recommendation.
   * 
   *
   * string customer_id = 1;
   * @return The bytes for customerId.
   */
  com.google.protobuf.ByteString
      getCustomerIdBytes();

  /**
   *    * 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;
   * @return A list containing the keywords.
   */
  java.util.List
      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;
   * @return The count of keywords.
   */
  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;
   * @param index The index of the element to return.
   * @return The keywords at the given index.
   */
  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;
   * @param index The index of the value to return.
   * @return The bytes of the keywords at the given index.
   */
  com.google.protobuf.ByteString
      getKeywordsBytes(int index);

  /**
   *    * 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;
   * @return Whether the language field is set.
   */
  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;
   * @return The language.
   */
  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;
   * @return The bytes for language.
   */
  com.google.protobuf.ByteString
      getLanguageBytes();

  /**
   *    * If true, adult keywords will be included in response.
   * The default value is false.
   * 
   *
   * bool include_adult_keywords = 5;
   * @return The includeAdultKeywords.
   */
  boolean getIncludeAdultKeywords();

  /**
   *    * 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;
   * @return A list containing the geoTargetConstants.
   */
  java.util.List
      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;
   * @return The count of geoTargetConstants.
   */
  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;
   * @param index The index of the element to return.
   * @return The geoTargetConstants at the given index.
   */
  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;
   * @param index The index of the value to return.
   * @return The bytes of the geoTargetConstants at the given index.
   */
  com.google.protobuf.ByteString
      getGeoTargetConstantsBytes(int index);

  /**
   *    * Targeting network.
   * If not set, Google Search And Partners Network will be used.
   * 
   *
   * .google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
   * @return The enum numeric value on the wire for keywordPlanNetwork.
   */
  int getKeywordPlanNetworkValue();
  /**
   *    * Targeting network.
   * If not set, Google Search And Partners Network will be used.
   * 
   *
   * .google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 7;
   * @return The keywordPlanNetwork.
   */
  com.google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork getKeywordPlanNetwork();

  /**
   *    * The aggregate fields to include in response.
   * 
   *
   * .google.ads.googleads.v17.common.KeywordPlanAggregateMetrics aggregate_metrics = 8;
   * @return Whether the aggregateMetrics field is set.
   */
  boolean hasAggregateMetrics();
  /**
   *    * The aggregate fields to include in response.
   * 
   *
   * .google.ads.googleads.v17.common.KeywordPlanAggregateMetrics aggregate_metrics = 8;
   * @return The aggregateMetrics.
   */
  com.google.ads.googleads.v17.common.KeywordPlanAggregateMetrics getAggregateMetrics();
  /**
   *    * The aggregate fields to include in response.
   * 
   *
   * .google.ads.googleads.v17.common.KeywordPlanAggregateMetrics aggregate_metrics = 8;
   */
  com.google.ads.googleads.v17.common.KeywordPlanAggregateMetricsOrBuilder getAggregateMetricsOrBuilder();

  /**
   *    * The options for historical metrics data.
   * 
   *
   * .google.ads.googleads.v17.common.HistoricalMetricsOptions historical_metrics_options = 3;
   * @return Whether the historicalMetricsOptions field is set.
   */
  boolean hasHistoricalMetricsOptions();
  /**
   *    * The options for historical metrics data.
   * 
   *
   * .google.ads.googleads.v17.common.HistoricalMetricsOptions historical_metrics_options = 3;
   * @return The historicalMetricsOptions.
   */
  com.google.ads.googleads.v17.common.HistoricalMetricsOptions getHistoricalMetricsOptions();
  /**
   *    * The options for historical metrics data.
   * 
   *
   * .google.ads.googleads.v17.common.HistoricalMetricsOptions historical_metrics_options = 3;
   */
  com.google.ads.googleads.v17.common.HistoricalMetricsOptionsOrBuilder getHistoricalMetricsOptionsOrBuilder();
}