Method: networks.orders.list
Stay organized with collections
Save and categorize content based on your preferences.
API to retrieve a list of Order objects.
Fields used for literal matching in filter string: * orderId * displayName * externalOrderId
HTTP request
GET https://admanager.googleapis.com/v1/{parent}/orders
Path parameters
| Parameters |
parent |
string
Required. The parent, which owns this collection of Orders. Format: networks/{networkCode}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of Orders to return. The service may return fewer than this value. If unspecified, at most 50 Orders will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
|
pageToken |
string
Optional. A page token, received from a previous orders.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to orders.list must match the call that provided the page token.
|
filter |
string
Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
|
orderBy |
string
Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
|
skip |
integer
Optional. Number of individual resources to skip while paginating.
|
Request body
The request body must be empty.
Response body
Response object for ListOrdersRequest containing matching Order resources.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"orders": [
{
object (Order)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Fields |
orders[] |
object (Order)
The Order from the specified network.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
totalSize |
integer
Total number of Orders. If a filter was included in the request, this reflects the total number after the filtering is applied. totalSize will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter $fields or fields, or by using the HTTP/gRPC header X-Goog-FieldMask.
For more information, see https://developers.google.com/ad-manager/api/beta/field-masks
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/admanager
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-08-20 UTC.
[null,null,["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eRetrieves a list of \u003ccode\u003eOrder\u003c/code\u003e objects, allowing filtering and sorting options.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request with required \u003ccode\u003eparent\u003c/code\u003e path parameter specifying the network.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters to navigate through results.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes an array of \u003ccode\u003eOrder\u003c/code\u003e objects, a token for retrieving the next page, and the total result size.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/admanager\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This API retrieves a list of `Order` objects via a `GET` request to `https://admanager.googleapis.com/v1/{parent}/orders`, where `parent` is a required path parameter. Optional query parameters include `pageSize` (max 1000), `pageToken`, `filter`, `orderBy`, and `skip`. The request body must be empty. The response includes an array of `Order` objects, `nextPageToken` for pagination, and `totalSize`, which represents the total number of orders. The request requires `https://www.googleapis.com/auth/admanager` authorization scope.\n"],null,["# Method: networks.orders.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.ListOrdersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nAPI to retrieve a list of `Order` objects.\n\nFields used for literal matching in filter string: \\* `orderId` \\* `displayName` \\* `externalOrderId`\n\n### HTTP request\n\n`GET https://admanager.googleapis.com/v1/{parent}/orders`\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent, which owns this collection of Orders. Format: `networks/{networkCode}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of `Orders` to return. The service may return fewer than this value. If unspecified, at most 50 `Orders` will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |\n| `pageToken` | `string` Optional. A page token, received from a previous `orders.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `orders.list` must match the call that provided the page token. |\n| `filter` | `string` Optional. Expression to filter the response. See syntax details at \u003chttps://developers.google.com/ad-manager/api/beta/filters\u003e |\n| `orderBy` | `string` Optional. Expression to specify sorting order. See syntax details at \u003chttps://developers.google.com/ad-manager/api/beta/filters#order\u003e |\n| `skip` | `integer` Optional. Number of individual resources to skip while paginating. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse object for `ListOrdersRequest` containing matching `Order` resources.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"orders\": [ { object (/ad-manager/api/beta/reference/rest/v1/networks.orders#Order) } ], \"nextPageToken\": string, \"totalSize\": integer } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `orders[]` | `object (`[Order](/ad-manager/api/beta/reference/rest/v1/networks.orders#Order)`)` The `Order` from the specified network. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n| `totalSize` | `integer` Total number of `Orders`. If a filter was included in the request, this reflects the total number after the filtering is applied. `totalSize` will not be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter `$fields` or `fields`, or by using the HTTP/gRPC header `X-Goog-FieldMask`. For more information, see \u003chttps://developers.google.com/ad-manager/api/beta/field-masks\u003e |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/admanager`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
