配置 Google Chat 应用

本页介绍了如何将 Google Chat 应用配置和部署为 Google Workspace 插件。

如需部署和测试用于扩展 Chat 的 Google Workspace 插件，您必须使用 Google Chat API 启用和配置 Chat 应用。在 Chat API 配置设置中，您可以指定 Chat 应用的所有详细信息，包括您要使用的名称、头像、部署和互动功能。

前提条件

HTTP

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。
• 创建 Google Cloud 项目。
• 配置 OAuth 同意屏幕。
• 启用以下 Google Workspace API：
  • Google Chat API
  • Google Workspace Add-ons API
    您无法使用 Google Workspace Add-ons API 创建和管理 Chat 应用的部署。如需了解详情，请参阅限制和已知问题。
• 托管 Chat 应用服务架构的 HTTP 端点。

Apps 脚本

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。
• 创建 Google Cloud 项目。
• 配置 OAuth 同意屏幕。
• 启用 Google Chat API。
• 创建一个独立的 Apps 脚本项目，然后开启高级聊天服务。
• 在清单中配置 Chat，方法是添加 addons.chat 对象以及任何必需的镜重范围 (oauthScopes) 或 HTTPS 网址前缀 (urlFetchWhitelist)。

为 Chat 应用选择显示名称、头像和说明

Chat 应用的名称、头像和说明会在 Chat 界面中向用户显示。如需与 Chat 应用互动，用户会通过以下方式查看或使用此类信息：

• 使用 @ 提及 Chat 应用，将其添加到聊天室或向其发送消息。
• 找到 Chat 应用并发起私信。在应用菜单中，私信会显示 Chat 应用的名称和头像。
• 用户可以在撰写栏中浏览 Chat 应用，并查看应用的名称、头像和说明。

在配置 Chat 应用之前，您必须准备以下信息：

字段	说明	格式
应用名称	Chat 应用的显示名称。	最多 25 个字母数字字符
头像网址	显示为 Chat 应用头像的图片。	指向方形图形图片（PNG 或 JPEG）的 HTTPS 网址。 建议的尺寸为 256 x 256 像素或更大。
说明	对 Chat 应用用途的简要说明。	最多 40 个字母数字字符

在下一部分中，您将在 Chat API 的配置设置中指定此信息。

在 Google Cloud 控制台中配置 Chat 应用

获取 Chat 应用详细信息后，打开您的 Cloud 项目并配置 Chat API：

1. 在 Google Cloud 控制台中，前往 Chat API 页面，然后点击配置页面：

   前往 Chat API 配置页面

2. 在应用信息下，填写应用名称、头像网址和说明字段。

3. 在互动功能下，点击启用互动功能将其切换到开启状态，然后完成以下操作：

   1. 在功能下，选中一个或多个复选框，以便用户安装和使用 Chat 应用：

      • 接收 1 对 1 消息：用户可以在用户与 Chat 应用之间的专用聊天室中安装 Chat 应用并与其发送消息。

      • 加入聊天室和群组对话：用户可以在包含多人的聊天室中添加 Chat 应用并与之互动。

   2. 在连接设置下，选择您要用于从 Chat 接收事件对象的架构：

      • 如需使用 HTTP 服务，请选择 HTTP 端点网址，然后提供网址。
      • 如需使用 Google Apps 脚本项目，请选择 Apps 脚本，然后为项目提供部署 ID。
      警告： 如果已填充 Apps 脚本部署 ID，则 Cloud 项目会与现有的 Google Workspace 插件相关联。如果您在 Chat API 中更新部署 ID，系统会更新您的插件部署 ID，这可能会影响您在 Google Workspace Marketplace 中的商品详情。如需查看您的插件配置，请参阅 Google Workspace Marketplace 文档中的在 Google Workspace Marketplace SDK 中配置您的应用。

   3. 可选：如需向多个端点或函数接收事件对象，请依次前往高级设置 > 触发器，然后为以下聊天触发器提供或更新回调函数：

      注意： 对于 Apps Script，如果您不更新触发器，则必须使用本部分中填充的相应回调函数（例如 onMessage、onAddedToSpace 和 onRemovedFromSpace）。
      • ADDED_TO_SPACE：用户将 Chat 应用添加到群组对话或聊天室，或安装 Chat 应用以接收一对一消息。
      • MESSAGE：用户向 Chat 应用发送消息。例如，向 Chat 应用发送私信，或在包含多人的聊天室中 @提及 Chat 应用。
      • REMOVED_FROM_SPACE：用户卸载或从聊天室中移除 Chat 应用。

   4. 可选：添加其他交互功能，例如正斜线命令或链接预览。

   5. 在公开范围下，指定您的电子邮件地址，以便您在发布到 Google Workspace Marketplace 之前安装和测试 Chat 应用。您最多可以指定 5 位个人，也可以指定一个或多个 Google Workspace 组织中的 Google 群组。

4. 可选：在 Logs 下，选中 Log errors to Logging 复选框以使用 Google Cloud Logging。如需了解详情，请参阅 Chat API 文档中的查询 Chat 应用的错误日志。

5. 点击保存。

保存配置后，您在 Chat API 的公开范围设置中指定的任何人都可以安装、测试或使用 Chat 应用。如需开始测试和调试 Chat 应用，请参阅 Chat API 文档中的测试 Google Chat 应用的互动功能。

现有 Google Workspace 插件的注意事项

与用于扩展其他 Google Workspace 应用的 Google Workspace 附加组件相比，Chat 应用需要不同的配置。如果您的插件扩展了其他 Google Workspace 应用，请考虑在配置 Chat 应用时遵循以下要求：

• 个人和 Google Workspace 管理员都必须能够从 Marketplace 安装您的插件。您可以在 Google Workspace Marketplace SDK 中配置这些安装设置。
• Chat 应用不会使用您在manifest的 addons.common 对象中为其他 Google Workspace 应用配置的名称和徽标。
• 对于发布到 Google Workspace Marketplace 的插件，您无法保存对 Google Chat API 配置设置所做的任何更改的草稿。更新并保存 Chat API 配置设置后，所有现有用户都可以使用更新后的 Chat 应用。如需更新购物平台商品详情，您可以在提交任何更改之前创建草稿。

• 如果您使用 Apps 脚本构建了插件：

  • 您必须使用与插件配置的其余部分相同的 Apps 脚本部署 ID。
  • 您无法使用 Apps Script 编辑器在 Chat 中安装测试部署。而是必须直接从 Chat 界面中安装它们。

• 如果您使用 HTTP 服务构建了插件，请在使用 Google Workspace 插件 API 创建的清单和部署中省略所有 Chat 应用配置详细信息。您在 Google Workspace Marketplace SDK 中指定的 HTTP 部署仅适用于其他 Google Workspace 应用。

相关主题

• 如需管理对 Chat API 的访问权限，请参阅 Google Chat API 文档中的配置 Google Chat API。
• 测试 Google Chat 应用的交互功能
• 发布 Google Chat 应用