Method: guaranteedOrders.list

  • This API method lists guaranteed orders accessible to the current user.

  • Guaranteed orders can be ordered by the orderBy parameter and filtered by fields like guaranteedOrderId, exchange, displayName, and status.entityStatus using the filter parameter.

  • The HTTP request uses a GET method to the specified Google API endpoint.

  • The request body must be empty, and the response body contains a list of guaranteed order objects and a token for pagination.

  • The request requires the https://www.googleapis.com/auth/display-video OAuth scope for authorization.

Lists guaranteed orders that are accessible to the current user.

The order is defined by the orderBy parameter. If a filter by entityStatus is not specified, guaranteed orders with entity status ENTITY_STATUS_ARCHIVED will not be included in the results.

HTTP request

GET https://displayvideo.googleapis.com/v4/guaranteedOrders

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageSize

integer

Requested page size. Must be between 1 and 200. If unspecified will default to 100.
pageToken

string

A token identifying a page of results the server should return. Typically, this is the value of nextPageToken returned from the previous call to guaranteedOrders.list method. If not specified, the first page of results will be returned.
orderBy

string

Field by which to sort the list. Acceptable values are:

  • displayName (default)

The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. For example, displayName desc.
filter

string

Allows filtering by guaranteed order fields.

  • Filter expressions are made up of one or more restrictions.
  • Restrictions can be combined by AND or OR logical operators. A sequence of restrictions implicitly uses AND.
  • A restriction has the form of {field} {operator} {value}.
  • All fields must use the EQUALS (=) operator.

Supported fields: * guaranteedOrderId * exchange * displayName * status.entityStatus

Examples:

  • All active guaranteed orders: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

The length of this field should be no more than 500 characters.

Reference our filter LIST requests guide for more information.

Required.

Identifies which DV360 entity the request is being made within. The LIST request will only return guaranteed order entities that are accessible to the DV360 entity identified within the accessor. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
partnerId

string (int64 format)

The ID of the partner that has access to the guaranteed order.
advertiserId

string (int64 format)

The ID of the advertiser that has access to the guaranteed order.
End of mutually exclusive fields.

Request body

The request body must be empty.

Response body

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

JSON representation 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
Fields
guaranteedOrders[]

object (GuaranteedOrder)

The list of guaranteed orders.

This list will be absent if empty.
nextPageToken

string

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.