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 .