Retrieves a list of order documents, possibly filtered. This method supports paging.
HTTP request
GET https://dfareporting.googleapis.com/dfareporting/v3.3/userprofiles/{profileId}/projects/{projectId}/orderDocuments
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
profileId |
User profile ID associated with this request. |
projectId |
Project ID for order documents. |
Query parameters
Parameters | |
---|---|
ids[] |
Select only order documents with these IDs. |
orderId[] |
Select only order documents for specified orders. |
approved |
Select only order documents that have been approved by at least one user. |
maxResults |
Maximum number of results to return. |
pageToken |
Value of the
from the previous result page. |
searchString |
Allows searching for order documents by name or ID. Wildcards (
) are allowed. For example,
will return order documents with names like
,
, or simply
. Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of
will match order documents with name
,
, or simply
. |
siteId[] |
Select only order documents that are associated with these sites. |
sortField |
Field by which to sort the list. |
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 ( |
Fields | |
---|---|
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
nextPageToken |
Pagination token to be used for the next list operation. |
orderDocuments[] |
Order document collection |
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/dfatrafficking
SortField
Enums | |
---|---|
ID |
|
NAME |
SortOrder
Enums | |
---|---|
ASCENDING |
|
DESCENDING |