Method: orders.list

  • This method retrieves a list of orders and supports paging.

  • The HTTP request uses the GET method and requires profileId and projectId as path parameters.

  • The request body should be empty, and the response body contains the list of orders and pagination information.

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

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