Retrieves a list of order documents, possibly filtered. This method supports paging. Try it now.
Request
HTTP request
GET https://www.googleapis.com/dfareporting/v3.4/userprofiles/profileId/projects/projectId/orderDocuments
Parameters
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
profileId |
long |
User profile ID associated with this request. |
projectId |
long |
Project ID for order documents. |
Optional query parameters | ||
approved |
boolean |
Select only order documents that have been approved by at least one user. |
ids |
long |
Select only order documents with these IDs. |
maxResults |
integer |
Maximum number of results to return.
Acceptable values are 0 to 1000 , inclusive.
(Default: 1000 )
|
orderId |
long |
Select only order documents for specified orders. |
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 |
long |
Select only order documents that are associated with these sites. |
sortField |
string |
Field by which to sort the list.
Acceptable values are:
|
sortOrder |
string |
Order of sorted results.
Acceptable values are:
|
Authorization
This request requires authorization with the following scope:
Scope |
---|
https://www.googleapis.com/auth/dfatrafficking |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a response body with the following structure:
{ "kind": "dfareporting#orderDocumentsListResponse", "nextPageToken": string, "orderDocuments": [ orderDocuments Resource ] }
Property name | Value | Description | Notes |
---|---|---|---|
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[] |
list |
Order document collection |
Try it!
Use the APIs Explorer below to call this method on live data and see the response.