Method: orders.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists orders.
- For example GET /v1beta1/orders
HTTP request
GET https://dv360outofhomeseller.googleapis.com/v1beta1/orders
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageSize |
integer
The maximum number of items to return.
|
pageToken |
string
The nextPageToken value returned from a previous List request, if any.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"orders": [
{
object (Order)
}
],
"nextPageToken": string
} |
| Fields |
orders[] |
object (Order)
The list of orders.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to orders.list method to retrieve the next page of results.
|
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 2024-09-18 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 2024-09-18 UTC."],[[["\u003cp\u003eLists existing orders, including details like order ID and other relevant information.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large sets of orders using \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e.\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 a list of orders and a token for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eThe API utilizes a standard HTTP GET request to the specified endpoint.\u003c/p\u003e\n"]]],[],null,["- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListOrdersResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Examples](#examples)\n\nLists orders.\n\n- For example GET /v1beta1/orders\n\nHTTP request\n\n`GET https://dv360outofhomeseller.googleapis.com/v1beta1/orders`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nQuery parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of items to return. |\n| `pageToken` | `string` The nextPageToken value returned from a previous List request, if any. |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"orders\": [ { object (/display-video/out-of-home-seller/reference/rest/v1beta1/orders#Order) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `orders[]` | `object (`[Order](/display-video/out-of-home-seller/reference/rest/v1beta1/orders#Order)`)` The list of orders. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/out-of-home-seller/reference/rest/v1beta1/orders/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `orders.list` method to retrieve the next page of results. |\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](https://developers.google.com/identity/protocols/OAuth2)."]]
