配置 Google Chat 应用

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

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

前提条件

HTTP

Apps 脚本

为您的 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。

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

      • 已添加到聊天室：用户将 Chat 应用添加到群组对话或聊天室，或安装 Chat 应用以接收一对一消息。
      • 消息：用户向 Chat 应用发送消息。例如，向 Chat 应用发送私信，或在包含多人的聊天室中用“@”提及 Chat 应用。
      • 从聊天室中移除：用户从聊天室卸载或移除 Chat 应用。
      • 应用命令：用户在 Chat 应用中使用快捷命令或斜杠命令。

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

    5. 在 Visibility（可见性）下，指定您的电子邮件地址，以便在将 Chat 应用发布到 Google Workspace Marketplace 之前安装和测试 Chat 应用。您最多可以指定五个个人，或者您的 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 插件相比，聊天应用需要的配置不同。如果您的插件扩展其他 Google Workspace 应用，请在配置 Chat 应用时考虑以下要求：

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

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

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