com.google.ads.googleads.v17.services.GenerateKeywordIdeasRequestOrBuilder 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 GenerateKeywordIdeasRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.GenerateKeywordIdeasRequest)
    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();

  /**
   *    * 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 = 14;
   * @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 = 14;
   * @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 = 14;
   * @return The bytes for language.
   */
  com.google.protobuf.ByteString
      getLanguageBytes();

  /**
   *    * 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 = 15;
   * @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 = 15;
   * @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 = 15;
   * @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 = 15;
   * @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);

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

  /**
   *    * Token of the page to retrieve. If not specified, the first
   * page of results will be returned. To request next page of results use the
   * value obtained from `next_page_token` in the previous response.
   * The request fields must match across pages.
   * 
   *
   * string page_token = 12;
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *    * Token of the page to retrieve. If not specified, the first
   * page of results will be returned. To request next page of results use the
   * value obtained from `next_page_token` in the previous response.
   * The request fields must match across pages.
   * 
   *
   * string page_token = 12;
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString
      getPageTokenBytes();

  /**
   *    * Number of results to retrieve in a single page.
   * A maximum of 10,000 results may be returned, if the page_size
   * exceeds this, it is ignored.
   * If unspecified, at most 10,000 results will be returned.
   * The server may decide to further limit the number of returned resources.
   * If the response contains fewer than 10,000 results it may not be assumed
   * as last page of results.
   * 
   *
   * int32 page_size = 13;
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *    * Targeting network.
   * If not set, Google Search And Partners Network will be used.
   * 
   *
   * .google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork keyword_plan_network = 9;
   * @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 = 9;
   * @return The keywordPlanNetwork.
   */
  com.google.ads.googleads.v17.enums.KeywordPlanNetworkEnum.KeywordPlanNetwork getKeywordPlanNetwork();

  /**
   *    * The keyword annotations to include in response.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
   * @return A list containing the keywordAnnotation.
   */
  java.util.List getKeywordAnnotationList();
  /**
   *    * The keyword annotations to include in response.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
   * @return The count of keywordAnnotation.
   */
  int getKeywordAnnotationCount();
  /**
   *    * The keyword annotations to include in response.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
   * @param index The index of the element to return.
   * @return The keywordAnnotation at the given index.
   */
  com.google.ads.googleads.v17.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation getKeywordAnnotation(int index);
  /**
   *    * The keyword annotations to include in response.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
   * @return A list containing the enum numeric values on the wire for keywordAnnotation.
   */
  java.util.List
  getKeywordAnnotationValueList();
  /**
   *    * The keyword annotations to include in response.
   * 
   *
   * repeated .google.ads.googleads.v17.enums.KeywordPlanKeywordAnnotationEnum.KeywordPlanKeywordAnnotation keyword_annotation = 17;
   * @param index The index of the value to return.
   * @return The enum numeric value on the wire of keywordAnnotation at the given index.
   */
  int getKeywordAnnotationValue(int index);

  /**
   *    * The aggregate fields to include in response.
   * 
   *
   * .google.ads.googleads.v17.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;
   * @return Whether the aggregateMetrics field is set.
   */
  boolean hasAggregateMetrics();
  /**
   *    * The aggregate fields to include in response.
   * 
   *
   * .google.ads.googleads.v17.common.KeywordPlanAggregateMetrics aggregate_metrics = 16;
   * @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 = 16;
   */
  com.google.ads.googleads.v17.common.KeywordPlanAggregateMetricsOrBuilder getAggregateMetricsOrBuilder();

  /**
   *    * The options for historical metrics data.
   * 
   *
   * .google.ads.googleads.v17.common.HistoricalMetricsOptions historical_metrics_options = 18;
   * @return Whether the historicalMetricsOptions field is set.
   */
  boolean hasHistoricalMetricsOptions();
  /**
   *    * The options for historical metrics data.
   * 
   *
   * .google.ads.googleads.v17.common.HistoricalMetricsOptions historical_metrics_options = 18;
   * @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 = 18;
   */
  com.google.ads.googleads.v17.common.HistoricalMetricsOptionsOrBuilder getHistoricalMetricsOptionsOrBuilder();

  /**
   *    * A Keyword and a specific Url to generate ideas from
   * for example, cars, www.example.com/cars.
   * 
   *
   * .google.ads.googleads.v17.services.KeywordAndUrlSeed keyword_and_url_seed = 2;
   * @return Whether the keywordAndUrlSeed field is set.
   */
  boolean hasKeywordAndUrlSeed();
  /**
   *    * A Keyword and a specific Url to generate ideas from
   * for example, cars, www.example.com/cars.
   * 
   *
   * .google.ads.googleads.v17.services.KeywordAndUrlSeed keyword_and_url_seed = 2;
   * @return The keywordAndUrlSeed.
   */
  com.google.ads.googleads.v17.services.KeywordAndUrlSeed getKeywordAndUrlSeed();
  /**
   *    * A Keyword and a specific Url to generate ideas from
   * for example, cars, www.example.com/cars.
   * 
   *
   * .google.ads.googleads.v17.services.KeywordAndUrlSeed keyword_and_url_seed = 2;
   */
  com.google.ads.googleads.v17.services.KeywordAndUrlSeedOrBuilder getKeywordAndUrlSeedOrBuilder();

  /**
   *    * A Keyword or phrase to generate ideas from, for example, cars.
   * 
   *
   * .google.ads.googleads.v17.services.KeywordSeed keyword_seed = 3;
   * @return Whether the keywordSeed field is set.
   */
  boolean hasKeywordSeed();
  /**
   *    * A Keyword or phrase to generate ideas from, for example, cars.
   * 
   *
   * .google.ads.googleads.v17.services.KeywordSeed keyword_seed = 3;
   * @return The keywordSeed.
   */
  com.google.ads.googleads.v17.services.KeywordSeed getKeywordSeed();
  /**
   *    * A Keyword or phrase to generate ideas from, for example, cars.
   * 
   *
   * .google.ads.googleads.v17.services.KeywordSeed keyword_seed = 3;
   */
  com.google.ads.googleads.v17.services.KeywordSeedOrBuilder getKeywordSeedOrBuilder();

  /**
   *    * A specific url to generate ideas from, for example, www.example.com/cars.
   * 
   *
   * .google.ads.googleads.v17.services.UrlSeed url_seed = 5;
   * @return Whether the urlSeed field is set.
   */
  boolean hasUrlSeed();
  /**
   *    * A specific url to generate ideas from, for example, www.example.com/cars.
   * 
   *
   * .google.ads.googleads.v17.services.UrlSeed url_seed = 5;
   * @return The urlSeed.
   */
  com.google.ads.googleads.v17.services.UrlSeed getUrlSeed();
  /**
   *    * A specific url to generate ideas from, for example, www.example.com/cars.
   * 
   *
   * .google.ads.googleads.v17.services.UrlSeed url_seed = 5;
   */
  com.google.ads.googleads.v17.services.UrlSeedOrBuilder getUrlSeedOrBuilder();

  /**
   *    * The site to generate ideas from, for example, www.example.com.
   * 
   *
   * .google.ads.googleads.v17.services.SiteSeed site_seed = 11;
   * @return Whether the siteSeed field is set.
   */
  boolean hasSiteSeed();
  /**
   *    * The site to generate ideas from, for example, www.example.com.
   * 
   *
   * .google.ads.googleads.v17.services.SiteSeed site_seed = 11;
   * @return The siteSeed.
   */
  com.google.ads.googleads.v17.services.SiteSeed getSiteSeed();
  /**
   *    * The site to generate ideas from, for example, www.example.com.
   * 
   *
   * .google.ads.googleads.v17.services.SiteSeed site_seed = 11;
   */
  com.google.ads.googleads.v17.services.SiteSeedOrBuilder getSiteSeedOrBuilder();

  com.google.ads.googleads.v17.services.GenerateKeywordIdeasRequest.SeedCase getSeedCase();
}