Method: advertisers.list

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

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

Требуется один partnerId. Размещение у нескольких партнеров не поддерживается.

HTTP-запрос

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

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

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

Параметры
partnerId

string (int64 format)

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

integer

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

string

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

string

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

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

По умолчанию используется порядок сортировки по возрастанию. Чтобы указать порядок по убыванию, добавьте к названию поля суффикс desc. например displayName desc (2-е издание).
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.