advertisers

POST /v4/advertisers/{advertisersId}/reachForecast:generateReachForecast

Generates a reach forecast for a given advertiser and targeting configuration. API support for generating reach forecasts and retrieving related metadata is in beta. This method is only available to allowlisted users.

Request

Base URL
https://displayvideo.googleapis.com
Auth
OAuth 2 and OAuth 2
Implicithttps://accounts.google.com/o/oauth2/auth
Scopeshttps://www.googleapis.com/auth/display-video
Authorization codehttps://accounts.google.com/o/oauth2/auth
Token URLhttps://accounts.google.com/o/oauth2/token
Scopeshttps://www.googleapis.com/auth/display-video
TypeScript
https://skmtc.dev/google/apis/displayvideo/docs/v4/advertisers/:advertisersId/reachForecast:generateReachForecast/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

advertisersIdstring required

Request body

currencyCodestring

Required. The currency code for the plan in ISO 4217 format.

minEffectiveFrequencyinteger

Optional. The minimum effective frequency for the reported reach metrics. This is the smallest number of times a customer must be exposed to the ad for it to be considered effective. This setting only impacts reporting. Must be between 1 and 10, inclusive. If not specified, a default of 1 is applied.

Response

Successful response

Changes

No recorded changes to this operation across all 7 revisions of this API.