Method: sellers.orders.list

  • This method lists orders for a specific seller.

  • The request uses a GET HTTP method and includes the seller ID in the URL path.

  • Optional query parameters like pageSize, pageToken, filter, and orderBy can be used to refine the list of orders returned.

  • The response body contains a list of order objects and a nextPageToken for pagination.

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

Lists orders.

  • For example GET /v1/sellers/321/orders
  • Returns a list of orders and a token to retrieve the next page if successful.
  • Returns error code PERMISSION_DENIED if the user does not have access to the seller or seller id does not exist.
  • Returns error code INVALID_ARGUMENT if sellers provide an invalid page size or page token.

HTTP request

GET https://dv360outofhomeseller.googleapis.com/v1/{parent=sellers/*}/orders

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent, which owns this collection of orders. Format: sellers/{seller}

Query parameters

Parameters
pageSize

integer

The maximum number of items to return. The service may return fewer than this value. Max allowed number of orders is 1000. If unspecified, at most 1000 orders will be returned.
pageToken

string

The nextPageToken value returned from a previous List request, if any.
filter

string

The list filter. Currently supports external ID and state filtering, with the syntax: "externalId = [EXTERNAL_ID]" and "state = [STATE]". The logical operators AND and OR can be used to chain filters.
orderBy

string

The order by string used to specify the sort order of the results. Currently supports ordering by updateTime, provide "updateTime" to get results sorted by updateTime in ascending order, or "updateTime desc" for descending order.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation 
{
  "orders": [
    {
      object (Order)
    }
  ],
  "nextPageToken": string
}
Fields
orders[]

object (Order)

The list of orders.
nextPageToken

string

A token to retrieve the next page of results. Pass this value in the pageToken field in the subsequent call to orders.list method to retrieve the next page of results.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/doubleclickbidmanager

For more information, see the OAuth 2.0 Overview.