列出聊天室中的成员。如需查看示例,请参阅在聊天室中列出用户和 Google Chat 应用。使用应用身份验证列出成员时,系统会列出 Chat 应用有权访问的聊天室中的成员,但会排除 Chat 应用成员资格,包括应用自身的成员。使用用户身份验证功能列出成员时,系统会列出经过身份验证的用户有权访问的聊天室中的成员。
HTTP 请求
GET https://chat.googleapis.com/v1/{parent=spaces/*}/members
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
parent |
必需。要获取其成员资格列表的聊天室的资源名称。 格式:空格/{space} |
查询参数
参数 | |
---|---|
pageSize |
可选。要返回的成员资格数量上限。服务返回的值可能会少于此值。 如果未指定,则最多返回 100 个成员。 最大值为 1000。如果您使用的值大于 1000,系统会自动将其更改为 1000。 负值会返回 |
pageToken |
可选。页面令牌,从上一次对列出成员的调用中获得。提供此参数以检索后续网页。 进行分页时,提供的所有其他参数应与提供页面令牌的调用相匹配。将不同的值传递给其他参数可能会导致意外结果。 |
filter |
可选。查询过滤条件。 您可以按成员的角色( 如需按角色过滤,请将 如需按类型过滤,请将 如需同时按角色和类型进行过滤,请使用 如果 例如,以下查询有效:
以下查询无效:
服务器会拒绝无效查询,并显示 |
showGroups |
可选。如果为 |
showInvited |
可选。如果设为 目前要求进行用户身份验证。 |
useAdminAccess |
true 时,该方法会使用用户的 Google Workspace 管理员权限运行。发起调用的用户必须是拥有“管理聊天和聊天室对话”权限的 Google Workspace 管理员。 需要 使用管理员访问权限时,不支持在聊天室中列出应用成员资格。 |
请求正文
请求正文必须为空。
响应正文
对聊天室列表成员的响应。
如果成功,响应正文将包含结构如下的数据:
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
有关详情,请参阅授权指南。