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/v1alpha/{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\u003eUnsubscribe one or more clients from a specified auction package.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the auction package name and a list of client buyer IDs to unsubscribe.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns the updated AuctionPackage object.\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"]]],["The core function is to unsubscribe clients from an auction package using a POST request to a specific URL. The request requires an `auctionPackage` path parameter identifying the package, and a JSON request body. The body includes an optional array named `clients`, specifying client buyers to unsubscribe. The server responds with an `AuctionPackage` instance upon success. The process requires OAuth scope `https://www.googleapis.com/auth/authorized-buyers-marketplace`. The HTTP request use the GRPC transcoding syntax.\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/v1alpha/{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/v1alpha/buyers.auctionPackages#AuctionPackage).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
