Method: buyers.auctionPackages.subscribeClients
Stay organized with collections
Save and categorize content based on your preferences.
Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.
HTTP request
POST https://authorizedbuyersmarketplace.googleapis.com/v1/{auctionPackage=buyers/*/auctionPackages/*}:subscribeClients
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 subscribe to the auction package, with client buyer in the format buyers/{accountId}/clients/{clientAccountId}. The current buyer will be subscribed to the auction package regardless of the list contents if not already.
|
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\u003eSubscribe specified client buyers to an auction package using the provided endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe request must specify the auction package using its resource name and can include a list of client buyers to subscribe.\u003c/p\u003e\n"],["\u003cp\u003eIf successful, the response will contain the updated AuctionPackage object.\u003c/p\u003e\n"],["\u003cp\u003eThis operation requires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUnsuccessful subscription of a client in the provided list will halt further processing and result in an error response.\u003c/p\u003e\n"]]],[],null,["# Method: buyers.auctionPackages.subscribeClients\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\nSubscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.\n\n### HTTP request\n\n`POST https://authorizedbuyersmarketplace.googleapis.com/v1/{auctionPackage=buyers/*/auctionPackages/*}:subscribeClients`\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 subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already. |\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`"]]
