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

Interface GenerateReachForecastRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
GenerateReachForecastRequest, GenerateReachForecastRequest.Builder
public interface GenerateReachForecastRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getCustomerId

      String getCustomerId()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The customerId.

    • getCustomerIdBytes

      com.google.protobuf.ByteString getCustomerIdBytes()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for customerId.

    • hasCurrencyCode

      boolean hasCurrencyCode()
       The currency code.
 Three-character ISO 4217 currency code.
      optional string currency_code = 9;
      Returns:
      Whether the currencyCode field is set.

    • getCurrencyCode

      String getCurrencyCode()
       The currency code.
 Three-character ISO 4217 currency code.
      optional string currency_code = 9;
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

      com.google.protobuf.ByteString getCurrencyCodeBytes()
       The currency code.
 Three-character ISO 4217 currency code.
      optional string currency_code = 9;
      Returns:
      The bytes for currencyCode.

    • hasCampaignDuration

      boolean hasCampaignDuration()
       Required. Campaign duration.
      .google.ads.googleads.v18.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the campaignDuration field is set.

    • getCampaignDuration

      CampaignDuration getCampaignDuration()
       Required. Campaign duration.
      .google.ads.googleads.v18.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The campaignDuration.

    • getCampaignDurationOrBuilder

      CampaignDurationOrBuilder getCampaignDurationOrBuilder()
       Required. Campaign duration.
      .google.ads.googleads.v18.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];

    • hasCookieFrequencyCap

      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;
      Returns:
      Whether the cookieFrequencyCap field is set.

    • getCookieFrequencyCap

      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.
 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;
      Returns:
      The cookieFrequencyCap.

    • hasCookieFrequencyCapSetting

      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.v18.services.FrequencyCap cookie_frequency_cap_setting = 8;
      Returns:
      Whether the cookieFrequencyCapSetting field is set.

    • getCookieFrequencyCapSetting

      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.v18.services.FrequencyCap cookie_frequency_cap_setting = 8;
      Returns:
      The cookieFrequencyCapSetting.

    • getCookieFrequencyCapSettingOrBuilder

      FrequencyCapOrBuilder getCookieFrequencyCapSettingOrBuilder()
       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.v18.services.FrequencyCap cookie_frequency_cap_setting = 8;

    • hasMinEffectiveFrequency

      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;
      Returns:
      Whether the minEffectiveFrequency field is set.

    • getMinEffectiveFrequency

      int getMinEffectiveFrequency()
       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;
      Returns:
      The minEffectiveFrequency.

    • hasEffectiveFrequencyLimit

      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.v18.services.EffectiveFrequencyLimit effective_frequency_limit = 12;
      Returns:
      Whether the effectiveFrequencyLimit field is set.

    • getEffectiveFrequencyLimit

      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.v18.services.EffectiveFrequencyLimit effective_frequency_limit = 12;
      Returns:
      The effectiveFrequencyLimit.

    • getEffectiveFrequencyLimitOrBuilder

      EffectiveFrequencyLimitOrBuilder getEffectiveFrequencyLimitOrBuilder()
       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.v18.services.EffectiveFrequencyLimit effective_frequency_limit = 12;

    • hasTargeting

      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.v18.services.Targeting targeting = 6;
      Returns:
      Whether the targeting field is set.

    • getTargeting

      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.v18.services.Targeting targeting = 6;
      Returns:
      The targeting.

    • getTargetingOrBuilder

      TargetingOrBuilder getTargetingOrBuilder()
       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.v18.services.Targeting targeting = 6;

    • getPlannedProductsList

      List<PlannedProduct> getPlannedProductsList()
       Required. The products to be forecast.
 The max number of allowed planned products is 15.
      repeated .google.ads.googleads.v18.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];

    • getPlannedProducts

      PlannedProduct getPlannedProducts(int index)
       Required. The products to be forecast.
 The max number of allowed planned products is 15.
      repeated .google.ads.googleads.v18.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];

    • getPlannedProductsCount

      int getPlannedProductsCount()
       Required. The products to be forecast.
 The max number of allowed planned products is 15.
      repeated .google.ads.googleads.v18.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];

    • getPlannedProductsOrBuilderList

      List<? extends PlannedProductOrBuilder> getPlannedProductsOrBuilderList()
       Required. The products to be forecast.
 The max number of allowed planned products is 15.
      repeated .google.ads.googleads.v18.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];

    • getPlannedProductsOrBuilder

      PlannedProductOrBuilder getPlannedProductsOrBuilder(int index)
       Required. The products to be forecast.
 The max number of allowed planned products is 15.
      repeated .google.ads.googleads.v18.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];

    • hasForecastMetricOptions

      boolean hasForecastMetricOptions()
       Controls the forecast metrics returned in the response.
      .google.ads.googleads.v18.services.ForecastMetricOptions forecast_metric_options = 13;
      Returns:
      Whether the forecastMetricOptions field is set.

    • getForecastMetricOptions

      ForecastMetricOptions getForecastMetricOptions()
       Controls the forecast metrics returned in the response.
      .google.ads.googleads.v18.services.ForecastMetricOptions forecast_metric_options = 13;
      Returns:
      The forecastMetricOptions.

    • getForecastMetricOptionsOrBuilder

      ForecastMetricOptionsOrBuilder getForecastMetricOptionsOrBuilder()
       Controls the forecast metrics returned in the response.
      .google.ads.googleads.v18.services.ForecastMetricOptions forecast_metric_options = 13;

    • hasCustomerReachGroup

      boolean hasCustomerReachGroup()
       The name of the customer being planned for. This is a user-defined value.
      optional string customer_reach_group = 14;
      Returns:
      Whether the customerReachGroup field is set.

    • getCustomerReachGroup

      String getCustomerReachGroup()
       The name of the customer being planned for. This is a user-defined value.
      optional string customer_reach_group = 14;
      Returns:
      The customerReachGroup.

    • getCustomerReachGroupBytes

      com.google.protobuf.ByteString getCustomerReachGroupBytes()
       The name of the customer being planned for. This is a user-defined value.
      optional string customer_reach_group = 14;
      Returns:
      The bytes for customerReachGroup.