Method: spaces.patch

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

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

要求用户身份验证

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
space.name

string

聊天室的资源名称。

格式:spaces/{space}

查询参数

参数
updateMask

string (FieldMask format)

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

目前支持的字段路径:

  • displayName(仅支持更改具有 SPACE 类型的空间的显示名称,或者同时包含 spaceType 掩码以将 GROUP_CHAT 空间类型更改为 SPACE。尝试更新 GROUP_CHATDIRECT_MESSAGE 空格的显示名称会导致无效参数错误。如果您在更新 displayName 时收到错误消息 ALREADY_EXISTS,请尝试使用其他 displayName。Google Workspace 组织中的现有聊天室可能已经在使用此显示名称。)

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

  • spaceDetails

  • spaceHistoryState(如果组织允许用户更改其聊天记录设置,则支持为聊天室开启或关闭聊天记录功能)。警告:与所有其他字段路径相互排斥。)

  • 开发者预览版:accessSettings.audience(支持更改聊天室的访问权限设置。如果访问权限设置中未指定任何对象群组,聊天室的访问权限设置会更新为“受限”。警告:与所有其他字段路径相互排斥。)

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 范围之一:

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

有关详情,请参阅授权指南