Method: accounts.proposals.pause

  • This method pauses serving for all deals in the given proposal by setting the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true.

  • It only works on finalized proposals and is a no-op if the proposal is already paused.

  • The request requires the account ID, proposal ID, and an optional reason for pausing displayed to the seller.

  • Successful execution returns the updated Proposal object.

  • Requires authorization with the https://www.googleapis.com/auth/adexchange.buyer scope.

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