Method: buyers.auctionPackages.unsubscribeClients

  • This endpoint enables unsubscribing specified clients from a given auction package within the Authorized Buyers Marketplace.

  • The request requires specifying the auction package and a list of clients to unsubscribe, using their respective resource names.

  • A successful response returns the updated AuctionPackage object reflecting the changes.

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

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/v1/{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