Method: guaranteedOrders.list

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

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

HTTP-запрос

GET https://displayvideo.googleapis.com/v4/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 .

Необходимый.

Указывает, в какой сущности 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 .