Method: buyers.finalizedDeals.pause

  • Pauses the serving status of a finalized programmatic guaranteed or preferred deal without affecting other deal attributes.

  • To pause, send a POST request to the specified URL, including the buyer and deal IDs in the path.

  • The request body can optionally include a reason for pausing, which will be visible to the seller.

  • A successful response will return the updated FinalizedDeal object.

  • This functionality requires the https://www.googleapis.com/auth/authorized-buyers-marketplace OAuth scope.

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.

HTTP request

POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{name=buyers/*/finalizedDeals/*}:pause

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Format: buyers/{accountId}/finalizedDeals/{dealId}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "reason": string
}
Fields
reason

string

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

Response body

If successful, the response body contains an instance of FinalizedDeal.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/authorized-buyers-marketplace