Method: spaces.members.list

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

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

HTTP-запрос

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

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

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

Параметры
parent

string

Необходимый. Имя ресурса пространства, для которого требуется получить список участников.

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

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

Параметры
page Size

integer

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

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

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

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

page Token

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 .

show Groups

boolean

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

show Invited

boolean

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

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

use Admin Access

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 )

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

next Page Token

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.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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