Method: orderDocuments.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of order documents, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v4/userprofiles/{profileId}/projects/{projectId}/orderDocuments
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 order documents.
|
Query parameters
Parameters |
ids[] |
string (int64 format)
Select only order documents with these IDs.
|
orderId[] |
string (int64 format)
Select only order documents for specified orders.
|
approved |
boolean
Select only order documents that have been approved by at least one user.
|
maxResults |
integer
Maximum number of results to return.
|
pageToken |
string
Value of the
nextPageToken
from the previous result page.
|
searchString |
string
Allows searching for order documents by name or ID. Wildcards (
*
) are allowed. For example,
"orderdocument*2015"
will return order documents with names like
"orderdocument June 2015"
,
"orderdocument April 2015"
, or simply
"orderdocument 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
"orderdocument"
will match order documents with name
"my orderdocument"
,
"orderdocument 2015"
, or simply
"orderdocument"
.
|
siteId[] |
string (int64 format)
Select only order documents that are associated with these sites.
|
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
If successful, the response body contains data with the following structure:
Order document accountPermissionGroups.list Response
JSON representation |
{
"kind": string,
"nextPageToken": string,
"orderDocuments": [
{
object (OrderDocument )
}
]
} |
Fields |
kind |
string
Identifies what kind of resource this is. Value: the fixed string
"dfareporting#orderDocumentsListResponse"
.
|
nextPageToken |
string
Pagination token to be used for the next list operation.
|
orderDocuments[] |
object (OrderDocument )
Order document collection
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
SortOrder
Enums |
ASCENDING |
|
DESCENDING |
|
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-19 UTC.
[null,null,["Last updated 2024-09-19 UTC."],[[["\u003cp\u003eRetrieves a list of order documents, with optional filtering by IDs, order IDs, approval status, sites, and search terms.\u003c/p\u003e\n"],["\u003cp\u003eSupports paging for handling large result sets, using \u003ccode\u003epageToken\u003c/code\u003e for navigation.\u003c/p\u003e\n"],["\u003cp\u003eAllows sorting the results by ID or name, in ascending or descending order.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003edfatrafficking\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of order documents along with pagination information.\u003c/p\u003e\n"]]],[],null,["# Method: orderDocuments.list\n\nRetrieves a list of order documents, 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}/orderDocuments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------|\n| `profileId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` User profile ID associated with this request. |\n| `projectId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Project ID for order documents. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ids[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only order documents with these IDs. |\n| `orderId[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only order documents for specified orders. |\n| `approved` | `boolean` Select only order documents that have been approved by at least one user. |\n| `maxResults` | `integer` Maximum number of results to return. |\n| `pageToken` | `string` Value of the `nextPageToken` from the previous result page. |\n| `searchString` | `string` Allows searching for order documents by name or ID. Wildcards ( `*` ) are allowed. For example, `\"orderdocument*2015\"` will return order documents with names like `\"orderdocument June 2015\"` , `\"orderdocument April 2015\"` , or simply `\"orderdocument 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 `\"orderdocument\"` will match order documents with name `\"my orderdocument\"` , `\"orderdocument 2015\"` , or simply `\"orderdocument\"` . |\n| `siteId[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Select only order documents that are associated with these sites. |\n| `sortField` | `enum (`[SortField](/doubleclick-advertisers/rest/v4/orderDocuments/list#SortField)`)` Field by which to sort the list. |\n| `sortOrder` | `enum (`[SortOrder](/doubleclick-advertisers/rest/v4/orderDocuments/list#SortOrder)`)` Order of sorted results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nOrder document accountPermissionGroups.list Response\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"nextPageToken\": string, \"orderDocuments\": [ { object (/doubleclick-advertisers/rest/v4/orderDocuments#OrderDocument) } ] } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"dfareporting#orderDocumentsListResponse\"` . |\n| `nextPageToken` | `string` Pagination token to be used for the next list operation. |\n| `orderDocuments[]` | `object (`[OrderDocument](/doubleclick-advertisers/rest/v4/orderDocuments#OrderDocument)`)` Order document collection |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/dfatrafficking`\n\nSortField\n---------\n\n| Enums ||\n|--------|---|\n| `ID` | |\n| `NAME` | |\n\nSortOrder\n---------\n\n| Enums ||\n|--------------|---|\n| `ASCENDING` | |\n| `DESCENDING` | |"]]