Method: accounts.proposals.pause
Stay organized with collections
Save and categorize content based on your preferences.
Update the given proposal to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all deals in the proposal.
It is a no-op to pause an already-paused proposal. It is an error to call proposals.pause for a proposal that is not finalized or renegotiating.
HTTP request
POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/proposals/{proposalId}:pause
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
accountId |
string
Account ID of the buyer.
|
proposalId |
string
The ID of the proposal to pause.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"reason": string
} |
| Fields |
reason |
string
The reason why the proposal is 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\u003eThis method pauses serving for all deals in the given proposal by setting the \u003ccode\u003eDealServingMetadata.DealPauseStatus.has_buyer_paused\u003c/code\u003e bit to true.\u003c/p\u003e\n"],["\u003cp\u003eIt only works on finalized proposals and is a no-op if the proposal is already paused.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the account ID, proposal ID, and an optional reason for pausing displayed to the seller.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful execution returns the updated \u003ca href=\"/authorized-buyers/apis/reference/rest/v2beta1/accounts.proposals#Proposal\"\u003eProposal\u003c/a\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.proposals.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 the given proposal to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all deals in the proposal.\n\nIt is a no-op to pause an already-paused proposal. It is an error to call proposals.pause for a proposal that is not finalized or renegotiating.\n\n### HTTP request\n\n`POST https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/proposals/{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 ID of the proposal to pause. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|------------------------------|---|\n| ``` { \"reason\": string } ``` |\n\n| Fields ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `reason` | `string` The reason why the proposal is 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`"]]
