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 组织启用了历史记录设置时才受支持。如需更新聊天室历史记录状态，您必须在请求中省略所有其他字段掩码。useAdminAccess 不支持 spaceHistoryState。

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

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

  • 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

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