Method: accounts.finalizedProposals.pause
Stay organized with collections
Save and categorize content based on your preferences.
Update given deals to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint.
It is a no-op to pause already-paused deals. It is an error to call finalizedProposals.pause for deals which are not part of the proposal of proposalId or which are not finalized or renegotiating.
HTTP request
POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
accountId |
string
Account ID of the buyer.
|
proposalId |
string
The proposalId of the proposal containing the deals.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"externalDealIds": [
string
],
"reason": string
} |
| Fields |
externalDealIds[] |
string
The externalDealId's of the deals to be paused. If empty, all the deals in the proposal will be paused.
|
reason |
string
The reason why the deals are being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.)
|
Response body
If successful, the response body contains an instance of Proposal.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adexchange.buyer
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\u003eUpdate given deals to pause serving for PG and PD deals, setting \u003ccode\u003eDealServingMetadata.DealPauseStatus.has_buyer_paused\u003c/code\u003e to true.\u003c/p\u003e\n"],["\u003cp\u003eFor PA deals, use \u003ccode\u003eaccounts.proposals.pause\u003c/code\u003e endpoint instead.\u003c/p\u003e\n"],["\u003cp\u003eThis request is a no-op for already-paused deals and throws an error for invalid proposalId or deal status.\u003c/p\u003e\n"],["\u003cp\u003eThe request body includes lists of \u003ccode\u003eexternalDealIds\u003c/code\u003e to pause and a \u003ccode\u003ereason\u003c/code\u003e for pausing.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.finalizedProposals.pause\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdate given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint.\n\nIt is a no-op to pause already-paused deals. It is an error to call finalizedProposals.pause for deals which are not part of the proposal of proposalId or which are not finalized or renegotiating.\n\n### HTTP request\n\n`POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------------|---------------------------------------------------------------|\n| `accountId` | `string` Account ID of the buyer. |\n| `proposalId` | `string` The proposalId of the proposal containing the deals. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|-------------------------------------------------------------|---|\n| ``` { \"externalDealIds\": [ string ], \"reason\": string } ``` |\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `externalDealIds[]` | `string` The externalDealId's of the deals to be paused. If empty, all the deals in the proposal will be paused. |\n| `reason` | `string` The reason why the deals are being paused. This human readable message will be displayed in the seller's UI. (Max length: 1000 unicode code units.) |\n\n### Response body\n\nIf successful, the response body contains an instance of [Proposal](/authorized-buyers/apis/reference/rest/v2beta1/accounts.proposals#Proposal).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adexchange.buyer`"]]
