Method: partners.channels.list

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

HTTP-запрос

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

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

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

Параметры
Обязательно. Идентифицирует объект DV360, которому принадлежат каналы. Это может быть как партнер, так и рекламодатель. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
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.
Обязательно. Идентифицирует объект DV360, которому принадлежат каналы. Это может быть как партнер, так и рекламодатель. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
advertiserId

string (int64 format)

Идентификатор рекламодателя, которому принадлежат каналы.
Конец взаимоисключающих полей.

Тело запроса

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

Тело ответа

Если ответ получен успешно, его тело содержит экземпляр ListChannelsResponse.

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

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

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

Дополнительную информацию вы найдете в OAuth 2.0 Overview.