Method: orders.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of orders, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/projects/{projectId}/orders
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
profileId |
string (int64 format)
User profile ID associated with this request.
|
projectId |
string (int64 format)
Project ID for orders.
|
Query parameters
Parameters |
ids[] |
string (int64 format)
Select only orders with these IDs.
|
searchString |
string
Allows searching for orders by name or ID. Wildcards (
*
) are allowed. For example,
"order*2015"
will return orders with names like
"order June 2015"
,
"order April 2015"
, or simply
"order 2015"
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
"order"
will match orders with name
"my order"
,
"order 2015"
, or simply
"order"
.
|
maxResults |
integer
Maximum number of results to return.
|
pageToken |
string
Value of the
nextPageToken
from the previous result page.
|
siteId[] |
string (int64 format)
Select only orders that are associated with these site IDs.
|
sortField |
enum (SortField )
Field by which to sort the list.
|
sortOrder |
enum (SortOrder )
Order of sorted results.
|
Request body
The request body must be empty.
Response body
Order orders.list Response
If successful, the response body contains data with the following structure:
JSON representation |
{
"kind": string,
"nextPageToken": string,
"orders": [
{
object (Order )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#ordersListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
orders[] |
object (Order )
Order collection.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
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-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eRetrieves a list of orders, potentially filtered, and supports paging for result navigation.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering by order IDs, searching by name or ID, and limiting the maximum number of results.\u003c/p\u003e\n"],["\u003cp\u003eEnables sorting the list based on specific fields and sorting orders.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003edfatrafficking\u003c/code\u003e scope for access.\u003c/p\u003e\n"],["\u003cp\u003eProvides a response containing order details and pagination information for subsequent requests.\u003c/p\u003e\n"]]],[],null,["# Method: 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.OrdersListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of orders, possibly filtered. This method supports [paging](/doubleclick-advertisers/trafficking_tasks#list).\n\n### HTTP request\n\n`GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/projects/{projectId}/orders`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profile``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n| `project``Id` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Project ID for orders. |\n\n### Query parameters\n\n| Parameters ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only orders with these IDs. |\n| `search``String` | `string` Allows searching for orders by name or ID. Wildcards ( `*` ) are allowed. For example, `\"order*2015\"` will return orders with names like `\"order June 2015\"` , `\"order April 2015\"` , or simply `\"order 2015\"` . Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of `\"order\"` will match orders with name `\"my order\"` , `\"order 2015\"` , or simply `\"order\"` . |\n| `max``Results` | `integer` Maximum number of results to return. |\n| `page``Token` | `string` Value of the `nextPageToken` from the previous result page. |\n| `site``Id[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only orders that are associated with these site IDs. |\n| `sort``Field` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/SortField)`)` Field by which to sort the list. |\n| `sort``Order` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nOrder orders.list Response\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"orders\": [ { object (/doubleclick-advertisers/rest/v4/orders#Order) } ] } ``` |\n\n| Fields ||\n|---------------------|------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#ordersListResponse\"` . |\n| `next``Page``Token` | `string` Pagination token to be used for the next list operation. |\n| `orders[]` | `object (`[Order](/doubleclick-advertisers/rest/v4/orders#Order)`)` Order collection. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`"]]