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/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
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\u003eSets finalized programmatic guaranteed deals as ready to serve, enabling them to start receiving bid requests.\u003c/p\u003e\n"],["\u003cp\u003eBy default, deals are automatically ready to serve but this method provides manual control over the process.\u003c/p\u003e\n"],["\u003cp\u003eThis functionality requires prior allowlisting by Google and is triggered by a POST request to a specified endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request uses the \u003ccode\u003edeal\u003c/code\u003e path parameter to identify the specific finalized deal and does not require a request body.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful execution results in a response containing the \u003ccode\u003eFinalizedDeal\u003c/code\u003e object and requires specific authorization scopes.\u003c/p\u003e\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/v1alpha/{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/v1alpha/buyers.finalizedDeals#FinalizedDeal).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
