com.google.ads.googleads.v17.services.GenerateReachForecastRequestOrBuilder 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/reach_plan_service.proto

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

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

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

  /**
   *    * The currency code.
   * Three-character ISO 4217 currency code.
   * 
   *
   * optional string currency_code = 9;
   * @return Whether the currencyCode field is set.
   */
  boolean hasCurrencyCode();
  /**
   *    * The currency code.
   * Three-character ISO 4217 currency code.
   * 
   *
   * optional string currency_code = 9;
   * @return The currencyCode.
   */
  java.lang.String getCurrencyCode();
  /**
   *    * The currency code.
   * Three-character ISO 4217 currency code.
   * 
   *
   * optional string currency_code = 9;
   * @return The bytes for currencyCode.
   */
  com.google.protobuf.ByteString
      getCurrencyCodeBytes();

  /**
   *    * Required. Campaign duration.
   * 
   *
   * .google.ads.googleads.v17.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return Whether the campaignDuration field is set.
   */
  boolean hasCampaignDuration();
  /**
   *    * Required. Campaign duration.
   * 
   *
   * .google.ads.googleads.v17.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
   * @return The campaignDuration.
   */
  com.google.ads.googleads.v17.services.CampaignDuration getCampaignDuration();
  /**
   *    * Required. Campaign duration.
   * 
   *
   * .google.ads.googleads.v17.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
   */
  com.google.ads.googleads.v17.services.CampaignDurationOrBuilder getCampaignDurationOrBuilder();

  /**
   *    * Chosen cookie frequency cap to be applied to each planned product.
   * This is equivalent to the frequency cap exposed in Google Ads when creating
   * a campaign, it represents the maximum number of times an ad can be shown to
   * the same user.
   * If not specified, no cap is applied.
   *
   * This field is deprecated in v4 and will eventually be removed.
   * Use cookie_frequency_cap_setting instead.
   * 
   *
   * optional int32 cookie_frequency_cap = 10;
   * @return Whether the cookieFrequencyCap field is set.
   */
  boolean hasCookieFrequencyCap();
  /**
   *    * Chosen cookie frequency cap to be applied to each planned product.
   * This is equivalent to the frequency cap exposed in Google Ads when creating
   * a campaign, it represents the maximum number of times an ad can be shown to
   * the same user.
   * If not specified, no cap is applied.
   *
   * This field is deprecated in v4 and will eventually be removed.
   * Use cookie_frequency_cap_setting instead.
   * 
   *
   * optional int32 cookie_frequency_cap = 10;
   * @return The cookieFrequencyCap.
   */
  int getCookieFrequencyCap();

  /**
   *    * Chosen cookie frequency cap to be applied to each planned product.
   * This is equivalent to the frequency cap exposed in Google Ads when creating
   * a campaign, it represents the maximum number of times an ad can be shown to
   * the same user during a specified time interval.
   * If not specified, a default of 0 (no cap) is applied.
   *
   * This field replaces the deprecated cookie_frequency_cap field.
   * 
   *
   * .google.ads.googleads.v17.services.FrequencyCap cookie_frequency_cap_setting = 8;
   * @return Whether the cookieFrequencyCapSetting field is set.
   */
  boolean hasCookieFrequencyCapSetting();
  /**
   *    * Chosen cookie frequency cap to be applied to each planned product.
   * This is equivalent to the frequency cap exposed in Google Ads when creating
   * a campaign, it represents the maximum number of times an ad can be shown to
   * the same user during a specified time interval.
   * If not specified, a default of 0 (no cap) is applied.
   *
   * This field replaces the deprecated cookie_frequency_cap field.
   * 
   *
   * .google.ads.googleads.v17.services.FrequencyCap cookie_frequency_cap_setting = 8;
   * @return The cookieFrequencyCapSetting.
   */
  com.google.ads.googleads.v17.services.FrequencyCap getCookieFrequencyCapSetting();
  /**
   *    * Chosen cookie frequency cap to be applied to each planned product.
   * This is equivalent to the frequency cap exposed in Google Ads when creating
   * a campaign, it represents the maximum number of times an ad can be shown to
   * the same user during a specified time interval.
   * If not specified, a default of 0 (no cap) is applied.
   *
   * This field replaces the deprecated cookie_frequency_cap field.
   * 
   *
   * .google.ads.googleads.v17.services.FrequencyCap cookie_frequency_cap_setting = 8;
   */
  com.google.ads.googleads.v17.services.FrequencyCapOrBuilder getCookieFrequencyCapSettingOrBuilder();

  /**
   *    * Chosen minimum effective frequency (the number of times a person was
   * exposed to the ad) for the reported reach metrics [1-10].
   * This won't affect the targeting, but just the reporting.
   * If not specified, a default of 1 is applied.
   *
   * This field cannot be combined with the effective_frequency_limit field.
   * 
   *
   * optional int32 min_effective_frequency = 11;
   * @return Whether the minEffectiveFrequency field is set.
   */
  boolean hasMinEffectiveFrequency();
  /**
   *    * Chosen minimum effective frequency (the number of times a person was
   * exposed to the ad) for the reported reach metrics [1-10].
   * This won't affect the targeting, but just the reporting.
   * If not specified, a default of 1 is applied.
   *
   * This field cannot be combined with the effective_frequency_limit field.
   * 
   *
   * optional int32 min_effective_frequency = 11;
   * @return The minEffectiveFrequency.
   */
  int getMinEffectiveFrequency();

  /**
   *    * The highest minimum effective frequency (the number of times a person was
   * exposed to the ad) value [1-10] to include in
   * Forecast.effective_frequency_breakdowns.
   * If not specified, Forecast.effective_frequency_breakdowns will not be
   * provided.
   *
   * The effective frequency value provided here will also be used as the
   * minimum effective frequency for the reported reach metrics.
   *
   * This field cannot be combined with the min_effective_frequency field.
   * 
   *
   * optional .google.ads.googleads.v17.services.EffectiveFrequencyLimit effective_frequency_limit = 12;
   * @return Whether the effectiveFrequencyLimit field is set.
   */
  boolean hasEffectiveFrequencyLimit();
  /**
   *    * The highest minimum effective frequency (the number of times a person was
   * exposed to the ad) value [1-10] to include in
   * Forecast.effective_frequency_breakdowns.
   * If not specified, Forecast.effective_frequency_breakdowns will not be
   * provided.
   *
   * The effective frequency value provided here will also be used as the
   * minimum effective frequency for the reported reach metrics.
   *
   * This field cannot be combined with the min_effective_frequency field.
   * 
   *
   * optional .google.ads.googleads.v17.services.EffectiveFrequencyLimit effective_frequency_limit = 12;
   * @return The effectiveFrequencyLimit.
   */
  com.google.ads.googleads.v17.services.EffectiveFrequencyLimit getEffectiveFrequencyLimit();
  /**
   *    * The highest minimum effective frequency (the number of times a person was
   * exposed to the ad) value [1-10] to include in
   * Forecast.effective_frequency_breakdowns.
   * If not specified, Forecast.effective_frequency_breakdowns will not be
   * provided.
   *
   * The effective frequency value provided here will also be used as the
   * minimum effective frequency for the reported reach metrics.
   *
   * This field cannot be combined with the min_effective_frequency field.
   * 
   *
   * optional .google.ads.googleads.v17.services.EffectiveFrequencyLimit effective_frequency_limit = 12;
   */
  com.google.ads.googleads.v17.services.EffectiveFrequencyLimitOrBuilder getEffectiveFrequencyLimitOrBuilder();

  /**
   *    * The targeting to be applied to all products selected in the product mix.
   *
   * This is planned targeting: execution details might vary based on the
   * advertising product, consult an implementation specialist.
   *
   * See specific metrics for details on how targeting affects them.
   * 
   *
   * .google.ads.googleads.v17.services.Targeting targeting = 6;
   * @return Whether the targeting field is set.
   */
  boolean hasTargeting();
  /**
   *    * The targeting to be applied to all products selected in the product mix.
   *
   * This is planned targeting: execution details might vary based on the
   * advertising product, consult an implementation specialist.
   *
   * See specific metrics for details on how targeting affects them.
   * 
   *
   * .google.ads.googleads.v17.services.Targeting targeting = 6;
   * @return The targeting.
   */
  com.google.ads.googleads.v17.services.Targeting getTargeting();
  /**
   *    * The targeting to be applied to all products selected in the product mix.
   *
   * This is planned targeting: execution details might vary based on the
   * advertising product, consult an implementation specialist.
   *
   * See specific metrics for details on how targeting affects them.
   * 
   *
   * .google.ads.googleads.v17.services.Targeting targeting = 6;
   */
  com.google.ads.googleads.v17.services.TargetingOrBuilder getTargetingOrBuilder();

  /**
   *    * Required. The products to be forecast.
   * The max number of allowed planned products is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
   */
  java.util.List 
      getPlannedProductsList();
  /**
   *    * Required. The products to be forecast.
   * The max number of allowed planned products is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
   */
  com.google.ads.googleads.v17.services.PlannedProduct getPlannedProducts(int index);
  /**
   *    * Required. The products to be forecast.
   * The max number of allowed planned products is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
   */
  int getPlannedProductsCount();
  /**
   *    * Required. The products to be forecast.
   * The max number of allowed planned products is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
   */
  java.util.List 
      getPlannedProductsOrBuilderList();
  /**
   *    * Required. The products to be forecast.
   * The max number of allowed planned products is 15.
   * 
   *
   * repeated .google.ads.googleads.v17.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
   */
  com.google.ads.googleads.v17.services.PlannedProductOrBuilder getPlannedProductsOrBuilder(
      int index);

  /**
   *    * Controls the forecast metrics returned in the response.
   * 
   *
   * .google.ads.googleads.v17.services.ForecastMetricOptions forecast_metric_options = 13;
   * @return Whether the forecastMetricOptions field is set.
   */
  boolean hasForecastMetricOptions();
  /**
   *    * Controls the forecast metrics returned in the response.
   * 
   *
   * .google.ads.googleads.v17.services.ForecastMetricOptions forecast_metric_options = 13;
   * @return The forecastMetricOptions.
   */
  com.google.ads.googleads.v17.services.ForecastMetricOptions getForecastMetricOptions();
  /**
   *    * Controls the forecast metrics returned in the response.
   * 
   *
   * .google.ads.googleads.v17.services.ForecastMetricOptions forecast_metric_options = 13;
   */
  com.google.ads.googleads.v17.services.ForecastMetricOptionsOrBuilder getForecastMetricOptionsOrBuilder();

  /**
   *    * The name of the customer being planned for. This is a user-defined value.
   * 
   *
   * optional string customer_reach_group = 14;
   * @return Whether the customerReachGroup field is set.
   */
  boolean hasCustomerReachGroup();
  /**
   *    * The name of the customer being planned for. This is a user-defined value.
   * 
   *
   * optional string customer_reach_group = 14;
   * @return The customerReachGroup.
   */
  java.lang.String getCustomerReachGroup();
  /**
   *    * The name of the customer being planned for. This is a user-defined value.
   * 
   *
   * optional string customer_reach_group = 14;
   * @return The bytes for customerReachGroup.
   */
  com.google.protobuf.ByteString
      getCustomerReachGroupBytes();
}