本页面概述了如何构建扩展 Google Chat 功能的 Google Workspace 插件。
扩展 Chat 的 Google Workspace 加载项可以帮助用户执行以下操作:
- 预览聊天消息中的链接,无需离开对话即可执行操作。
- 自动执行或跨 Google Workspace 应用执行任务。
- 接收有关外部工具或服务的提醒或通知。
Google Workspace 加载项在 Chat 中的运作方式
在 Chat 中,插件会作为 Google Chat 应用显示给用户。为了与用户互动,Chat 应用可以执行以下操作:
- 发送包含文本、卡片和交互式 UI 元素的消息。
- 响应 个快速命令。
- 响应 slash 命令。
- 打开 对话框,帮助用户完成多步骤流程,例如填写表单数据。
- 预览链接在消息中附加包含有用信息的卡片,使用户可以直接在对话中执行操作。
开始使用
如需开始构建可在 Chat 中运行的 Google Workspace 加载项,请参阅以下文档:
- 尝试使用 Google Apps Script 或 HTTP 服务 构建一个基本的聊天应用程序的快速入门指南。
- 使用 Chat API 配置 Chat 应用及其互动功能。
- 了解您可以采取哪些措施构建聊天界面使用附加触发器、操作和事件对象。
限制和已知问题
以下聊天功能和附加服务无法使用:
- Chat 扩展应用架构 Dialogflow、Pub/Sub 和 AppSheet 不可用。您必须使用 Apps 脚本或 HTTP 服务来构建 Chat 应用。
- Apps 脚本的 Card 服务。如需使用聊天操作和构建卡片,请改为返回 JSON 对象。例如,请参阅打开交互式对话框和预览链接。
- 自定义授权卡片。如需对 Chat 中的服务进行身份验证并授予授权,Chat 应用必须返回基本授权卡片。
- Chat 边栏中的插件首页。如果您已为插件配置首页触发器,则首页仅显示在插件所扩展的其他 Google Workspace 应用的边栏中。
- Chat 应用首页,显示在与 Chat 应用的私信的首页标签页中。
如果您要更新现有的 Google Workspace 加载项,请考虑 Chat 应用的以下配置要求:
- Google Workspace Marketplace 安装设置必须允许个人用户和 Google Workspace 管理员安装该插件。
- 在 Chat 中,插件清单 (
addons.common) 中的任何通用配置设置都会被忽略。如需配置该插件以在 Chat 中运行,您必须启用并配置 Chat API。如需了解相关步骤,请参阅配置 Google Chat 应用。 - 如需在 Chat 中部署和测试插件,您必须使用 Chat API 的公开范围设置。您在 Google Workspace Marketplace SDK 中配置的任何公开范围或测试设置都会被忽略。如需在 Chat 中部署插件的测试版,请参阅 Chat API 文档中的测试 Google Chat 应用的互动功能。
- 如果您的插件已发布到 Google Workspace Marketplace,则无法保存对 Google Chat API 配置设置 的任何更改的草稿。 更新聊天 API 配置设置后,所有现有用户将立即可以使用更新后的聊天应用程序。要更新您的 Marketplace 商品信息,您可以在提交任何更改之前创建草稿。