Method: advertisers.insertionOrders.list

Lists insertion orders in an advertiser.

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

HTTP request

GET https://displayvideo.googleapis.com/v1/advertisers/{advertiserId}/insertionOrders

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
advertiserId

string (int64 format)

Required. The ID of the advertiser to list insertion orders for.

Query parameters

Parameters
pageSize

integer

Requested page size. Must be between 1 and 100. If unspecified will default to 100. Returns error code INVALID_ARGUMENT if an invalid value is specified.

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 insertionOrders.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)
  • "entityStatus"

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

filter

string

Allows filtering by insertion order properties.

Supported syntax:

  • 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}.
  • The operator used on budget.budget_segments.date_range.end_date must be LESS THAN (<).
  • The operators used on all other fields must be EQUALS (=).
  • Supported fields:
    • campaignId
    • displayName
    • entityStatus
    • budget.budget_segments.date_range.end_date (input as YYYY-MM-DD)

Examples:

  • All insertion orders under a campaign: campaignId="1234"
  • All ENTITY_STATUS_ACTIVE or ENTITY_STATUS_PAUSED insertion orders under an advertiser: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • All insertion orders whose budget segments' dates end before March 28, 2019: budget.budget_segments.date_range.end_date<"2019-03-28"

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

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "insertionOrders": [
    {
      object (InsertionOrder)
    }
  ],
  "nextPageToken": string
}
Fields
insertionOrders[]

object (InsertionOrder)

The list of insertion 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 insertionOrders.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.