advertisers

Changed on

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.

post/v4/advertisers/{+advertiserId}/reachForecast:generateReachForecast

Request

  • Base URL: https://displayvideo.googleapis.com
  • URL: https://displayvideo.googleapis.com/v4/advertisers/{+advertiserId}/reachForecast:generateReachForecast
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/display-video) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/display-video)

Path parameters

advertiserIdstring required

Required. The ID of the advertiser that will run the planned campaign.

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

  • 52cdb4885336Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

  • 0f73dc785c76Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status