构建交互式 Google Chat 应用

本页概述了如何构建交互式 Google Chat 应用。交互式 Chat 应用以 Google Workspace 插件的形式构建,可扩展 Google Chat。

借助互动式 Chat 应用,用户可以执行以下任一操作:

  • 将 Chat 应用添加到 Chat 聊天室或私信。
  • 向包含文本、卡片和互动式界面元素的 Chat 应用发送消息或从这类应用接收消息。
  • 在与 Chat 应用进行 1 对 1 私信的首页标签页中,查看 App Home 卡片并与之互动。
  • 使用斜杠命令、快捷命令或消息操作提示聊天应用。
  • 预览聊天消息中的链接,无需离开对话即可采取行动。
  • 向 Chat 应用提交信息,例如在对话框或卡片消息中输入文本。
  • 自动执行或执行跨 Google Workspace 应用的任务,以及连接到外部工具或服务。

用户如何发现和使用互动式 Chat 应用

在 Chat 中,扩展 Chat 的插件会作为 Google Chat 应用显示给用户。用户可以通过多种方式发现并使用发布到 Marketplace 的聊天应用,包括:

  • 在 Google Chat 或 Marketplace 中搜索并安装 Chat 应用。
  • 与已添加到 Chat 聊天室的 Chat 应用互动。
  • 在 Google Workspace 管理员代表用户安装 Chat 应用后,用户可以在私信面板中发现该 Chat 应用。

如需开始使用 Chat 应用,Google Chat 用户可以向 Chat 应用发送私信,也可以将其添加到聊天室中。用户还可以通过 @提及 Chat 应用来添加该应用。如需了解详情,请参阅使用 Chat 应用。

以下示例展示了用户如何 @提及 Chat 应用以将其添加到聊天室:

通过在消息中输入 @ 将 Chat 应用添加到聊天室。

开始使用

如需开始构建互动式 Chat 应用,请参阅以下文档:

配置并创建基本的 Chat 应用

下表列出了有关配置 Chat API 和创建基本互动式 Chat 应用的文档,适用于每种 Google Chat 应用架构:

架构或任务 指南
配置 Chat API 配置 Google Chat API
快速入门
Apps 脚本 使用 Apps 脚本构建 Chat 应用
HTTP 服务 (Cloud Run 函数) 构建 HTTP Chat 应用
Pub/Sub 使用 Pub/Sub 构建 Chat 应用
Dialogflow CX 构建 Dialogflow CX Chat 扩展应用
Dialogflow ES 构建 Dialogflow ES Chat 应用
智能体开发套件 (ADK) AI 智能体 构建 ADK AI 智能体 Chat 应用
Agent2Agent (A2A) AI 智能体 构建 A2A AI 智能体 Chat 应用
A2UI AI 智能体 构建 A2UI AI 智能体聊天应用
Gemini Enterprise AI 智能体 构建 Gemini Enterprise AI 智能体聊天应用

构建互动功能

下表列出了用于构建互动式 Chat 应用功能的文档:

功能 指南
接收和响应用户互动 接收和回应用户互动
发送消息(回复互动或主动发送消息) 回复消息或 使用 Chat API 发送消息
响应斜杠命令、快捷命令和消息操作 响应指令
构建交互式对话框 打开互动式对话框
收集和处理卡片和对话框中的信息 读取用户在卡片上输入的表单数据
预览 Chat 消息中的链接 预览链接
在 1 对 1 私信中构建首页(应用首页) 为 Chat 应用构建首页
连接到外部系统和工具 将 Chat 应用与其他服务和工具相关联

Google Workspace 附加组件的限制和注意事项

由于 Chat 应用是作为扩展 Chat 的 Google Workspace 插件构建的,因此请注意以下功能限制:

  • AppSheet Chat 扩展应用架构在构建为 Google Workspace 插件时不可用。请改用 HTTP 服务、Apps 脚本、Dialogflow ES、Dialogflow CX 或 Pub/Sub 构建 Chat 应用。
  • Chat 不支持自定义授权卡片。为了从 Chat 中对您的服务进行身份验证并授予授权,Chat 应用必须返回基本授权卡片。
  • 不支持 Chat 边栏中的插件首页。如果您已在清单 (addons.common.homepageTrigger) 中配置首页触发器,则首页仅显示在您的插件所扩展的其他 Google Workspace 应用的边栏中。不过,您可以为 Chat 应用构建首页,该首页会显示在与 Chat 应用进行的 1 对 1 私信的首页标签页中。

如果您要扩展现有 Google Workspace 附加组件以使其可在 Chat 中运行,请考虑 Chat 应用的以下配置要求:

  • Google Workspace Marketplace 安装设置必须允许个人用户和 Google Workspace 管理员安装该插件。
  • 插件的清单 (addons.common) 中的任何常见配置设置都会在 Chat 中被忽略。如需将加购项配置为可在 Chat 中使用,您必须启用并配置 Chat API。如需了解相关步骤,请参阅配置 Google Chat API。
  • 如需在 Chat 中部署和测试插件,您必须使用 Chat API 的公开范围设置。您在 Google Workspace Marketplace SDK 中配置的所有公开范围或测试设置都会被忽略。如需在 Chat 中部署插件的测试版本,请参阅测试 Google Chat 应用的互动功能。
  • 如果您的插件已发布到 Google Workspace Marketplace,您将无法保存对 Google Chat API 配置设置所做的任何更改的草稿。更新 Chat API 配置设置后,所有现有用户都可以立即使用更新后的 Chat 应用。如需更新您的 Marketplace 详情,您可以在提交任何更改之前创建草稿。

非插件型 Chat 应用:构建交互式 Google Chat 应用

非 Google Workspace 插件的 Chat 应用是仅限 Chat 的应用,它们接收 Chat API 互动事件 (Event),而不是 Google Workspace 插件事件对象 (EventObject) 和操作。

如果您维护的 Chat 应用不是插件,则可以:

  • 将不是插件的 Chat 扩展应用转换为可扩展 Google Chat 的 Google Workspace 插件。请参阅将 Google Chat 应用转换为 Google Workspace 加载项。
  • 如需了解请求和响应格式,请参阅此文档集中每个互动功能指南底部的可展开的非插件聊天应用部分。