Method: buyers.auctionPackages.subscribeClients

  • This documentation describes how to subscribe specified clients of a buyer to an auction package using a POST request to the Google Authorized Buyers Marketplace API.

  • The request requires an auctionPackage path parameter in the format buyers/{accountId}/auctionPackages/{auctionPackageId}.

  • The request body contains an optional list of clients in the format buyers/{accountId}/clients/{clientAccountId} to subscribe to the auction package.

  • The response body, if successful, will contain an instance of AuctionPackage.

  • This action requires the https://www.googleapis.com/auth/authorized-buyers-marketplace OAuth scope for authorization.

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