本指南介绍了如何使用 Space
资源的 patch
方法
使用 Google Chat API 更新聊天室。更新聊天室以更改聊天室的属性
例如用户可见的显示名称、说明和指南。
通过
Space
资源
代表用户和 Chat 扩展应用能够发送消息的位置,
共享文件和协作聊天室分为以下几种类型:
- 私信 (DM) 是指两位用户或一位用户与 Chat 应用。
- 群聊是三位或更多用户之间的对话, 聊天应用。
- 已命名的聊天室是用户永久保留的位置,可供用户发送消息、共享文件 和协作。
前提条件
Python
- Business 或 Enterprise 有权访问以下内容的 Google Workspace 账号: Google Chat。
- Python 3.6 或更高版本
- pip 软件包管理工具
- 最新的 Google 客户端库。若要安装或更新这些应用
在命令行界面中运行以下命令:
pip3 install --upgrade google-api-python-client google-auth-oauthlib
- 设置您的环境:
<ph type="x-smartling-placeholder">
- </ph>
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,指定一个名称, 图标和说明。
- <ph type="x-smartling-placeholder"></ph>
为桌面应用创建 OAuth 客户端 ID 凭据。为了运行此示例中的示例,
指南中,以 JSON 文件 (
client_secrets.json
) 的形式将凭据保存到您的 本地目录中。
- <ph type="x-smartling-placeholder"></ph> 选择支持用户身份验证的授权范围。
Node.js
- Business 或 Enterprise 有权访问以下内容的 Google Workspace 账号: Google Chat。
- Node.js 14 或更高版本
- npm 软件包管理工具
- 最新的 Google 客户端库。若要安装或更新这些应用
在命令行界面中运行以下命令:
npm install @google-cloud/local-auth @googleapis/chat
- 设置您的环境:
<ph type="x-smartling-placeholder">
- </ph>
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用并配置 Google Chat API,指定一个名称, 图标和说明。
- <ph type="x-smartling-placeholder"></ph>
为桌面应用创建 OAuth 客户端 ID 凭据。为了运行此示例中的示例,
指南中,以 JSON 文件 (
client_secrets.json
) 的形式将凭据保存到您的 本地目录中。
- <ph type="x-smartling-placeholder"></ph> 选择支持用户身份验证的授权范围。
更新聊天室
如需更新 Google Chat 中的现有聊天室,请传递以下内容 :
- 指定
chat.spaces
授权范围。 - 调用
patch
方法 针对Space
资源。在 您需要指定聊天室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
替换为聊天室名称, 您可以从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
替换为聊天室名称, 您可以从spaces.list
方法 或通过聊天室网址发送。在您的工作目录中,运行该示例:
node update-space.js
Google Chat API 会返回
反映更新的 Space
资源。