Method: buyers.auctionPackages.unsubscribeClients
Stay organized with collections
Save and categorize content based on your preferences.
Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
HTTP request
POST https://authorizedbuyersmarketplace.googleapis.com/v1/{auctionPackage=buyers/*/auctionPackages/*}:unsubscribeClients
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
auctionPackage |
string
Required. Name of the auction package. Format: buyers/{accountId}/auctionPackages/{auctionPackageId}
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"clients": [
string
]
} |
| Fields |
clients[] |
string
Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format buyers/{accountId}/clients/{clientAccountId}.
|
Response body
If successful, the response body contains an instance of AuctionPackage.
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 2025-06-12 UTC.
[null,null,["Last updated 2025-06-12 UTC."],[[["\u003cp\u003eThis endpoint enables unsubscribing specified clients from a given auction package within the Authorized Buyers Marketplace.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the auction package and a list of clients to unsubscribe, using their respective resource names.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns the updated AuctionPackage object reflecting the changes.\u003c/p\u003e\n"],["\u003cp\u003eThe operation requires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This content describes unsubscribing clients from an auction package via an API. The `POST` request is sent to a specific URL including the auction package's ID, formatted as `buyers/*/auctionPackages/*`. The request body contains a JSON list of client IDs to unsubscribe, structured as `buyers/{accountId}/clients/{clientAccountId}`. Successful requests return an `AuctionPackage` instance. This process uses gRPC Transcoding and requires the `authorized-buyers-marketplace` OAuth scope.\n"],null,["# Method: buyers.auctionPackages.unsubscribeClients\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\nUnsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.\n\n### HTTP request\n\n`POST https://authorizedbuyersmarketplace.googleapis.com/v1/{auctionPackage=buyers/*/auctionPackages/*}:unsubscribeClients`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------------|-----------------------------------------------------------------------------------------------------------------|\n| `auctionPackage` | `string` Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------|\n| ``` { \"clients\": [ string ] } ``` |\n\n| Fields ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `clients[]` | `string` Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. |\n\n### Response body\n\nIf successful, the response body contains an instance of [AuctionPackage](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.auctionPackages#AuctionPackage).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
