创建 Google Chat 聊天室并添加成员 (original) (raw)

本指南介绍了如何使用setUp()方法在 Google Chat API 的 Space 资源上创建 Chat 聊天室，并向其中添加成员。

`Space`Space 资源表示用户和 Chat 应用可以发送消息、共享文件和协作的场所。聊天室有多种类型：

私信 (DM) 是两位用户之间或用户与 Chat 应用之间的对话。
群聊是三位或更多用户与 Chat 应用之间的对话。
已命名的聊天室是用户发送消息、共享文件和协作的永久场所。

您可以使用 setUp() 方法执行以下任一操作：

创建具有初始成员的已命名聊天室。
在两人之间创建私信 (DM)。
在多人之间设置群组消息。

设置聊天室时，请注意以下事项：

调用（经过身份验证的）用户会自动添加到聊天室，因此您无需在请求中指定用户的成员资格。
创建私信 (DM) 时，如果两个用户之间存在 DM，则系统会返回该 DM。否则，系统会创建 DM。
创建群聊时，如果请求中提供的任何成员资格都未成功添加到群聊（例如，权限问题），则可能会创建一个空群聊（仅包含调用用户）。
您无法设置包含消息串式回复的聊天室，也无法添加 Google Workspace 组织外部的用户。
系统会过滤掉请求中提供的重复成员资格（包括调用用户），而不会导致请求错误。
当 Google Workspace 管理员为其整个 Google Workspace 组织安装 Chat 应用时， Google Chat 会在已安装的 Chat 应用与组织中的每个用户之间创建 DM，因此无需以编程方式设置 DM。您可以列出聊天室以返回所有 DM，也可以查找私信以获取有关特定 DM 的详细信息。

前提条件

Node.js

拥有Google Workspace访问权限的 Business 或 Enterprise 账号，可访问Google Chat。
设置环境：
- 创建 Google Cloud 项目。
- 配置 OAuth 权限请求页面。
- 启用并配置 Google Chat API，为您的 Chat 应用设置名称、图标和说明。
- 安装 Node.js 版 Cloud 客户端库。
- 为桌面应用创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例，请将凭据另存为名为 credentials.json 的 JSON 文件到本地目录。
  如需相关指导，请完成此快速入门中的环境设置步骤。
选择支持用户身份验证的授权范围。

Python

拥有Google Workspace访问权限的 Business 或 Enterprise 账号，可访问Google Chat。
设置环境：
- 创建 Google Cloud 项目。
- 配置 OAuth 权限请求页面。
- 启用并配置 Google Chat API，为您的 Chat 应用设置名称、图标和说明。
- 安装 Python 版 Cloud 客户端库。
- 为桌面应用创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例，请将凭据另存为名为 credentials.json 的 JSON 文件到本地目录。
  如需相关指导，请完成此快速入门中的环境设置步骤。
选择支持用户身份验证的授权范围。

Java

拥有Google Workspace访问权限的 Business 或 Enterprise 账号，可访问Google Chat。
设置环境：
- 创建 Google Cloud 项目。
- 配置 OAuth 权限请求页面。
- 启用并配置 Google Chat API，为您的 Chat 应用设置名称、图标和说明。
- 安装 Java Cloud 客户端库。
- 为桌面应用创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例，请将凭据另存为名为 credentials.json 的 JSON 文件到本地目录。
  如需相关指导，请完成此快速入门中的环境设置步骤。
选择支持用户身份验证的授权范围。

Apps 脚本

拥有Google Workspace访问权限的 Business 或 Enterprise 账号，可访问Google Chat。
设置环境：
- 创建 Google Cloud 项目。
- 配置 OAuth 权限请求页面。
- 启用并配置 Google Chat API，为您的 Chat 应用设置名称、图标和说明。
- 创建独立的 Apps 脚本项目，然后开启高级 Chat 服务。
  如需了解环境设置步骤，请完成此快速入门。
选择支持用户身份验证的授权范围。

设置聊天室

如需设置聊天室，请在请求中传递以下内容：

指定 chat.spaces.create 或 chat.spaces 授权范围。
调用SetUpSpace()方法。
将 space 作为 Space 的实例传递，其中包含所有必需的字段，例如 displayName 或 spaceType。
将 memberships 作为Membership实例的数组传递。对于每个实例：
- 指定 users/{user} 以将人工用户添加为聊天室成员，其中 {user}是 People API 中 person的 {person_id}，或者是 Directory API 中user的 ID。例如，如果 People API 人员 resourceName 为 people/123456789，您可以通过添加一个成员资格（其中 member.name 为 users/123456789）将该用户添加到聊天室。
- 指定 groups/{group} 以将群组添加为聊天室成员，其中 {group}是您要为其创建成员资格的群组 ID。您可以使用Cloud Identity API检索群组的 ID。例如，如果Cloud Identity API返回一个名称为 groups/123456789 的群组，则将membership.groupMember.name 设置为 groups/123456789。Google 网上论坛中的群组无法添加到群聊或 DM，只能添加到已命名的聊天室。

如需在调用用户与另一个人用户之间创建 DM，请在请求中指定该人用户的成员资格。

如需在调用用户与调用应用之间创建私信，请将 space.singleUserBotDm 设置为 true，并且不指定任何成员资格。您只能使用此方法与通话应用设置私信。如需将通话应用添加为聊天室的成员，或添加到两个人用户之间现有的私信，请参阅创建成员资格。

以下示例创建了一个已命名的聊天室，并为两个人工用户（经过身份验证的用户和另一个用户）创建了一个聊天室成员资格。

Node.js

Python

Java

Apps 脚本

如需运行该示例，请替换以下内容：

DISPLAY_NAME：新聊天室的显示名称。
USER_NAME：要为其添加成员资格的其他用户的 ID。

如需前往聊天室，请使用聊天室的资源 ID 构建聊天室的网址。您可以从 Google Chat 响应正文中的聊天室 name 获取资源 ID。例如，如果聊天室的 name 为 spaces/1234567，您可以使用以下网址前往该聊天室：https://mail.google.com/chat/u/0/#chat/space/1234567。