Method: buyers.finalizedDeals.setReadyToServe
Stay organized with collections
Save and categorize content based on your preferences.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eProgrammatic Guaranteed deals are automatically set to serve once finalized, but this endpoint allows publishers to manually control when they start serving.\u003c/p\u003e\n"],["\u003cp\u003eThis endpoint enables publishers to delay serving finalized deals until they're fully prepared, such as having creatives ready.\u003c/p\u003e\n"],["\u003cp\u003eTo use this feature, publishers need to be on an allowlist and call \u003ccode\u003esetReadyToServe\u003c/code\u003e before finalized deals belonging to them and their child seats will start serving.\u003c/p\u003e\n"],["\u003cp\u003eThe request is sent as an empty \u003ccode\u003ePOST\u003c/code\u003e request to a specific URL containing the buyer and finalized deal IDs.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful calls will return the \u003ccode\u003eFinalizedDeal\u003c/code\u003e object and require the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details the `setReadyToServe` method for programmatic guaranteed deals. It allows delaying bid requests until deals are manually marked as ready, which is an optional behavior. To use this option, the user needs to contact his account manager. The method is a POST request to a specific URL that uses gRPC Transcoding syntax, and it needs a deal identifier in the path. An empty request body should be sent and it requires a specific OAuth scope. The response body is an instance of `FinalizedDeal`.\n"],null,["# Method: buyers.finalizedDeals.setReadyToServe\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nSets the given finalized deal as ready to serve.\n\nBy 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.\n\nIf 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.\n\nThis method only applies to programmatic guaranteed deals.\n\n### HTTP request\n\n`POST https://authorizedbuyersmarketplace.googleapis.com/v1/{deal=buyers/*/finalizedDeals/*}:setReadyToServe`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------|\n| `deal` | `string` Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [FinalizedDeal](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.finalizedDeals#FinalizedDeal).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
