Method: spaces.patch

更新聊天室。如需查看示例，请参阅更新聊天室。

如果您在更新 displayName 字段时收到 ALREADY_EXISTS 错误消息，请尝试使用其他显示名称。Google Workspace 组织中的现有聊天室可能已经在使用此显示名称。

支持以下类型的身份验证：

HTTP 请求

PATCH https://chat.googleapis.com/v1/{space.name=spaces/*}

网址采用 gRPC 转码语法。

路径参数

参数
space.name

string

标识符。聊天室的资源名称。

格式：spaces/{space}

其中 {space} 表示系统为聊天室分配的 ID。您可以通过调用 spaces.list() 方法或从聊天室网址获取聊天室 ID。例如，如果聊天室网址为 https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA，则聊天室 ID 为 AAAAAAAAA。

查询参数

参数
updateMask

string (FieldMask format)

必需。更新后的字段路径（如果存在多个路径，则以英文逗号分隔）。

您可以更新聊天室的以下字段：

spaceDetails：更新聊天室的说明。最多支持 150 个字符。

displayName：仅支持更新 spaceType 字段为 SPACE 的工作区的显示名称。如果您收到错误消息 ALREADY_EXISTS，请尝试输入其他值。Google Workspace 组织中的现有聊天室可能已经在使用此显示名称。

spaceType：仅支持将 GROUP_CHAT 聊天室类型更改为 SPACE。在更新掩码中添加 displayName 和 spaceType，并确保指定空间的显示名称和 SPACE 空间类型均非空。如果现有空间已具有 SPACE 类型，则在更新显示名称时，可以选择在指定空间中包含 spaceType 掩码和 SPACE 类型。尝试以其他方式更新聊天室类型会导致参数无效错误。useAdminAccess 不支持 spaceType。

spaceHistoryState：通过为聊天室开启或关闭历史记录来更新聊天室历史记录设置。必须为 Google Workspace 组织启用聊天记录设置。如需更新聊天室历史记录状态，您必须在请求中省略所有其他字段掩码。spaceHistoryState 不支持 useAdminAccess。

accessSettings.audience：更新访问权限设置，指定哪些人可以在已命名的聊天室中发现聊天室、加入聊天室以及预览消息（spaceType 字段为 SPACE）。如果现有聊天室有目标对象群组，您可以移除目标对象群组，通过省略此字段掩码的值来限制聊天室访问权限。如需更新聊天室的访问权限设置，进行身份验证的用户必须是聊天室管理员，并且在请求中省略所有其他字段掩码。如果聊天室处于导入模式，您将无法更新此字段。如需了解详情，请参阅将聊天室设为可供特定用户搜索。useAdminAccess 不支持 accessSettings.audience。

permissionSettings：支持更改聊天室的权限设置。更新权限设置时，您只能指定 permissionSettings 字段掩码；不能同时更新其他字段掩码。permissionSettings 不支持 useAdminAccess。支持的字段掩码包括：

  • permissionSettings.manageMembersAndGroups
  • permissionSettings.modifySpaceDetails
  • permissionSettings.toggleHistory
  • permissionSettings.useAtMentionAll
  • permissionSettings.manageApps
  • permissionSettings.manageWebhooks
  • permissionSettings.replyMessages
useAdminAccess

boolean

可选。如果为 true，则该方法会使用用户的 Google Workspace 管理员权限运行。

发起通话的用户必须是拥有“管理聊天和聊天室对话”权限的 Google Workspace 管理员。

需要 chat.admin.spaces OAuth 2.0 范围。

部分FieldMask值不支持使用管理员访问权限。如需了解详情，请参阅 updateMask 的说明。

请求正文

请求正文包含一个 Space 实例。

响应正文

如果成功，则响应正文包含一个 Space 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

如需了解详情，请参阅授权指南。