Method: bidders.auctionPackages.list
Stay organized with collections
Save and categorize content based on your preferences.
List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/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/v1alpha/{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
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 \u003ccode\u003eListAuctionPackages\u003c/code\u003e method to retrieve a list of auction packages accessible by a buyer or bidder account.\u003c/p\u003e\n"],["\u003cp\u003eSpecify the parent buyer or bidder using the \u003ccode\u003eparent\u003c/code\u003e path parameter in the format \u003ccode\u003ebuyers/{accountId}\u003c/code\u003e or \u003ccode\u003ebidders/{accountId}\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eUtilize query parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, and \u003ccode\u003eorderBy\u003c/code\u003e to refine and organize the list of auction packages.\u003c/p\u003e\n"],["\u003cp\u003eBuyers and bidders have different levels of access to auction package information based on their roles and relationships with clients.\u003c/p\u003e\n"],["\u003cp\u003eProper authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e scope is required to access this functionality.\u003c/p\u003e\n"]]],["Buyers and bidders can list auction packages using the `GET` method with specific URL paths: `/v1alpha/buyers/{accountId}/auctionPackages` or `/v1alpha/bidders/{accountId}/auctionPackages`. The request URL includes a `parent` path parameter specifying the account. Optional query parameters are `pageSize`, `pageToken`, `filter`, and `orderBy`. The request body should be empty. A successful response returns a `ListAuctionPackagesResponse`. Access requires the `authorized-buyers-marketplace` OAuth scope.\n"],null,["# Method: bidders.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 \"/v1alpha/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/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/v1alpha/{parent=bidders/*}/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/v1alpha/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/v1alpha/ListAuctionPackagesResponse).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
