GOgoogle
accounts

POST /v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause

Changed on

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 PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

Request

  • Base URL
    https://adexchangebuyer.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/adexchange.buyer
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/adexchange.buyer

Path parameters

accountIdstring required

Account ID of the buyer.

proposalIdstring required

The proposal_id of the proposal containing the deals.

Request body

externalDealIdsstring[]

The external_deal_id's of the deals to be paused. If empty, all the deals in the proposal will be paused.

reasonstring

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

Successful response

displayNamestring

The name for the proposal.

isRenegotiatingboolean

Output only. True if the proposal is being renegotiated.

isSetupCompleteboolean

Output only. True, if the buyside inventory setup is complete for this proposal.

lastUpdaterOrCommentorRole'BUYER_SELLER_ROLE_UNSPECIFIED' | 'BUYER' | 'SELLER'

Output only. The role of the last user that either updated the proposal or left a comment.

originatorRole'BUYER_SELLER_ROLE_UNSPECIFIED' | 'BUYER' | 'SELLER'

Output only. Indicates whether the buyer/seller created the proposal.

privateAuctionIdstring

Output only. Private auction ID if this proposal is a private auction proposal.

proposalIdstring

Output only. The unique ID of the proposal.

proposalRevisionstring int64

Output only. The revision number for the proposal. Each update to the proposal or the deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.

proposalState'PROPOSAL_STATE_UNSPECIFIED' | 'PROPOSED' | 'BUYER_ACCEPTED' | 'SELLER_ACCEPTED' | 'CANCELED' | 'FINALIZED'

Output only. The current state of the proposal.

termsAndConditionsstring

Output only. The terms and conditions set by the publisher for this proposal.

updateTimestring google-datetime

Output only. The time when the proposal was last revised.

Changes

  • af1a744df07bRevision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status