Method: spaces.members.list

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

Поддерживает следующие типы аутентификации :

  • Аутентификация приложения с одной из следующих областей авторизации:

  • Аутентификация пользователя с одной из следующих областей авторизации:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (только пространство в режиме импорта)
    • Аутентификация пользователя предоставляет привилегии администратора, когда учетная запись администратора проходит аутентификацию, useAdminAccess имеет true и используется одна из следующих областей авторизации:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

HTTP-запрос

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

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

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

Параметры
parent

string

Обязательно. Имя ресурса пространства, для которого требуется получить список участников.

Формат: пробелы/{пробел}

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

Параметры
pageSize

integer

Необязательно. Максимальное количество возвращаемых членств. Сервис может вернуть меньшее количество.

Если не указано иное, возвращается не более 100 членств.

Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000.

Отрицательные значения возвращают ошибку INVALID_ARGUMENT .

pageToken

string

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

При пагинации все остальные предоставленные параметры должны соответствовать вызову, предоставившем токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам.

filter

string

Необязательно. Фильтр запроса.

Вы можете фильтровать членство по роли участника ( role ) и типу ( member.type ).

Чтобы отфильтровать по роли, установите role ROLE_MEMBER или ROLE_MANAGER .

Чтобы отфильтровать по типу, установите для member.type значение HUMAN или BOT . Вы также можете отфильтровать по member.type с помощью оператора != .

Для фильтрации по роли и типу используйте оператор AND Для фильтрации по роли или типу используйте оператор OR .

Если параметр useAdminAccess установлен в значение true, требуется либо member.type = "HUMAN" , либо member.type != "BOT" . Фильтры других типов участников будут отклонены.

Например, следующие запросы являются допустимыми:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Следующие запросы недействительны:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Недействительные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

showGroups

boolean

Необязательно. При true также возвращает информацию о членстве, связанном с Google Group , в дополнение к другим типам членства. Если установлен filter , информация о членстве Google Group , не соответствующая критериям фильтра, не возвращается.

showInvited

boolean

Необязательно. При true также возвращает членства, связанные с invited участниками, в дополнение к другим типам членства. Если установлен фильтр, invited членства, не соответствующие критериям фильтра, не возвращаются.

В настоящее время требуется аутентификация пользователя .

useAdminAccess

boolean

Необязательно. При true метод запускается с использованием прав администратора Google Workspace пользователя.

Вызывающий пользователь должен быть администратором Google Workspace с привилегией управления чатами и беседами в пространствах .

Требуется область действия OAuth 2.0 chat.admin.memberships.readonly или chat.admin.memberships .

При использовании прав администратора отображение списка членств в приложениях в пространстве не поддерживается.

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

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

Тело ответа

Ответ на список участников пространства.

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

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

object ( Membership )

Неупорядоченный список. Список участников на запрошенной (или первой) странице.

nextPageToken

string

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

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

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Более подробную информацию смотрите в Руководстве по авторизации .