Method: buyers.auctionPackages.list
Stay organized with collections
Save and categorize content based on your preferences.
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=buyers/*}/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
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-06-12 UTC.
[null,null,["Last updated 2025-06-12 UTC."],[[["\u003cp\u003eUse the API to retrieve and list available auction packages for buyers and bidders.\u003c/p\u003e\n"],["\u003cp\u003eFilter and sort auction packages by various criteria such as display name, creation time and eligible seat IDs.\u003c/p\u003e\n"],["\u003cp\u003eAccess auction packages using specific URL paths based on user role (buyer or bidder).\u003c/p\u003e\n"],["\u003cp\u003eSpecify pagination using page size and page tokens to navigate through large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["Buyers and bidders can list auction packages using the `GET` HTTP request to the specified URLs, differing by whether the parent is a buyer or a bidder account. The request requires a `parent` path parameter, formatted as `buyers/{accountId}` or `bidders/{accountId}`. Optional query parameters include `pageSize`, `pageToken`, `filter` and `orderBy`, for pagination, filtering, and sorting respectively, only applicable for bidders. The request body is empty, and a successful response contains a `ListAuctionPackagesResponse`. Requires `https://www.googleapis.com/auth/authorized-buyers-marketplace` authorization scope.\n"],null,["# Method: buyers.auctionPackages.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList 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.\n\n### HTTP request\n\n`GET https://authorizedbuyersmarketplace.googleapis.com/v1/{parent=buyers/*}/auctionPackages`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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}`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. The server may return fewer results than requested. Max allowed page size is 500. |\n| `pageToken` | `string` The page token as returned. [ListAuctionPackagesResponse.nextPageToken](/authorized-buyers/apis/marketplace/reference/rest/v1/ListAuctionPackagesResponse#FIELDS.next_page_token) |\n| `filter` | `string` Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: - displayName - createTime - updateTime - eligibleSeatIds |\n| `orderBy` | `string` Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). 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 |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ListAuctionPackagesResponse](/authorized-buyers/apis/marketplace/reference/rest/v1/ListAuctionPackagesResponse).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
