GOgoogle
buyers

POST /v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe

Changed on

Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call setReadyToServe, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. In addition, bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals/{dealId}" to set ready to serve for the finalized deals belong to itself, its child seats and all their clients. This method only applies to programmatic guaranteed deals.

Request

  • Base URL
    https://authorizedbuyersmarketplace.googleapis.com
  • URL
    https://authorizedbuyersmarketplace.googleapis.com/v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace

Path parameters

buyersIdstring required
finalizedDealsIdstring required

Request body

SetReadyToServeRequest required

Request message for setting ready to serve for a finalized deal.

Response

Successful response

dealServingStatus'DEAL_SERVING_STATUS_UNSPECIFIED' | 'ACTIVE' | 'ENDED' | 'PAUSED_BY_BUYER' | 'PAUSED_BY_SELLER'

Serving status of the deal.

namestring

The resource name of the finalized deal. Format: buyers/{accountId}/finalizedDeals/{finalizedDealId}

readyToServeboolean

Whether the Programmatic Guaranteed deal is ready for serving.

Changes