Method: users.list

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

Для этого способа действуют уникальные требования к аутентификации. Прежде чем использовать этот метод, ознакомьтесь с предварительными требованиями в руководстве по управлению пользователями.

Функция "Попробовать этот метод" не работает для этого метода.

HTTP-запрос

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

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

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

Параметры
pageSize

integer

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

string

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

string

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

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

По умолчанию используется порядок сортировки по возрастанию. Чтобы указать порядок по убыванию, добавьте к названию поля суффикс desc. например displayName desc (2-е издание).
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"
  • Все пользователи, которые в последний раз входили в систему 1 января 2023 г. в 00:00:00 по всемирному координированному времени или позже (формат 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.