本指南介绍了如何使用 Google Chat API 的 Space
资源中的 patch()
方法更新聊天室。更新聊天室以更改聊天室的相关属性,例如其面向用户的显示名称、说明和准则。
如果您是 Google Workspace 管理员,可以调用 patch()
方法来更新 Google Workspace 组织中的任何现有聊天室。
Space
资源表示用户和 Chat 应用可以在其中发送消息、共享文件和协作处理事务。聊天室有多种类型:
- 私信 (DM) 是两位用户之间或用户与 Chat 应用之间的对话。
- 群聊是指三位或更多用户与聊天应用之间的对话。
- 命名聊天室是持久存在的聊天室,用户可以在其中发送消息、分享文件和协作。
前提条件
Node.js
- 拥有可访问 Google Chat 的 Google Workspace 商务版或企业版账号。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,为您的 Chat 应用指定名称、图标和说明。
- 安装 Node.js Cloud 客户端库。
- 为桌面应用
创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例,请将凭据保存为名为
credentials.json
的 JSON 文件,并将其保存到本地目录。
- 选择支持用户身份验证的授权范围。
Python
- 拥有可访问 Google Chat 的 Google Workspace 商务版或企业版账号。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,为您的 Chat 应用指定名称、图标和说明。
- 安装 Python Cloud 客户端库。
- 为桌面应用
创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例,请将凭据保存为名为
credentials.json
的 JSON 文件,并将其保存到本地目录。
- 选择支持用户身份验证的授权范围。
Java
- 拥有可访问 Google Chat 的 Google Workspace 商务版或企业版账号。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,为您的 Chat 应用指定名称、图标和说明。
- 安装 Java Cloud 客户端库。
- 为桌面应用
创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例,请将凭据保存为名为
credentials.json
的 JSON 文件,并将其保存到本地目录。
- 选择支持用户身份验证的授权范围。
Apps 脚本
- 拥有可访问 Google Chat 的 Google Workspace 商务版或企业版账号。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,为您的 Chat 应用指定名称、图标和说明。
- 创建独立的 Apps 脚本项目,然后启用高级聊天服务。
- 选择支持用户身份验证的授权范围。
以用户身份更新空间
如需使用用户身份验证更新 Google Chat 中的现有聊天室,请在请求中传递以下内容:
- 指定
chat.spaces
授权范围。 - 调用
UpdateSpace()
方法。在请求中,您需要指定空间name
字段、包含一个或多个要更新的字段的updateMask
字段,以及包含更新后的空间信息的body
。
您可以更新显示名称、会议室类型、历史记录状态等。如需查看您可以更新的所有字段,请参阅参考文档。
以下是如何更新现有空间的 displayName
字段:
Node.js
Python
Java
Apps 脚本
如需运行此示例,请将 SPACE_NAME
替换为空间 name
字段中的 ID。您可以通过调用 ListSpaces()
方法或从空间的网址中获取 ID。
Google Chat API 会返回一个反映更新的 Space
实例。
以 Google Workspace 管理员身份更新聊天室
如果您是 Google Workspace 管理员,可以调用 UpdateSpace()
方法来更新 Google Workspace 组织中的任何聊天室。
如需以 Google Workspace 管理员身份调用此方法,请执行以下操作:
如需了解详情和示例,请参阅以 Google Workspace 管理员身份管理 Google Chat 聊天室。
以 Chat 应用的身份更新聊天室
应用身份验证需要管理员一次性批准。
如需使用应用身份验证更新 Google Chat 中的现有聊天室,请在请求中传递以下内容:
- 指定
chat.app.spaces
授权范围。 通过应用身份验证,您只能更新由 Chat 应用创建的聊天室。 - 对
Space
资源调用patch
方法。在请求中,您需要指定空间name
字段、包含一个或多个要更新的字段的updateMask
字段,以及包含更新后的空间信息的body
。
您可以更新显示名称、空间类型、历史记录状态、权限设置等。如需查看您可以更新的所有字段,请参阅参考文档。
创建 API 密钥
如需调用开发者预览版 API 方法,您必须使用非公开的开发者预览版 API 发现文档。如需对请求进行身份验证,您必须传递 API 密钥。
如需创建 API 密钥,请打开应用的 Google Cloud 项目并执行以下操作:
- 在 Google Cloud 控制台中,依次前往菜单 > API 和服务 > 凭据。
- 依次点击创建凭据 > API 密钥。
- 系统会显示您的新 API 密钥。
- 点击“复制”图标 即可复制 API 密钥,以便在应用的代码中使用。您还可以在项目的凭据的“API 密钥”部分中找到 API 密钥。
- 点击限制密钥以更新高级设置并限制 API 密钥的使用。如需了解详情,请参阅应用 API 密钥限制。
编写调用 Chat API 的脚本
以下是如何更新现有空间的 spaceDetails
字段:
Python
- 在工作目录中,创建一个名为
chat_space_update_app.py
的文件。 在
chat_space_update_app.py
中添加以下代码:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.spaces"] def main(): ''' Authenticates with Chat API using app authentication, then updates the specified space description and guidelines. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY') # Use the service endpoint to call Chat API. result = chat.spaces().patch( # The space to update, and the updated space details. # # Replace {space} with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. name='spaces/SPACE', updateMask='spaceDetails', body={ 'spaceDetails': { 'description': 'This description was updated with Chat API!', 'guidelines': 'These guidelines were updated with Chat API!' } } ).execute() # Prints details about the updated space. print(result) if __name__ == '__main__': main()
在代码中,替换以下内容:
API_KEY
:您创建的用于构建 Chat API 服务端点的 API 密钥。SPACE
,其中包含聊天室名称,您可以通过 Chat API 中的spaces.list
方法或从聊天室的网址获取该名称。
在工作目录中,构建并运行示例:
python3 chat_space_update_app.py
Google Chat API 会返回一个反映更新的 Space
资源实例。
限制和注意事项
- 借助应用身份验证,Chat 应用:
- 只能更新自己创建的聊天室中的
predefinedPermissionSettings
或permissionSettings
。 - 无法更新
accessSettings.audience
。
- 只能更新自己创建的聊天室中的