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

Class GenerateReachForecastRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
com.google.ads.googleads.v18.services.GenerateReachForecastRequest.Builder
All Implemented Interfaces:
GenerateReachForecastRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GenerateReachForecastRequest
public static final class GenerateReachForecastRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder> implements GenerateReachForecastRequestOrBuilder
 Request message for
 [ReachPlanService.GenerateReachForecast][google.ads.googleads.v18.services.ReachPlanService.GenerateReachForecast].
Protobuf type google.ads.googleads.v18.services.GenerateReachForecastRequest

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • clear

      public GenerateReachForecastRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • getDefaultInstanceForType

      public GenerateReachForecastRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public GenerateReachForecastRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public GenerateReachForecastRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public GenerateReachForecastRequest.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • setField

      public GenerateReachForecastRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • clearField

      public GenerateReachForecastRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • clearOneof

      public GenerateReachForecastRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • setRepeatedField

      public GenerateReachForecastRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • addRepeatedField

      public GenerateReachForecastRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • mergeFrom

      public GenerateReachForecastRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateReachForecastRequest.Builder>

    • mergeFrom

      public GenerateReachForecastRequest.Builder mergeFrom(GenerateReachForecastRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • mergeFrom

      public GenerateReachForecastRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateReachForecastRequest.Builder>
      Throws:
      IOException

    • getCustomerId

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

    • getCustomerIdBytes

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

    • setCustomerId

      public GenerateReachForecastRequest.Builder setCustomerId(String value)
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The customerId to set.
      Returns:
      This builder for chaining.

    • clearCustomerId

      public GenerateReachForecastRequest.Builder clearCustomerId()
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setCustomerIdBytes

      public GenerateReachForecastRequest.Builder setCustomerIdBytes(com.google.protobuf.ByteString value)
       Required. The ID of the customer.
      string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for customerId to set.
      Returns:
      This builder for chaining.

    • hasCurrencyCode

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

    • getCurrencyCode

      public String getCurrencyCode()
       The currency code.
 Three-character ISO 4217 currency code.
      optional string currency_code = 9;
      Specified by:
      getCurrencyCode in interface GenerateReachForecastRequestOrBuilder
      Returns:
      The currencyCode.

    • getCurrencyCodeBytes

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

    • setCurrencyCode

      public GenerateReachForecastRequest.Builder setCurrencyCode(String value)
       The currency code.
 Three-character ISO 4217 currency code.
      optional string currency_code = 9;
      Parameters:
      value - The currencyCode to set.
      Returns:
      This builder for chaining.

    • clearCurrencyCode

      public GenerateReachForecastRequest.Builder clearCurrencyCode()
       The currency code.
 Three-character ISO 4217 currency code.
      optional string currency_code = 9;
      Returns:
      This builder for chaining.

    • setCurrencyCodeBytes

      public GenerateReachForecastRequest.Builder setCurrencyCodeBytes(com.google.protobuf.ByteString value)
       The currency code.
 Three-character ISO 4217 currency code.
      optional string currency_code = 9;
      Parameters:
      value - The bytes for currencyCode to set.
      Returns:
      This builder for chaining.

    • hasCampaignDuration

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

    • getCampaignDuration

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

    • setCampaignDuration

      public GenerateReachForecastRequest.Builder setCampaignDuration(CampaignDuration value)
       Required. Campaign duration.
      .google.ads.googleads.v18.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];

    • setCampaignDuration

      public GenerateReachForecastRequest.Builder setCampaignDuration(CampaignDuration.Builder builderForValue)
       Required. Campaign duration.
      .google.ads.googleads.v18.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];

    • mergeCampaignDuration

      public GenerateReachForecastRequest.Builder mergeCampaignDuration(CampaignDuration value)
       Required. Campaign duration.
      .google.ads.googleads.v18.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];

    • clearCampaignDuration

      public GenerateReachForecastRequest.Builder clearCampaignDuration()
       Required. Campaign duration.
      .google.ads.googleads.v18.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];

    • getCampaignDurationBuilder

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

    • getCampaignDurationOrBuilder

      public CampaignDurationOrBuilder getCampaignDurationOrBuilder()
       Required. Campaign duration.
      .google.ads.googleads.v18.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getCampaignDurationOrBuilder in interface GenerateReachForecastRequestOrBuilder

    • hasCookieFrequencyCap

      public 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;
      Specified by:
      hasCookieFrequencyCap in interface GenerateReachForecastRequestOrBuilder
      Returns:
      Whether the cookieFrequencyCap field is set.

    • getCookieFrequencyCap

      public 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;
      Specified by:
      getCookieFrequencyCap in interface GenerateReachForecastRequestOrBuilder
      Returns:
      The cookieFrequencyCap.

    • setCookieFrequencyCap

      public GenerateReachForecastRequest.Builder setCookieFrequencyCap(int value)
       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;
      Parameters:
      value - The cookieFrequencyCap to set.
      Returns:
      This builder for chaining.

    • clearCookieFrequencyCap

      public GenerateReachForecastRequest.Builder clearCookieFrequencyCap()
       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:
      This builder for chaining.

    • hasCookieFrequencyCapSetting

      public 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;
      Specified by:
      hasCookieFrequencyCapSetting in interface GenerateReachForecastRequestOrBuilder
      Returns:
      Whether the cookieFrequencyCapSetting field is set.

    • getCookieFrequencyCapSetting

      public 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;
      Specified by:
      getCookieFrequencyCapSetting in interface GenerateReachForecastRequestOrBuilder
      Returns:
      The cookieFrequencyCapSetting.

    • setCookieFrequencyCapSetting

      public GenerateReachForecastRequest.Builder setCookieFrequencyCapSetting(FrequencyCap value)
       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;

    • setCookieFrequencyCapSetting

      public GenerateReachForecastRequest.Builder setCookieFrequencyCapSetting(FrequencyCap.Builder builderForValue)
       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;

    • mergeCookieFrequencyCapSetting

      public GenerateReachForecastRequest.Builder mergeCookieFrequencyCapSetting(FrequencyCap value)
       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;

    • clearCookieFrequencyCapSetting

      public GenerateReachForecastRequest.Builder clearCookieFrequencyCapSetting()
       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;

    • getCookieFrequencyCapSettingBuilder

      public FrequencyCap.Builder getCookieFrequencyCapSettingBuilder()
       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;

    • getCookieFrequencyCapSettingOrBuilder

      public 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;
      Specified by:
      getCookieFrequencyCapSettingOrBuilder in interface GenerateReachForecastRequestOrBuilder

    • hasMinEffectiveFrequency

      public 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;
      Specified by:
      hasMinEffectiveFrequency in interface GenerateReachForecastRequestOrBuilder
      Returns:
      Whether the minEffectiveFrequency field is set.

    • getMinEffectiveFrequency

      public 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;
      Specified by:
      getMinEffectiveFrequency in interface GenerateReachForecastRequestOrBuilder
      Returns:
      The minEffectiveFrequency.

    • setMinEffectiveFrequency

      public GenerateReachForecastRequest.Builder setMinEffectiveFrequency(int value)
       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;
      Parameters:
      value - The minEffectiveFrequency to set.
      Returns:
      This builder for chaining.

    • clearMinEffectiveFrequency

      public GenerateReachForecastRequest.Builder clearMinEffectiveFrequency()
       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:
      This builder for chaining.

    • hasEffectiveFrequencyLimit

      public 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;
      Specified by:
      hasEffectiveFrequencyLimit in interface GenerateReachForecastRequestOrBuilder
      Returns:
      Whether the effectiveFrequencyLimit field is set.

    • getEffectiveFrequencyLimit

      public 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;
      Specified by:
      getEffectiveFrequencyLimit in interface GenerateReachForecastRequestOrBuilder
      Returns:
      The effectiveFrequencyLimit.

    • setEffectiveFrequencyLimit

      public GenerateReachForecastRequest.Builder setEffectiveFrequencyLimit(EffectiveFrequencyLimit value)
       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;

    • setEffectiveFrequencyLimit

      public GenerateReachForecastRequest.Builder setEffectiveFrequencyLimit(EffectiveFrequencyLimit.Builder builderForValue)
       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;

    • mergeEffectiveFrequencyLimit

      public GenerateReachForecastRequest.Builder mergeEffectiveFrequencyLimit(EffectiveFrequencyLimit value)
       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;

    • clearEffectiveFrequencyLimit

      public GenerateReachForecastRequest.Builder clearEffectiveFrequencyLimit()
       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;

    • getEffectiveFrequencyLimitBuilder

      public EffectiveFrequencyLimit.Builder getEffectiveFrequencyLimitBuilder()
       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;

    • getEffectiveFrequencyLimitOrBuilder

      public 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;
      Specified by:
      getEffectiveFrequencyLimitOrBuilder in interface GenerateReachForecastRequestOrBuilder

    • hasTargeting

      public 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;
      Specified by:
      hasTargeting in interface GenerateReachForecastRequestOrBuilder
      Returns:
      Whether the targeting field is set.

    • getTargeting

      public 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;
      Specified by:
      getTargeting in interface GenerateReachForecastRequestOrBuilder
      Returns:
      The targeting.

    • setTargeting

      public GenerateReachForecastRequest.Builder setTargeting(Targeting value)
       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;

    • setTargeting

      public GenerateReachForecastRequest.Builder setTargeting(Targeting.Builder builderForValue)
       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;

    • mergeTargeting

      public GenerateReachForecastRequest.Builder mergeTargeting(Targeting value)
       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;

    • clearTargeting

      public GenerateReachForecastRequest.Builder clearTargeting()
       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;

    • getTargetingBuilder

      public Targeting.Builder getTargetingBuilder()
       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;

    • getTargetingOrBuilder

      public 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;
      Specified by:
      getTargetingOrBuilder in interface GenerateReachForecastRequestOrBuilder

    • getPlannedProductsList

      public 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];
      Specified by:
      getPlannedProductsList in interface GenerateReachForecastRequestOrBuilder

    • getPlannedProductsCount

      public 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];
      Specified by:
      getPlannedProductsCount in interface GenerateReachForecastRequestOrBuilder

    • getPlannedProducts

      public 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];
      Specified by:
      getPlannedProducts in interface GenerateReachForecastRequestOrBuilder

    • setPlannedProducts

      public GenerateReachForecastRequest.Builder setPlannedProducts(int index, PlannedProduct value)
       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];

    • setPlannedProducts

      public GenerateReachForecastRequest.Builder setPlannedProducts(int index, PlannedProduct.Builder builderForValue)
       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];

    • addPlannedProducts

      public GenerateReachForecastRequest.Builder addPlannedProducts(PlannedProduct value)
       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];

    • addPlannedProducts

      public GenerateReachForecastRequest.Builder addPlannedProducts(int index, PlannedProduct value)
       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];

    • addPlannedProducts

      public GenerateReachForecastRequest.Builder addPlannedProducts(PlannedProduct.Builder builderForValue)
       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];

    • addPlannedProducts

      public GenerateReachForecastRequest.Builder addPlannedProducts(int index, PlannedProduct.Builder builderForValue)
       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];

    • addAllPlannedProducts

      public GenerateReachForecastRequest.Builder addAllPlannedProducts(Iterable<? extends PlannedProduct> values)
       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];

    • clearPlannedProducts

      public GenerateReachForecastRequest.Builder clearPlannedProducts()
       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];

    • removePlannedProducts

      public GenerateReachForecastRequest.Builder removePlannedProducts(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];

    • getPlannedProductsBuilder

      public PlannedProduct.Builder getPlannedProductsBuilder(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];

    • getPlannedProductsOrBuilder

      public 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];
      Specified by:
      getPlannedProductsOrBuilder in interface GenerateReachForecastRequestOrBuilder

    • getPlannedProductsOrBuilderList

      public 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];
      Specified by:
      getPlannedProductsOrBuilderList in interface GenerateReachForecastRequestOrBuilder

    • addPlannedProductsBuilder

      public PlannedProduct.Builder addPlannedProductsBuilder()
       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];

    • addPlannedProductsBuilder

      public PlannedProduct.Builder addPlannedProductsBuilder(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];

    • getPlannedProductsBuilderList

      public List<PlannedProduct.Builder> getPlannedProductsBuilderList()
       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

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

    • getForecastMetricOptions

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

    • setForecastMetricOptions

      public GenerateReachForecastRequest.Builder setForecastMetricOptions(ForecastMetricOptions value)
       Controls the forecast metrics returned in the response.
      .google.ads.googleads.v18.services.ForecastMetricOptions forecast_metric_options = 13;

    • setForecastMetricOptions

      public GenerateReachForecastRequest.Builder setForecastMetricOptions(ForecastMetricOptions.Builder builderForValue)
       Controls the forecast metrics returned in the response.
      .google.ads.googleads.v18.services.ForecastMetricOptions forecast_metric_options = 13;

    • mergeForecastMetricOptions

      public GenerateReachForecastRequest.Builder mergeForecastMetricOptions(ForecastMetricOptions value)
       Controls the forecast metrics returned in the response.
      .google.ads.googleads.v18.services.ForecastMetricOptions forecast_metric_options = 13;

    • clearForecastMetricOptions

      public GenerateReachForecastRequest.Builder clearForecastMetricOptions()
       Controls the forecast metrics returned in the response.
      .google.ads.googleads.v18.services.ForecastMetricOptions forecast_metric_options = 13;

    • getForecastMetricOptionsBuilder

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

    • getForecastMetricOptionsOrBuilder

      public ForecastMetricOptionsOrBuilder getForecastMetricOptionsOrBuilder()
       Controls the forecast metrics returned in the response.
      .google.ads.googleads.v18.services.ForecastMetricOptions forecast_metric_options = 13;
      Specified by:
      getForecastMetricOptionsOrBuilder in interface GenerateReachForecastRequestOrBuilder

    • hasCustomerReachGroup

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

    • getCustomerReachGroup

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

    • getCustomerReachGroupBytes

      public 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;
      Specified by:
      getCustomerReachGroupBytes in interface GenerateReachForecastRequestOrBuilder
      Returns:
      The bytes for customerReachGroup.

    • setCustomerReachGroup

      public GenerateReachForecastRequest.Builder setCustomerReachGroup(String value)
       The name of the customer being planned for. This is a user-defined value.
      optional string customer_reach_group = 14;
      Parameters:
      value - The customerReachGroup to set.
      Returns:
      This builder for chaining.

    • clearCustomerReachGroup

      public GenerateReachForecastRequest.Builder clearCustomerReachGroup()
       The name of the customer being planned for. This is a user-defined value.
      optional string customer_reach_group = 14;
      Returns:
      This builder for chaining.

    • setCustomerReachGroupBytes

      public GenerateReachForecastRequest.Builder setCustomerReachGroupBytes(com.google.protobuf.ByteString value)
       The name of the customer being planned for. This is a user-defined value.
      optional string customer_reach_group = 14;
      Parameters:
      value - The bytes for customerReachGroup to set.
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final GenerateReachForecastRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>

    • mergeUnknownFields

      public final GenerateReachForecastRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>