Method: advertisers.insertionOrders.list

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

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

HTTP-запрос

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

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

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

Параметры
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.