Method: guaranteedOrders.list

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

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

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

По умолчанию порядок сортировки — по возрастанию. Чтобы указать порядок убывания поля, к имени поля следует добавить суффикс «desc». Например, displayName desc .

filter

string

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

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

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

Примеры:

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

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

Дополнительную информацию можно найти в нашем руководстве по запросам фильтров LIST .

accessor к параметру объединения. Необходимый.

Определяет, в рамках какого объекта DV360 делается запрос. Запрос LIST вернет только объекты гарантированного заказа, доступные объекту DV360, указанному в accessor . 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 .