GenerateReachForecastRequest

customer_id

string

Required. The ID of the customer.

campaign_duration

CampaignDuration

Required. Campaign duration.

cookie_frequency_cap_setting

FrequencyCap

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.

targeting

Targeting

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.

planned_products[]

PlannedProduct

Required. The products to be forecast. The max number of allowed planned products is 15.

forecast_metric_options

ForecastMetricOptions

Controls the forecast metrics returned in the response.

reach_application_info

AdditionalApplicationInfo

Optional. Additional information on the application issuing the request.

currency_code

string

The currency code. Three-character ISO 4217 currency code.

cookie_frequency_cap

int32

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.

min_effective_frequency

int32

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.

effective_frequency_limit

EffectiveFrequencyLimit

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.

customer_reach_group

string

The name of the customer being planned for. This is a user-defined value.