Method: partners.channels.list

Отображает список каналов для партнера или рекламодателя.

HTTP-запрос

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

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

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

Параметры
Обязательное поле. Идентифицирует организацию 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 .