Method: partners.list

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

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

HTTP-запрос

GET https://displayvideo.googleapis.com/v1/partners

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

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • displayName

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

filter

string

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

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

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

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

  • entityStatus

Примеры:

  • Все активные партнеры: entityStatus="ENTITY_STATUS_ACTIVE"

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

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

Тело запроса

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

Тело ответа

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

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

object ( Partner )

Список партнеров.

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

nextPageToken

string

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

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

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

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

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