Method: exchanges.auctionPackages.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*}/auctionPackages
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The parent resource name. Example: "exchanges/123". Required.
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of items to return. Max allowed value is 50. If unspecified or more than 50, will use 50 as page size.
|
pageToken |
string
The nextPageToken value returned from a previous List request, if any.
|
filter |
string
Allows filtering by properties. Supported syntax:
- Filter expressions are made up of one or more restrictions.
- Restrictions can be combined by
AND or OR logical operators. A sequence of restrictions implicitly uses AND.
- A restriction has the form of
<field> <operator> <value>.
- The operator must be
EQUALS (=).
- Currently supported fields:
Examples:
- Get Auction Packages with externalDealId set to "package-1234"
externalDealId="package-1234"
The length of this field should be no more than 500 characters.
|
Request body
The request body must be empty.
Response body
Response to list auction packages.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"auctionPackage": [
{
object (AuctionPackage)
}
],
"nextPageToken": string
} |
| Fields |
auctionPackage[] |
object (AuctionPackage)
Listed auction packages. There will be a maximum number of items returned based on the pageSize field in the request.
|
nextPageToken |
string
Token to retrieve the next page of results, or empty if there are no more results in the list.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/doubleclickbidmanager
For more information, see the OAuth 2.0 Overview.
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-05-21 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-21 UTC."],[[["\u003cp\u003eLists auction packages associated with a given exchange using the \u003ccode\u003eexchanges.auctionPackages.list\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by \u003ccode\u003eexternalDealId\u003c/code\u003e using the \u003ccode\u003efilter\u003c/code\u003e query parameter with a maximum length of 500 characters.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters for retrieving large result sets.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/doubleclickbidmanager\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of \u003ccode\u003eAuctionPackage\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e for further navigation.\u003c/p\u003e\n"]]],["This document details how to list auction packages using a `GET` request to the specified URL. The `parent` path parameter is required, and `pageSize`, `pageToken`, and `filter` are optional query parameters. The request body must be empty. The response includes a list of `auctionPackage` objects and a `nextPageToken` for pagination. Authorization requires the `https://www.googleapis.com/auth/doubleclickbidmanager` OAuth scope. The filter parameter allows using `externalDealId` to find specific packages.\n"],null,["# Method: exchanges.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 - [JSON representation](#body.ListAuctionPackageResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nLists auction packages.\n\n### HTTP request\n\n`GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*}/auctionPackages`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------|\n| `parent` | `string` The parent resource name. Example: \"exchanges/123\". Required. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of items to return. Max allowed value is 50. If unspecified or more than 50, will use 50 as page size. |\n| `pageToken` | `string` The nextPageToken value returned from a previous List request, if any. |\n| `filter` | `string` Allows filtering by properties. Supported syntax: - Filter expressions are made up of one or more restrictions. - Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. - A restriction has the form of `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e`. - The operator must be `EQUALS (=)`. - Currently supported fields: - `externalDealId` Examples: - Get Auction Packages with externalDealId set to \"package-1234\" `externalDealId=\"package-1234\"` The length of this field should be no more than 500 characters. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse to list auction packages.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"auctionPackage\": [ { object (/display-video/seller/reference/rest/v1beta1/exchanges.auctionPackages#AuctionPackage) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `auctionPackage[]` | `object (`[AuctionPackage](/display-video/seller/reference/rest/v1beta1/exchanges.auctionPackages#AuctionPackage)`)` Listed auction packages. There will be a maximum number of items returned based on the pageSize field in the request. |\n| `nextPageToken` | `string` Token to retrieve the next page of results, or empty if there are no more results in the list. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/doubleclickbidmanager`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
