配置 Google Chat 应用

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

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

前提条件

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

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

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

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

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

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

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

在 Google Cloud 控制台中，您可以配置 Chat 应用的详细信息，这些信息会显示在 Chat 中，包括显示名称、头像和说明。这些详细信息仅显示在 Chat 中。如需将您的聊天应用发布到 Marketplace，您还必须指定聊天应用的 Marketplace 商品详情中显示的信息。

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

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

    前往“Chat API 配置”页面

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

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

    1. 在功能下，选择加入聊天室和群组对话，以使您的 Chat 应用可供安装和使用。

      默认情况下，用户可以在用户与 Chat 应用之间的专用聊天室中安装 Chat 应用并与该应用互动。用户还可以在有多人的聊天室中添加 Chat 应用并与该应用互动。

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

      • 如需使用 HTTP 服务，请选择 HTTP 端点网址，然后提供网址。
      • 如需使用 Google Apps 脚本项目，请选择 Apps 脚本，并提供项目的部署 ID。

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

      • 已添加到聊天室：用户将 Chat 应用添加到群组对话或聊天室，或者为 1 对 1 信息安装 Chat 应用。
      • 消息：用户向 Chat 应用发送消息。例如，向 Chat 应用发送私信，或在多人聊天室中使用“@”提及 Chat 应用。
      • 从聊天室中移除：用户从聊天室中卸载或移除 Chat 应用。
      • 应用命令：用户通过 Chat 应用使用快速命令或斜杠命令。

    4. 可选：添加其他互动功能，例如快速命令、斜杠命令或链接预览。

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

  4. 可选：在日志下，选中将错误记录到 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 中配置这些安装设置。
  • 聊天应用不会使用您在清单的 addons.common 对象中为其他 Google Workspace 应用配置的名称和徽标。
  • 对于已发布到 Google Workspace Marketplace 的插件，您无法保存对 Google Chat API 配置设置所做的任何更改的草稿。 更新并保存 Chat API 配置设置后，所有现有用户都可以使用更新后的 Chat 应用。如需更新您的应用商店商品详情，您可以在提交任何更改之前创建草稿。

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

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