- HTTP-запрос
- Параметры пути
- Параметры запроса
- Тело запроса
- Тело ответа
- Области авторизации
- Попробуйте!
Перечисляет членство в пространстве. Пример см. в разделе Список пользователей и приложений Google Chat в пространстве . В списке участников с аутентификацией приложения перечислены участники в пространствах, к которым у приложения Chat есть доступ, но исключаются членства в приложении Chat, включая собственное. В списке участников с аутентификацией пользователя перечислены членства в пространствах, к которым имеет доступ аутентифицированный пользователь.
Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей .
HTTP-запрос
GET https://chat.googleapis.com/v1/{parent=spaces/*}/members
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
parent | Необходимый. Имя ресурса пространства, для которого нужно получить список участников. Формат: пробелы/{пробел} |
Параметры запроса
Параметры | |
---|---|
pageSize | Необязательный. Максимальное количество членств для возврата. Служба может вернуть меньше этого значения. Если не указано, возвращается не более 100 членств. Максимальное значение — 1000. Если вы используете значение больше 1000, оно автоматически изменится на 1000. Отрицательные значения возвращают ошибку |
pageToken | Необязательный. Токен страницы, полученный в результате предыдущего вызова списка участников. Укажите этот параметр, чтобы получить следующую страницу. При разбиении на страницы все остальные предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача других значений другим параметрам может привести к неожиданным результатам. |
filter | Необязательный. Фильтр запроса. Вы можете фильтровать членство по роли участника ( Чтобы фильтровать по роли, установите для Чтобы фильтровать по типу, установите Для фильтрации по роли и типу используйте оператор Если для Например, допустимы следующие запросы:
Следующие запросы недействительны:
Недействительные запросы отклоняются сервером с ошибкой |
showGroups | Необязательный. Если задано |
showInvited | Необязательный. Если задано В настоящее время требуется аутентификация пользователя . |
useAdminAccess | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область OAuth 2.0 Перечисление участников приложений в пространстве не поддерживается при использовании доступа администратора. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответ на список участников пространства.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"memberships": [
{
object ( |
Поля | |
---|---|
memberships[] | Неупорядоченный список. Список участников на запрошенной (или первой) странице. |
nextPageToken | Токен, который вы можете отправить как |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/chat.admin.memberships
-
https://www.googleapis.com/auth/chat.admin.memberships.readonly
-
https://www.googleapis.com/auth/chat.import
-
https://www.googleapis.com/auth/chat.bot
-
https://www.googleapis.com/auth/chat.memberships
-
https://www.googleapis.com/auth/chat.memberships.readonly
Дополнительную информацию см. в руководстве по авторизации .