Method: accounts.proposals.pause

  • This method pauses serving for all deals within a proposal by setting DealServingMetadata.DealPauseStatus.has_buyer_paused to true.

  • Pausing an already-paused proposal has no effect, while attempting to pause a non-finalized or renegotiating proposal results in an error.

  • The HTTP request uses a POST method with specific accountId and proposalId path parameters to identify the proposal to be paused.

  • The request body requires a reason field (string) explaining why the proposal is being paused, which will be displayed in the seller's UI.

  • A successful response returns a Proposal instance, and the method requires the https://www.googleapis.com/auth/adexchange.buyer OAuth scope for authorization.

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