本指南介绍了如何使用 Google Chat API 的 Space
资源中的 patch
方法来更新聊天室。更新聊天室可更改聊天室的相关属性,例如其用户可见的显示名称、说明和指南。
Space
资源代表用户和 Chat 应用可以发送消息、共享文件和协作的位置。聊天室分为以下几种类型:
- 私信 (DM) 是指两位用户或一位用户与 Chat 应用之间的对话。
- 群聊是三位或更多用户与 Chat 应用之间的对话。
- 已命名的聊天室是用户发送消息、共享文件和开展协作的持久位置。
前提条件
Python
- Python 3.6 或更高版本
- pip 软件包管理工具
适用于 Python 的最新 Google 客户端库。如需安装或更新它们,请在命令行界面中运行以下命令:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- 一个已启用并配置了 Google Chat API 的 Google Cloud 项目。如需了解相关步骤,请参阅构建 Google Chat 应用。
为 Chat 应用配置的授权。更新聊天室需要进行
chat.spaces
授权范围的用户身份验证。
Node.js
- Node.js 和 npm
最新的 Node.js 版 Google 客户端库。如需安装这些组件,请在命令行界面中运行以下命令:
npm install @google-cloud/local-auth @googleapis/chat
- 一个已启用并配置了 Google Chat API 的 Google Cloud 项目。如需了解相关步骤,请参阅构建 Google Chat 应用。
为 Chat 应用配置的授权。更新聊天室需要进行
chat.spaces
授权范围的用户身份验证。
更新聊天室
如需更新 Google Chat 中的现有聊天室,请在请求中传递以下内容:
- 指定
chat.spaces
授权范围。 - 对
Space
资源调用patch
方法。在请求中,您可以指定聊天室name
字段、updateMask
字段(带有一个或多个要更新的字段),以及body
(包含更新后的聊天室信息)。
您可以更新显示名称、聊天室类型、聊天记录状态等内容。如需查看您可以更新的所有字段,请参阅参考文档。
以下是更新现有聊天室的 spaceDetails
字段的方法:
Python
- 在您的工作目录中,创建一个名为
chat_space_update.py
的文件。 在
chat_space_update.py
中添加以下代码:from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.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.spaces"] def main(): ''' Authenticates with Chat API via user credentials, then updates the specified space description and guidelines. ''' # Authenticate with Google Workspace # and get user authorization. flow = InstalledAppFlow.from_client_secrets_file( 'client_secrets.json', SCOPES) creds = flow.run_local_server() # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # 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()
在代码中,将
SPACE
替换为聊天室名称,您可以从 Chat API 中的spaces.list
方法或聊天室的网址获取该名称。在您的工作目录中,构建并运行该示例:
python3 chat_space_update.py
Node.js
- 在您的工作目录中,创建一个名为
update-space.js
的文件。 在
update-space.js
中添加以下代码:const chat = require('@googleapis/chat'); const {authenticate} = require('@google-cloud/local-auth'); /** * Updates a Chat space with the description and guidelines. * @return {!Promise<!Object>} */ async function updateSpace() { const scopes = [ 'https://www.googleapis.com/auth/chat.spaces', ]; const authClient = await authenticate({scopes, keyfilePath: 'client_secrets.json'}); const chatClient = await chat.chat({version: 'v1', auth: authClient}); return await chatClient.spaces.patch({ name: 'spaces/SPACE', updateMask: 'spaceDetails', requestBody: { spaceDetails: { description: 'This description was updated with Chat API!', guidelines: 'These guidelines were updated with Chat API!' }, } }); } updateSpace().then(console.log);
在代码中,将
SPACE
替换为聊天室名称,您可以从 Chat API 中的spaces.list
方法或聊天室的网址获取该名称。在您的工作目录中,运行该示例:
node update-space.js
Google Chat API 会返回一个反映更新的 Space
资源实例。