Class GenerateReachForecastRequest.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
- com.google.ads.googleads.v10.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,java.lang.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.v10.services.ReachPlanService.GenerateReachForecast].
Protobuf typegoogle.ads.googleads.v10.services.GenerateReachForecastRequest
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description GenerateReachForecastRequest.BuilderaddAllPlannedProducts(java.lang.Iterable<? extends PlannedProduct> values)Required.GenerateReachForecastRequest.BuilderaddPlannedProducts(int index, PlannedProduct value)Required.GenerateReachForecastRequest.BuilderaddPlannedProducts(int index, PlannedProduct.Builder builderForValue)Required.GenerateReachForecastRequest.BuilderaddPlannedProducts(PlannedProduct value)Required.GenerateReachForecastRequest.BuilderaddPlannedProducts(PlannedProduct.Builder builderForValue)Required.PlannedProduct.BuilderaddPlannedProductsBuilder()Required.PlannedProduct.BuilderaddPlannedProductsBuilder(int index)Required.GenerateReachForecastRequest.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)GenerateReachForecastRequestbuild()GenerateReachForecastRequestbuildPartial()GenerateReachForecastRequest.Builderclear()GenerateReachForecastRequest.BuilderclearCampaignDuration()Required.GenerateReachForecastRequest.BuilderclearCookieFrequencyCap()Desired cookie frequency cap that will be applied to each planned product.GenerateReachForecastRequest.BuilderclearCookieFrequencyCapSetting()Desired cookie frequency cap that will be applied to each planned product.GenerateReachForecastRequest.BuilderclearCurrencyCode()The currency code.GenerateReachForecastRequest.BuilderclearCustomerId()Required.GenerateReachForecastRequest.BuilderclearEffectiveFrequencyLimit()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.GenerateReachForecastRequest.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)GenerateReachForecastRequest.BuilderclearMinEffectiveFrequency()Desired minimum effective frequency (the number of times a person was exposed to the ad) for the reported reach metrics [1-10].GenerateReachForecastRequest.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)GenerateReachForecastRequest.BuilderclearPlannedProducts()Required.GenerateReachForecastRequest.BuilderclearTargeting()The targeting to be applied to all products selected in the product mix.GenerateReachForecastRequest.Builderclone()CampaignDurationgetCampaignDuration()Required.CampaignDuration.BuildergetCampaignDurationBuilder()Required.CampaignDurationOrBuildergetCampaignDurationOrBuilder()Required.intgetCookieFrequencyCap()Desired cookie frequency cap that will be applied to each planned product.FrequencyCapgetCookieFrequencyCapSetting()Desired cookie frequency cap that will be applied to each planned product.FrequencyCap.BuildergetCookieFrequencyCapSettingBuilder()Desired cookie frequency cap that will be applied to each planned product.FrequencyCapOrBuildergetCookieFrequencyCapSettingOrBuilder()Desired cookie frequency cap that will be applied to each planned product.java.lang.StringgetCurrencyCode()The currency code.com.google.protobuf.ByteStringgetCurrencyCodeBytes()The currency code.java.lang.StringgetCustomerId()Required.com.google.protobuf.ByteStringgetCustomerIdBytes()Required.GenerateReachForecastRequestgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()EffectiveFrequencyLimitgetEffectiveFrequencyLimit()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.EffectiveFrequencyLimit.BuildergetEffectiveFrequencyLimitBuilder()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.EffectiveFrequencyLimitOrBuildergetEffectiveFrequencyLimitOrBuilder()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.intgetMinEffectiveFrequency()Desired minimum effective frequency (the number of times a person was exposed to the ad) for the reported reach metrics [1-10].PlannedProductgetPlannedProducts(int index)Required.PlannedProduct.BuildergetPlannedProductsBuilder(int index)Required.java.util.List<PlannedProduct.Builder>getPlannedProductsBuilderList()Required.intgetPlannedProductsCount()Required.java.util.List<PlannedProduct>getPlannedProductsList()Required.PlannedProductOrBuildergetPlannedProductsOrBuilder(int index)Required.java.util.List<? extends PlannedProductOrBuilder>getPlannedProductsOrBuilderList()Required.TargetinggetTargeting()The targeting to be applied to all products selected in the product mix.Targeting.BuildergetTargetingBuilder()The targeting to be applied to all products selected in the product mix.TargetingOrBuildergetTargetingOrBuilder()The targeting to be applied to all products selected in the product mix.booleanhasCampaignDuration()Required.booleanhasCookieFrequencyCap()Desired cookie frequency cap that will be applied to each planned product.booleanhasCookieFrequencyCapSetting()Desired cookie frequency cap that will be applied to each planned product.booleanhasCurrencyCode()The currency code.booleanhasEffectiveFrequencyLimit()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.booleanhasMinEffectiveFrequency()Desired minimum effective frequency (the number of times a person was exposed to the ad) for the reported reach metrics [1-10].booleanhasTargeting()The targeting to be applied to all products selected in the product mix.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()GenerateReachForecastRequest.BuildermergeCampaignDuration(CampaignDuration value)Required.GenerateReachForecastRequest.BuildermergeCookieFrequencyCapSetting(FrequencyCap value)Desired cookie frequency cap that will be applied to each planned product.GenerateReachForecastRequest.BuildermergeEffectiveFrequencyLimit(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.GenerateReachForecastRequest.BuildermergeFrom(GenerateReachForecastRequest other)GenerateReachForecastRequest.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)GenerateReachForecastRequest.BuildermergeFrom(com.google.protobuf.Message other)GenerateReachForecastRequest.BuildermergeTargeting(Targeting value)The targeting to be applied to all products selected in the product mix.GenerateReachForecastRequest.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)GenerateReachForecastRequest.BuilderremovePlannedProducts(int index)Required.GenerateReachForecastRequest.BuildersetCampaignDuration(CampaignDuration value)Required.GenerateReachForecastRequest.BuildersetCampaignDuration(CampaignDuration.Builder builderForValue)Required.GenerateReachForecastRequest.BuildersetCookieFrequencyCap(int value)Desired cookie frequency cap that will be applied to each planned product.GenerateReachForecastRequest.BuildersetCookieFrequencyCapSetting(FrequencyCap value)Desired cookie frequency cap that will be applied to each planned product.GenerateReachForecastRequest.BuildersetCookieFrequencyCapSetting(FrequencyCap.Builder builderForValue)Desired cookie frequency cap that will be applied to each planned product.GenerateReachForecastRequest.BuildersetCurrencyCode(java.lang.String value)The currency code.GenerateReachForecastRequest.BuildersetCurrencyCodeBytes(com.google.protobuf.ByteString value)The currency code.GenerateReachForecastRequest.BuildersetCustomerId(java.lang.String value)Required.GenerateReachForecastRequest.BuildersetCustomerIdBytes(com.google.protobuf.ByteString value)Required.GenerateReachForecastRequest.BuildersetEffectiveFrequencyLimit(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.GenerateReachForecastRequest.BuildersetEffectiveFrequencyLimit(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.GenerateReachForecastRequest.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)GenerateReachForecastRequest.BuildersetMinEffectiveFrequency(int value)Desired minimum effective frequency (the number of times a person was exposed to the ad) for the reported reach metrics [1-10].GenerateReachForecastRequest.BuildersetPlannedProducts(int index, PlannedProduct value)Required.GenerateReachForecastRequest.BuildersetPlannedProducts(int index, PlannedProduct.Builder builderForValue)Required.GenerateReachForecastRequest.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)GenerateReachForecastRequest.BuildersetTargeting(Targeting value)The targeting to be applied to all products selected in the product mix.GenerateReachForecastRequest.BuildersetTargeting(Targeting.Builder builderForValue)The targeting to be applied to all products selected in the product mix.GenerateReachForecastRequest.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
clear
public GenerateReachForecastRequest.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
getDefaultInstanceForType
public GenerateReachForecastRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public GenerateReachForecastRequest build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public GenerateReachForecastRequest buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public GenerateReachForecastRequest.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
setField
public GenerateReachForecastRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
clearField
public GenerateReachForecastRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
clearOneof
public GenerateReachForecastRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
setRepeatedField
public GenerateReachForecastRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
addRepeatedField
public GenerateReachForecastRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
mergeFrom
public GenerateReachForecastRequest.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<GenerateReachForecastRequest.Builder>
-
mergeFrom
public GenerateReachForecastRequest.Builder mergeFrom(GenerateReachForecastRequest other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
mergeFrom
public GenerateReachForecastRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<GenerateReachForecastRequest.Builder>- Throws:
java.io.IOException
-
getCustomerId
public java.lang.String getCustomerId()
Required. The ID of the customer.
string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getCustomerIdin interfaceGenerateReachForecastRequestOrBuilder- 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:
getCustomerIdBytesin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- The bytes for customerId.
-
setCustomerId
public GenerateReachForecastRequest.Builder setCustomerId(java.lang.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:
hasCurrencyCodein interfaceGenerateReachForecastRequestOrBuilder- Returns:
- Whether the currencyCode field is set.
-
getCurrencyCode
public java.lang.String getCurrencyCode()
The currency code. Three-character ISO 4217 currency code.
optional string currency_code = 9;- Specified by:
getCurrencyCodein interfaceGenerateReachForecastRequestOrBuilder- 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:
getCurrencyCodeBytesin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- The bytes for currencyCode.
-
setCurrencyCode
public GenerateReachForecastRequest.Builder setCurrencyCode(java.lang.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.v10.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
hasCampaignDurationin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- Whether the campaignDuration field is set.
-
getCampaignDuration
public CampaignDuration getCampaignDuration()
Required. Campaign duration.
.google.ads.googleads.v10.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getCampaignDurationin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- The campaignDuration.
-
setCampaignDuration
public GenerateReachForecastRequest.Builder setCampaignDuration(CampaignDuration value)
Required. Campaign duration.
.google.ads.googleads.v10.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
-
setCampaignDuration
public GenerateReachForecastRequest.Builder setCampaignDuration(CampaignDuration.Builder builderForValue)
Required. Campaign duration.
.google.ads.googleads.v10.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
-
mergeCampaignDuration
public GenerateReachForecastRequest.Builder mergeCampaignDuration(CampaignDuration value)
Required. Campaign duration.
.google.ads.googleads.v10.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
-
clearCampaignDuration
public GenerateReachForecastRequest.Builder clearCampaignDuration()
Required. Campaign duration.
.google.ads.googleads.v10.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
-
getCampaignDurationBuilder
public CampaignDuration.Builder getCampaignDurationBuilder()
Required. Campaign duration.
.google.ads.googleads.v10.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];
-
getCampaignDurationOrBuilder
public CampaignDurationOrBuilder getCampaignDurationOrBuilder()
Required. Campaign duration.
.google.ads.googleads.v10.services.CampaignDuration campaign_duration = 3 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getCampaignDurationOrBuilderin interfaceGenerateReachForecastRequestOrBuilder
-
hasCookieFrequencyCap
public boolean hasCookieFrequencyCap()
Desired cookie frequency cap that will 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. Please use cookie_frequency_cap_setting instead.
optional int32 cookie_frequency_cap = 10;- Specified by:
hasCookieFrequencyCapin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- Whether the cookieFrequencyCap field is set.
-
getCookieFrequencyCap
public int getCookieFrequencyCap()
Desired cookie frequency cap that will 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. Please use cookie_frequency_cap_setting instead.
optional int32 cookie_frequency_cap = 10;- Specified by:
getCookieFrequencyCapin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- The cookieFrequencyCap.
-
setCookieFrequencyCap
public GenerateReachForecastRequest.Builder setCookieFrequencyCap(int value)
Desired cookie frequency cap that will 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. Please 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()
Desired cookie frequency cap that will 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. Please use cookie_frequency_cap_setting instead.
optional int32 cookie_frequency_cap = 10;- Returns:
- This builder for chaining.
-
hasCookieFrequencyCapSetting
public boolean hasCookieFrequencyCapSetting()
Desired cookie frequency cap that will 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.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;- Specified by:
hasCookieFrequencyCapSettingin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- Whether the cookieFrequencyCapSetting field is set.
-
getCookieFrequencyCapSetting
public FrequencyCap getCookieFrequencyCapSetting()
Desired cookie frequency cap that will 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.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;- Specified by:
getCookieFrequencyCapSettingin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- The cookieFrequencyCapSetting.
-
setCookieFrequencyCapSetting
public GenerateReachForecastRequest.Builder setCookieFrequencyCapSetting(FrequencyCap value)
Desired cookie frequency cap that will 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.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;
-
setCookieFrequencyCapSetting
public GenerateReachForecastRequest.Builder setCookieFrequencyCapSetting(FrequencyCap.Builder builderForValue)
Desired cookie frequency cap that will 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.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;
-
mergeCookieFrequencyCapSetting
public GenerateReachForecastRequest.Builder mergeCookieFrequencyCapSetting(FrequencyCap value)
Desired cookie frequency cap that will 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.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;
-
clearCookieFrequencyCapSetting
public GenerateReachForecastRequest.Builder clearCookieFrequencyCapSetting()
Desired cookie frequency cap that will 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.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;
-
getCookieFrequencyCapSettingBuilder
public FrequencyCap.Builder getCookieFrequencyCapSettingBuilder()
Desired cookie frequency cap that will 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.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;
-
getCookieFrequencyCapSettingOrBuilder
public FrequencyCapOrBuilder getCookieFrequencyCapSettingOrBuilder()
Desired cookie frequency cap that will 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.v10.services.FrequencyCap cookie_frequency_cap_setting = 8;- Specified by:
getCookieFrequencyCapSettingOrBuilderin interfaceGenerateReachForecastRequestOrBuilder
-
hasMinEffectiveFrequency
public boolean hasMinEffectiveFrequency()
Desired 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:
hasMinEffectiveFrequencyin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- Whether the minEffectiveFrequency field is set.
-
getMinEffectiveFrequency
public int getMinEffectiveFrequency()
Desired 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:
getMinEffectiveFrequencyin interfaceGenerateReachForecastRequestOrBuilder- Returns:
- The minEffectiveFrequency.
-
setMinEffectiveFrequency
public GenerateReachForecastRequest.Builder setMinEffectiveFrequency(int value)
Desired 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()
Desired 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.v10.services.EffectiveFrequencyLimit effective_frequency_limit = 12;- Specified by:
hasEffectiveFrequencyLimitin interfaceGenerateReachForecastRequestOrBuilder- 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.v10.services.EffectiveFrequencyLimit effective_frequency_limit = 12;- Specified by:
getEffectiveFrequencyLimitin interfaceGenerateReachForecastRequestOrBuilder- 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.v10.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.v10.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.v10.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.v10.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.v10.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.v10.services.EffectiveFrequencyLimit effective_frequency_limit = 12;- Specified by:
getEffectiveFrequencyLimitOrBuilderin interfaceGenerateReachForecastRequestOrBuilder
-
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, please consult an implementation specialist. See specific metrics for details on how targeting affects them.
.google.ads.googleads.v10.services.Targeting targeting = 6;- Specified by:
hasTargetingin interfaceGenerateReachForecastRequestOrBuilder- 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, please consult an implementation specialist. See specific metrics for details on how targeting affects them.
.google.ads.googleads.v10.services.Targeting targeting = 6;- Specified by:
getTargetingin interfaceGenerateReachForecastRequestOrBuilder- 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, please consult an implementation specialist. See specific metrics for details on how targeting affects them.
.google.ads.googleads.v10.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, please consult an implementation specialist. See specific metrics for details on how targeting affects them.
.google.ads.googleads.v10.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, please consult an implementation specialist. See specific metrics for details on how targeting affects them.
.google.ads.googleads.v10.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, please consult an implementation specialist. See specific metrics for details on how targeting affects them.
.google.ads.googleads.v10.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, please consult an implementation specialist. See specific metrics for details on how targeting affects them.
.google.ads.googleads.v10.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, please consult an implementation specialist. See specific metrics for details on how targeting affects them.
.google.ads.googleads.v10.services.Targeting targeting = 6;- Specified by:
getTargetingOrBuilderin interfaceGenerateReachForecastRequestOrBuilder
-
getPlannedProductsList
public java.util.List<PlannedProduct> getPlannedProductsList()
Required. The products to be forecast. The max number of allowed planned products is 15.
repeated .google.ads.googleads.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getPlannedProductsListin interfaceGenerateReachForecastRequestOrBuilder
-
getPlannedProductsCount
public int getPlannedProductsCount()
Required. The products to be forecast. The max number of allowed planned products is 15.
repeated .google.ads.googleads.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getPlannedProductsCountin interfaceGenerateReachForecastRequestOrBuilder
-
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.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getPlannedProductsin interfaceGenerateReachForecastRequestOrBuilder
-
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.v10.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.v10.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.v10.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.v10.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.v10.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.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
-
addAllPlannedProducts
public GenerateReachForecastRequest.Builder addAllPlannedProducts(java.lang.Iterable<? extends PlannedProduct> values)
Required. The products to be forecast. The max number of allowed planned products is 15.
repeated .google.ads.googleads.v10.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.v10.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.v10.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.v10.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.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getPlannedProductsOrBuilderin interfaceGenerateReachForecastRequestOrBuilder
-
getPlannedProductsOrBuilderList
public java.util.List<? extends PlannedProductOrBuilder> getPlannedProductsOrBuilderList()
Required. The products to be forecast. The max number of allowed planned products is 15.
repeated .google.ads.googleads.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getPlannedProductsOrBuilderListin interfaceGenerateReachForecastRequestOrBuilder
-
addPlannedProductsBuilder
public PlannedProduct.Builder addPlannedProductsBuilder()
Required. The products to be forecast. The max number of allowed planned products is 15.
repeated .google.ads.googleads.v10.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.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
-
getPlannedProductsBuilderList
public java.util.List<PlannedProduct.Builder> getPlannedProductsBuilderList()
Required. The products to be forecast. The max number of allowed planned products is 15.
repeated .google.ads.googleads.v10.services.PlannedProduct planned_products = 7 [(.google.api.field_behavior) = REQUIRED];
-
setUnknownFields
public final GenerateReachForecastRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
mergeUnknownFields
public final GenerateReachForecastRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<GenerateReachForecastRequest.Builder>
-
-