Method: orderDocuments.list

  • This method retrieves a list of order documents and supports paging.

  • The HTTP request uses a GET method with specific user and project IDs in the URL path.

  • Various query parameters are available to filter, search, sort, and control the pagination of the results.

  • The response body contains a list of order document objects along with a kind identifier and a pagination token.

  • Authorization requires the https://www.googleapis.com/auth/dfatrafficking OAuth scope.

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

SortField

Enums
ID
NAME

SortOrder

Enums
ASCENDING
DESCENDING