Method: advertisers.insertionOrders.list

Перечисляет заказы на размещение в рекламодателе.

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

HTTP-запрос

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

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

Параметры пути

Параметры
advertiserId

string ( int64 format)

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

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

Поддерживаемый синтаксис:

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

Поддерживаемые поля:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (вводится в формате ISO 8601 или YYYY-MM-DDTHH:MM:SSZ )

Примеры:

  • Все заказы на размещение в рамках кампании: campaignId="1234"
  • Все заказы на размещение ENTITY_STATUS_ACTIVE или ENTITY_STATUS_PAUSED рекламодателя: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • Все заказы на размещение со временем обновления меньше или равным 2020-11-04T18:54:47Z (формат ISO 8601): updateTime<="2020-11-04T18:54:47Z"
  • Все заказы на размещение с временем обновления, большим или равным 2020-11-04T18:54:47Z (формат ISO 8601): updateTime>="2020-11-04T18:54:47Z"

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

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

Текст запроса

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

Тело ответа

В случае успеха тело ответа содержит данные со следующей структурой:

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

object ( InsertionOrder )

Список заказов на размещение.

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

nextPageToken

string

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

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

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

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

Для получения более подробной информации см.OAuth 2.0 Overview .