com.google.ads.googleads.v17.services.GenerateKeywordForecastMetricsRequestOrBuilder 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 GenerateKeywordForecastMetricsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.ads.googleads.v17.services.GenerateKeywordForecastMetricsRequest)
    com.google.protobuf.MessageOrBuilder {

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

  /**
   *    * The currency used for exchange rate conversion.
   * By default, the account currency of the customer is used.
   * Set this field only if the currency is different from the account currency.
   * The list of valid currency codes can be found at
   * https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
   * 
   *
   * optional string currency_code = 2;
   * @return Whether the currencyCode field is set.
   */
  boolean hasCurrencyCode();
  /**
   *    * The currency used for exchange rate conversion.
   * By default, the account currency of the customer is used.
   * Set this field only if the currency is different from the account currency.
   * The list of valid currency codes can be found at
   * https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
   * 
   *
   * optional string currency_code = 2;
   * @return The currencyCode.
   */
  java.lang.String getCurrencyCode();
  /**
   *    * The currency used for exchange rate conversion.
   * By default, the account currency of the customer is used.
   * Set this field only if the currency is different from the account currency.
   * The list of valid currency codes can be found at
   * https://developers.google.com/google-ads/api/data/codes-formats#currency-codes.
   * 
   *
   * optional string currency_code = 2;
   * @return The bytes for currencyCode.
   */
  com.google.protobuf.ByteString
      getCurrencyCodeBytes();

  /**
   *    * The date range for the forecast. The start date must be in the future and
   * end date must be within 1 year from today. The reference timezone used is
   * the one of the Google Ads account belonging to the customer. If not set, a
   * default date range from next Sunday to the following Saturday will be used.
   * 
   *
   * .google.ads.googleads.v17.common.DateRange forecast_period = 3;
   * @return Whether the forecastPeriod field is set.
   */
  boolean hasForecastPeriod();
  /**
   *    * The date range for the forecast. The start date must be in the future and
   * end date must be within 1 year from today. The reference timezone used is
   * the one of the Google Ads account belonging to the customer. If not set, a
   * default date range from next Sunday to the following Saturday will be used.
   * 
   *
   * .google.ads.googleads.v17.common.DateRange forecast_period = 3;
   * @return The forecastPeriod.
   */
  com.google.ads.googleads.v17.common.DateRange getForecastPeriod();
  /**
   *    * The date range for the forecast. The start date must be in the future and
   * end date must be within 1 year from today. The reference timezone used is
   * the one of the Google Ads account belonging to the customer. If not set, a
   * default date range from next Sunday to the following Saturday will be used.
   * 
   *
   * .google.ads.googleads.v17.common.DateRange forecast_period = 3;
   */
  com.google.ads.googleads.v17.common.DateRangeOrBuilder getForecastPeriodOrBuilder();

  /**
   *    * Required. The campaign used in the forecast.
   * 
   *
   * .google.ads.googleads.v17.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return Whether the campaign field is set.
   */
  boolean hasCampaign();
  /**
   *    * Required. The campaign used in the forecast.
   * 
   *
   * .google.ads.googleads.v17.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
   * @return The campaign.
   */
  com.google.ads.googleads.v17.services.CampaignToForecast getCampaign();
  /**
   *    * Required. The campaign used in the forecast.
   * 
   *
   * .google.ads.googleads.v17.services.CampaignToForecast campaign = 4 [(.google.api.field_behavior) = REQUIRED];
   */
  com.google.ads.googleads.v17.services.CampaignToForecastOrBuilder getCampaignOrBuilder();
}