Method: buyers.finalizedDeals.setReadyToServe

  • The setReadyToServe method sets a given finalized deal as ready to serve, and it only applies to programmatic guaranteed deals.

  • By default, finalized deals are ready to serve immediately, but you can opt-out to manually control this process by asking your Technical Account Manager.

  • If you manually control the ready-to-serve status, finalized deals for the bidder and its child seats won't start serving until you call setReadyToServe and the deals become active.

  • The HTTP request uses a POST method to the specified URL, requiring the deal path parameter.

  • The request body must be empty, and a successful response contains an instance of FinalizedDeal.

  • Using this method requires the https://www.googleapis.com/auth/authorized-buyers-marketplace authorization scope.

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.

This method only applies to programmatic guaranteed deals.

HTTP request

POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{deal=buyers/*/finalizedDeals/*}:setReadyToServe

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
deal

string

Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of FinalizedDeal.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/authorized-buyers-marketplace