根据管理员的搜索返回 Google Workspace 组织中的聊天室列表。需要以管理员权限进行用户身份验证。在请求中,将 useAdminAccess
设置为 true
。
HTTP 请求
GET https://chat.googleapis.com/v1/spaces:search
网址采用 gRPC 转码语法。
查询参数
参数 | |
---|---|
useAdminAccess |
如果为 发起通话的用户必须是拥有“管理聊天和聊天室对话”权限的 Google Workspace 管理员。 需要 此方法目前仅支持管理员访问权限,因此此字段仅接受 |
pageSize |
要返回的空格数上限。服务返回的值可能会少于此值。 如果未指定,则最多返回 100 个空格。 最大值为 1000。如果您使用的值大于 1000,系统会自动将其更改为 1000。 |
pageToken |
从上一次搜索聊天室调用收到的令牌。请提供此参数以检索后续页面。 进行分页时,提供的所有其他参数应与提供页面令牌的调用相匹配。向其他参数传递不同的值可能会导致意外结果。 |
query |
必需。搜索查询。 您可以使用以下参数进行搜索:
在不同字段中,仅支持 在同一字段中, 以下示例查询有效:
|
orderBy |
可选。聊天室列表的排序方式。 支持按以下属性排序:
有效的排序操作值包括:
支持的语法如下:
|
请求正文
请求正文必须为空。
响应正文
包含与搜索聊天室请求对应的聊天室列表的响应。
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"spaces": [
{
object ( |
字段 | |
---|---|
spaces[] |
请求的聊天室的页面。 |
nextPageToken |
可用于检索下一页的令牌。如果此字段为空,则不存在后续页面。 |
totalSize |
所有网页中与查询匹配的聊天室的总数。如果结果包含超过 10,000 个空格,则此值为估算值。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
有关详情,请参阅授权指南。