Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131541,3491.5 MB
customers

Generates a reach forecast for a given targeting / product mix. List of thrown errors: AuthenticationError AuthorizationError FieldError HeaderError InternalError QuotaError RangeError ReachPlanError RequestError

post/v23/customers/{+customerId}:generateReachForecast

Path parameters

customerIdstring required

Required. The ID of the customer.

Request body

cookieFrequencyCapinteger

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.

currencyCodestring

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

minEffectiveFrequencyinteger

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.

customerReachGroupstring

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

Response

Successful response