Method: bidders.auctionPackages.list

  • Use the API to retrieve and list available auction packages for buyers and bidders.

  • Buyers and bidders can access different sets of auction packages based on their roles and relationships with clients.

  • Filtering and sorting options are available for bidders to refine the list of auction packages.

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

List the auction packages. Buyers can use the URL path "/v1/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.

HTTP request

GET https://authorizedbuyersmarketplace.googleapis.com/v1/{parent=bidders/*}/auctionPackages

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the parent buyer that can access the auction package. Format: buyers/{accountId}. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format bidders/{accountId}.

Query parameters

Parameters
pageSize

integer

Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
pageToken

string

The page token as returned. ListAuctionPackagesResponse.nextPageToken
filter

string

Optional. Optional query string using the Cloud API list filtering syntax. Only supported when parent is bidder. Supported columns for filtering are:

  • displayName
  • createTime
  • updateTime
  • eligibleSeatIds
orderBy

string

Optional. An optional query string to sort auction packages using the Cloud API sorting syntax. If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are:

  • displayName
  • createTime
  • updateTime

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ListAuctionPackagesResponse.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/authorized-buyers-marketplace