Method: exchanges.orders.products.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The parent resource name. Example: "exchanges/123/orders/456". Max 250 characters. 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 product 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 (=).
- Supported fields:
Examples:
- Get Products with external deal ID set to "12345" under an exchange.
externalDealId="12345"
Setting Order Id to '-' to apply filter on Products across all Orders. orders/-/products?filter=externalDealId="12345" 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 order.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"products": [
{
object (Product)
}
],
"nextPageToken": string
} |
| Fields |
products[] |
object (Product)
Listed products. 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 products associated with a specific order within an exchange using the Display & Video 360 Seller API.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering of products based on criteria like external deal ID.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large sets of products.\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\u003eProvides a JSON response containing an array of products and a token for retrieving subsequent pages.\u003c/p\u003e\n"]]],[],null,["- [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.ListProductsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n- [Try it!](#try-it)\n\nLists product.\n\nHTTP request\n\n`GET https://dv360seller.googleapis.com/v1beta1/{parent=exchanges/*/orders/*}/products`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------|\n| `parent` | `string` The parent resource name. Example: \"exchanges/123/orders/456\". Max 250 characters. Required. |\n\nQuery 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 product 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 (=)`. - Supported fields: - `externalDealId` Examples: - Get Products with external deal ID set to \"12345\" under an exchange. `externalDealId=\"12345\"` Setting Order Id to '-' to apply filter on Products across all Orders. orders/-/products?filter=externalDealId=\"12345\" The length of this field should be no more than 500 characters. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body Response to list order.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"products\": [ { object (/display-video/seller/reference/rest/v1beta1/exchanges.orders.products#Product) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `products[]` | `object (`[Product](/display-video/seller/reference/rest/v1beta1/exchanges.orders.products#Product)`)` Listed products. 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\nAuthorization 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)."]]
