Method: buyers.finalizedDeals.setReadyToServe

  • Programmatic Guaranteed deals are automatically set to serve once finalized, but this endpoint allows publishers to manually control when they start serving.

  • This endpoint enables publishers to delay serving finalized deals until they're fully prepared, such as having creatives ready.

  • To use this feature, publishers need to be on an allowlist and call setReadyToServe before finalized deals belonging to them and their child seats will start serving.

  • The request is sent as an empty POST request to a specific URL containing the buyer and finalized deal IDs.

  • Successful calls will return the FinalizedDeal object and require the https://www.googleapis.com/auth/authorized-buyers-marketplace OAuth 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/v1/{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