Method: partners.channels.list

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

HTTP-запрос

GET https://displayvideo.googleapis.com/v1/partners/{partnerId}/channels

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

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

Параметры
partnerId

string ( int64 format)

Идентификатор партнера, которому принадлежат каналы.

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

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

  • Выражения фильтра для канала могут содержать не более одного ограничения.
  • Ограничение имеет форму {field} {operator} {value} .
  • Во всех полях должен использоваться оператор HAS (:) .

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

  • displayName

Примеры:

  • Все каналы, отображаемое имя которых содержит «google»: displayName : "google" .

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

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

advertiserId

string ( int64 format)

Идентификатор рекламодателя, которому принадлежат каналы.

Тело запроса

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

Тело ответа

В случае успеха тело ответа содержит экземпляр ListChannelsResponse .

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

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

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

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