Method: guaranteedOrders.list

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

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

HTTP-запрос

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