GOgoogle
buyers

POST /v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause

Changed on

Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.

Request

  • Base URL
    https://authorizedbuyersmarketplace.googleapis.com
  • URL
    https://authorizedbuyersmarketplace.googleapis.com/v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/authorized-buyers-marketplace

Path parameters

buyersIdstring required
finalizedDealsIdstring required

Request body

reasonstring

The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters.

Response

Successful response

dealServingStatus'DEAL_SERVING_STATUS_UNSPECIFIED' | 'ACTIVE' | 'ENDED' | 'PAUSED_BY_BUYER' | 'PAUSED_BY_SELLER'

Serving status of the deal.

namestring

The resource name of the finalized deal. Format: buyers/{accountId}/finalizedDeals/{finalizedDealId}

readyToServeboolean

Whether the Programmatic Guaranteed deal is ready for serving.

Changes