Method: advertisers.manualTriggers.list

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

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

Требуется один advertiserId .

HTTP-запрос

GET https://displayvideo.googleapis.com/v1beta2/advertisers/{advertiserId}/manualTriggers

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

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

Параметры
advertiserId

string ( int64 format)

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

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

Позволяет фильтровать по свойствам ручного триггера.

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

  • Выражения фильтра состоят из одного или нескольких ограничений.
  • Ограничения могут быть объединены логическими операторами AND или OR . Последовательность ограничений неявно использует AND .
  • Ограничение имеет форму {field} {operator} {value} .
  • Оператор должен быть EQUALS (=) .
  • Поддерживаемые поля:
    • displayName
    • Примеры state :

  • Все активные ручные триггеры рекламодателя: state="ACTIVE"

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

Тело запроса

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

Тело ответа

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

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

object ( ManualTrigger )

Список ручных триггеров.

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

nextPageToken

string

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .