Method: users.list

Список пользователей, к которым имеет доступ текущий пользователь. Если у двух пользователей есть роли у одного и того же партнёра или рекламодателя, они могут получить доступ друг к другу.

Этот метод предъявляет особые требования к аутентификации. Перед использованием этого метода ознакомьтесь с предварительными требованиями в нашем руководстве по управлению пользователями .

Функция «Попробуйте этот метод» для этого метода не работает.

HTTP-запрос

GET https://displayvideo.googleapis.com/v3/users

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

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

Параметры
pageSize

integer

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

pageToken

string

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

orderBy

string

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

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

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

filter

string

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

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

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

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

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType : это синтетическое поле AssignedUserRole , используемое для фильтрации. Определяет тип сущности, которой назначена роль пользователя. Допустимые значения: Partner и Advertiser .
  • assignedUserRole.parentPartnerId : это синтетическое поле AssignedUserRole , используемое для фильтрации. Определяет родительского партнера сущности, которой назначена роль пользователя.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (вводится в формате ISO 8601 или YYYY-MM-DDTHH:MM:SSZ )

Примеры:

  • Пользователь с displayName , содержащим «foo»: displayName:"foo"
  • Пользователь с email , содержащим «bar»: email:"bar"
  • Все пользователи со стандартными ролями пользователя: assignedUserRole.userRole="STANDARD"
  • Все пользователи с ролями пользователя для партнера 123: assignedUserRole.partnerId="123"
  • Все пользователи с ролями пользователя для рекламодателя 123: assignedUserRole.advertiserId="123"
  • Все пользователи с ролями пользователя уровня партнера: entityType="PARTNER"
  • Все пользователи с ролями пользователя для партнера 123 и рекламодатели под партнером 123: parentPartnerId="123"
  • Все пользователи, которые последний раз входили в систему 2023-01-01T00:00:00Z или позже (формат ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

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

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

Текст запроса

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

Тело ответа

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

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

object ( User )

Список пользователей.

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

nextPageToken

string

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

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

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

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

Для получения более подробной информации см.OAuth 2.0 Overview .