Method: buyers.auctionPackages.subscribeClients

  • Subscribe specified client buyers to an auction package using the provided endpoint.

  • The request must specify the auction package using its resource name and can include a list of client buyers to subscribe.

  • If successful, the response will contain the updated AuctionPackage object.

  • This operation requires authorization with the https://www.googleapis.com/auth/authorized-buyers-marketplace scope.

  • Unsuccessful subscription of a client in the provided list will halt further processing and result in an error response.

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