Method: buyers.auctionPackages.subscribeClients
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/v1alpha/{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-01-06 UTC.
[null,null,["Last updated 2025-01-06 UTC."],[[["This endpoint enables subscribing specified clients of a buyer to a given auction package."],["It involves sending a POST request to a specific URL with the auction package name in the path."],["The request body includes an optional list of client buyers to subscribe, with the current buyer automatically included if not already."],["A successful response returns the AuctionPackage object."],["Authorization requires the `https://www.googleapis.com/auth/authorized-buyers-marketplace` scope."]]],["This API allows subscribing clients to an auction package. A POST request is sent to `https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{auctionPackage=buyers/*/auctionPackages/*}:subscribeClients` with the required `auctionPackage` path parameter. The request body contains a JSON array of `clients` (client buyer identifiers in the format `buyers/{accountId}/clients/{clientAccountId}`). If successful, an `AuctionPackage` instance is returned. An error response occurs if a client does not belong to the buyer. Authorization requires the `authorized-buyers-marketplace` OAuth scope.\n"]]
