Method: buyers.finalizedDeals.pause
Stay organized with collections
Save and categorize content based on your preferences.
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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003ePauses the serving status of a finalized programmatic guaranteed or preferred deal without affecting other deal attributes.\u003c/p\u003e\n"],["\u003cp\u003eTo pause, send a POST request to the specified URL, including the buyer and deal IDs in the path.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can optionally include a reason for pausing, which will be visible to the seller.\u003c/p\u003e\n"],["\u003cp\u003eA successful response will return the updated FinalizedDeal object.\u003c/p\u003e\n"],["\u003cp\u003eThis functionality requires the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document outlines the process for pausing a finalized deal via an API. A `POST` request is sent to `https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{name=buyers/*/finalizedDeals/*}:pause`, using a required `name` path parameter in the format `buyers/{accountId}/finalizedDeals/{dealId}`. The request body includes a `reason` string field (max 1000 characters) explaining the pause. Successful requests return a `FinalizedDeal` instance and require the `https://www.googleapis.com/auth/authorized-buyers-marketplace` authorization scope. This only applies to programmatic guaranteed and preferred deals.\n"],null,["# Method: buyers.finalizedDeals.pause\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nPauses 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.\n\n### HTTP request\n\n`POST https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{name=buyers/*/finalizedDeals/*}:pause`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------|\n| `name` | `string` Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------|\n| ``` { \"reason\": string } ``` |\n\n| Fields ||\n|----------|----------------------------------------------------------------------------------------------------------------------|\n| `reason` | `string` The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters. |\n\n### Response body\n\nIf successful, the response body contains an instance of [FinalizedDeal](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.finalizedDeals#FinalizedDeal).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
