本指南介绍了如何对 Google Chat API 的 Space
资源使用 create()
方法创建命名聊天室。
Space
资源表示用户和 Chat 应用可以发送消息、共享文件和协作的场所。聊天室有以下几种类型:
- 私信 (DM) 是指两位用户或用户与 Chat 应用之间的对话。
- 群组聊天是指三人或更多用户与 Chat 应用之间的对话。
- 命名聊天室是用户发送消息、共享文件和协作的永久性场所。
命名聊天室是用户发送消息、共享文件和协作的地方。命名聊天室可以包含 Chat 应用。已命名聊天室包含未命名群组对话和私信所不具备的额外功能,例如可以应用管理设置的聊天室管理员、说明以及添加或移除人员和应用。创建命名聊天室后,该聊天室的唯一成员就是经过身份验证的用户。该聊天室不包含其他用户或应用,甚至不包含创建它的 Chat 应用。如需向聊天室添加成员,请参阅创建成员资格。
如需创建包含多个成员的已命名聊天室(三人或更多人之间的未命名群聊、两人之间的私信对话,或一个人和调用 Chat API 的 Chat 应用),请改为设置聊天室。
前提条件
Node.js
- 有权访问 Google Chat 的 Google Workspace 商务版或企业版账号。
- 设置您的环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 为您的 Chat 应用启用和配置 Google Chat API,并为其指定一个名称、图标和说明。
- 安装 Node.js Cloud 客户端库。
- 根据您希望在 Google Chat API 请求中进行身份验证的方式创建访问凭据:
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据保存为名为
client_secrets.json
的 JSON 文件,保存到本地目录中。 - 如需以 Chat 应用的身份进行身份验证,请创建服务账号凭据,并将凭据保存为名为
credentials.json
的 JSON 文件。
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据保存为名为
- 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证, 选择授权范围。
Python
- 有权访问 Google Chat 的 Google Workspace 商务版或企业版账号。
- 设置您的环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 权限请求页面。
- 启用和配置 Google Chat API,为 Chat 应用提供名称、图标和说明。
- 安装 Python Cloud 客户端库。
- 根据您希望在 Google Chat API 请求中进行身份验证的方式创建访问凭据:
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据以 JSON 文件 (
client_secrets.json
) 的形式保存到本地目录。 - 如需以 Chat 应用的身份进行身份验证,请创建服务账号凭据,并将凭据保存为名为
credentials.json
的 JSON 文件。
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据以 JSON 文件 (
- 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证, 选择授权范围。
Java
- 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 权限请求页面。
- 启用和配置 Google Chat API,为 Chat 应用提供名称、图标和说明。
- 安装 Java Cloud 客户端库。
- 根据您要在 Google Chat API 请求中采用的身份验证方式创建访问凭据:
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据保存为名为
client_secrets.json
的 JSON 文件,保存到本地目录中。 - 如需以 Chat 应用的身份进行身份验证,请创建服务账号凭据,并将凭据保存为名为
credentials.json
的 JSON 文件。
- 如需以 Chat 用户身份进行身份验证,请创建 OAuth 客户端 ID 凭据,并将凭据保存为名为
- 根据您是要以用户身份还是以 Chat 应用的身份进行身份验证, 选择授权范围。
Apps 脚本
- 有权访问 Google Chat 的 Google Workspace 商务版或企业版账号。
- 设置环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用和配置 Google Chat API,为 Chat 应用提供名称、图标和说明。
- 创建独立的 Apps 脚本项目,然后启用高级聊天服务。
- 在本指南中,您必须使用用户身份验证或应用身份验证。如需以 Chat 应用的身份进行身份验证,请创建服务账号凭据。如需了解具体步骤,请参阅以 Google Chat 应用身份进行身份验证和授权。
- 根据您是要作为用户还是 Chat 应用进行身份验证, 选择授权范围。
以用户身份创建命名空间
如需使用用户身份验证创建命名空间,请在请求中传递以下内容:
- 指定
chat.spaces.create
或chat.spaces
授权范围。 - 调用
CreateSpace()
方法,将space
作为Space
的实例传递,并包含以下字段:- 将
spaceType
设置成了SPACE
。 displayName
设置为聊天室的用户可见名称。- (可选)设置其他属性,例如:
spaceDetails
- 聊天室的用户可见说明和一组指南。predefinedPermissionSettings
- 聊天室的预定义权限。 例如,您可以将其配置为允许所有成员或仅允许聊天室管理员发布消息。
- 将
以下是创建命名空间的方法:
Node.js
Python
Java
Apps 脚本
将命名聊天室创建为 Chat 应用
应用身份验证需要一次性管理员批准。
如需使用应用身份验证功能将用户邀请或添加到聊天室,请在请求中传递以下内容:
- 指定
chat.app.spaces.create
或chat.app.spaces
授权范围。 - 对
Space
资源调用create
方法。 - 将
spaceType
设置为SPACE
。 - 将
displayName
设置为聊天室的用户可见名称。在以下示例中,displayName
设置为API-made
。 - 使用
customer
字段指定 Google Workspace 网域的客户 ID。 - (可选)设置其他聊天室属性,例如
spaceDetails
(面向用户显示的说明和一组聊天室准则)。
创建 API 密钥
如需调用开发者预览版 API 方法,您必须使用 API 发现文档的非公开开发者预览版。如需对请求进行身份验证,您必须传递 API 密钥。
如需创建 API 密钥,请打开应用的 Google Cloud 项目,然后执行以下操作:
- 在 Google Cloud 控制台中,依次选择“菜单”图标 > API 和服务> 凭据。
- 依次点击创建凭据 > API 密钥。
- 系统会显示您的新 API 密钥。
- 点击“复制”图标 以复制您的 API 密钥,以便在应用的代码中使用。您还可以在项目凭据的“API 密钥”部分找到 API 密钥。
- 点击限制密钥可更新高级设置并限制 API 密钥的使用。如需了解详情,请参阅应用 API 密钥限制。
编写用于调用 Chat API 的脚本
以下是创建命名空间的方法:
Python
- 在工作目录中,创建一个名为
chat_space_create_named_app.py
的文件。 在
chat_space_create_named_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.create"] def main(): ''' Authenticates with Chat API using app authentication, then creates a Chat space. ''' # 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().create( # Details about the space to create. body = { # To create a named space, set spaceType to SPACE. 'spaceType': 'SPACE', # The user-visible name of the space. 'displayName': 'API-made', # The customer ID of the Workspace domain. 'customer': 'CUSTOMER' } ).execute() # Prints details about the created space. print(result) if __name__ == '__main__': main()
在代码中,替换以下内容:
API_KEY
:您创建的用于构建 Chat API 服务端点的 API 密钥。CUSTOMER
:聊天室网域的客户 ID,格式为customer/{customer}
,其中{customer}
是 Admin SDK 客户资源中的ID
。如需在 Chat 应用所属的 Google Workspace 组织中创建聊天室,请使用customers/my_customer
。
在工作目录中,构建并运行示例:
python3 chat_space_create_named_app.py
在 Google Chat 中打开聊天室
如需前往相应聊天室,请使用聊天室的资源 ID 构建聊天室的网址。您可以在 Google Chat 响应正文中找到聊天室 name
的资源 ID。例如,如果聊天室的 name
为 spaces/1234567
,您可以使用以下网址前往该聊天室:https://mail.google.com/chat/u/0/#chat/space/1234567
。
相关主题
- 通过创建成员,将人员和应用添加到聊天室。
- 通过创建消息在聊天室中发消息。
- 获取有关聊天室的详细信息。
- 列出聊天室。
- 更新聊天室。
- 删除聊天室。
- 设置聊天室。
- 查找私信聊天室。
- 让特定用户可以发现聊天室。