Method: guaranteedOrders.list

Возвращает список гарантированных заказов, доступных текущему пользователю.

Порядок определяется параметром orderBy. Если не указать filter по entityStatus, гарантированные заказы со статусом ENTITY_STATUS_ARCHIVED не будут включены в результаты.

HTTP-запрос

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

URL имеет синтаксис gRPC Transcoding.

Параметры запроса

Параметры
pageSize

integer

Запрошенный размер страницы. Значение должно быть в диапазоне от 1 до 200. Если не указано, по умолчанию будет использоваться 100.
pageToken

string

Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken, возвращенное предыдущим вызовом метода guaranteedOrders.list. Если значение не указано, будет возвращена первая страница результатов.
orderBy

string

Поле, по которому нужно отсортировать список. Допустимые значения:

  • displayName (по умолчанию)

По умолчанию используется порядок сортировки по возрастанию. Чтобы указать порядок по убыванию, добавьте к названию поля суффикс desc. например displayName desc (2-е издание).
filter

string

Позволяет фильтровать по полям гарантированных заказов.

  • Выражения фильтров состоят из одного или нескольких ограничений.
  • Ограничения можно комбинировать с помощью логических операторов AND или OR. В последовательности ограничений неявно используется AND.
  • Ограничение имеет следующий формат: {field} {operator} {value}.
  • Во всех полях должен использоваться оператор EQUALS (=).

Поддерживаемые поля: * guaranteedOrderId * exchange * displayName * status.entityStatus

Примеры:

  • Все активные гарантированные заказы: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Гарантированные заказы, относящиеся к Google Менеджеру рекламы или биржам Rubicon: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

Длина этого поля не должна превышать 500 символов.

Подробную информацию вы найдете в руководстве по фильтрации запросов LIST.

Обязательно.

Идентификатор объекта DV360, в рамках которого выполняется запрос. Запрос LIST возвращает только гарантированные заказы, доступные объекту DV360, указанному в accessor. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
partnerId

string (int64 format)

Идентификатор партнера, у которого есть доступ к гарантированному заказу.
advertiserId

string (int64 format)

Идентификатор рекламодателя, у которого есть доступ к гарантированному заказу.
Конец взаимоисключающих полей.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ниже приведена структура данных в ответе, полученном на запрос.

JSON-представление 
{
  "guaranteedOrders": [
    {
      object (GuaranteedOrder)
    }
  ],
  "nextPageToken": string
}
Поля
guaranteedOrders[]

object (GuaranteedOrder)

Список гарантированных заказов.

Если список пуст, он не будет показан.
nextPageToken

string

Токен для загрузки следующей страницы результатов. Передайте это значение в поле pageToken в последующем вызове метода guaranteedOrders.list, чтобы получить следующую страницу результатов.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию вы найдете в OAuth 2.0 Overview.