Method: advertisers.list

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

Порядок определяется параметром orderBy .

Требуется один partnerId . Перекрестный список партнеров не поддерживается.

HTTP-запрос

GET https://displayvideo.googleapis.com/v3/advertisers

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

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

Параметры
partnerId

string ( int64 format)

Необходимый. Идентификатор партнера, которому должны принадлежать все выбранные рекламодатели. Система поддерживает листинг рекламодателей только для одного партнера одновременно.

pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

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

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

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

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

Примеры:

  • Все активные рекламодатели партнера: entityStatus="ENTITY_STATUS_ACTIVE"
  • Все рекламодатели, время обновления которых меньше или равно 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-представление 
{
  "advertisers": [
    {
      object (Advertiser)
    }
  ],
  "nextPageToken": string
}
Поля
advertisers[]

object ( Advertiser )

Список рекламодателей.

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

nextPageToken

string

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

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

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

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

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