本页面简要介绍了如何构建可扩展 Google Chat 的 Google Workspace 插件。
用于扩展 Chat 功能的 Google Workspace 插件可帮助用户执行以下任一操作:
- 预览 Chat 消息中的链接,并在不离开对话的情况下执行操作。
- 在 Google Workspace 应用中自动执行或执行任务。
- 接收有关外部工具或服务的提醒或通知。
Google Workspace 插件在 Chat 中的运作方式
在 Chat 中,插件会以 Google Chat 应用的形式向用户显示。为了与用户互动,Chat 应用可以执行以下操作:
开始使用
如需开始构建可在 Chat 中使用的 Google Workspace 插件,请参阅以下文档:
- 请尝试快速入门,使用 Google Apps 脚本或 HTTP 服务构建基本 Chat 应用。
- 使用 Chat API 配置 Chat 应用及其交互功能。
- 了解如何使用插件触发器、操作和事件对象构建 Chat 界面。
限制和已知问题
以下 Chat 和插件功能无法使用:
- Apps 脚本的卡片服务。如需使用聊天操作和构建卡片,请改为返回 JSON 对象。如需查看示例,请参阅打开 Interactive Dialog 和 Preview Links。
- 自定义授权卡。如需通过 Chat 对您的服务进行身份验证并授予授权,Chat 应用必须返回基本授权卡片。
- Chat 边栏中的插件首页。如果您为插件配置了首页触发器,则首页只会显示在该插件扩展的其他 Google Workspace 应用的边栏中。
- Chat 应用首页,显示在 Chat 应用私信的首页标签页中。
如果您要更新现有的 Google Workspace 插件,请考虑 Chat 应用的以下配置要求:
- Google Workspace Marketplace 安装设置必须允许个人和 Google Workspace 管理员安装该插件。
- Chat 会忽略插件manifest (
addons.common
) 中的所有常规配置设置。若要配置该插件在 Chat 中正常运行,您必须启用并配置 Chat API。如需了解相关步骤,请参阅配置 Google Chat 应用。 - 如果您使用 HTTP 服务进行构建,则必须启用 Google Workspace Add-ons API。REST 资源
deployment
和project
仅适用于其他 Google Workspace 应用中的插件部署。 - 如需在 Chat 中部署和测试插件,您必须使用 Chat API 的公开范围设置。系统会忽略您在 Google Workspace Marketplace SDK 中配置的所有公开范围或测试设置。如需在 Chat 中部署插件测试版,请参阅 Chat API 文档中的测试 Google Chat 应用的交互功能。
- 如果您的插件已发布到 Google Workspace Marketplace,您将无法保存对 Google Chat API 配置设置所做的任何更改的草稿。更新 Chat API 配置设置后,所有现有用户都会立即看到更新后的 Chat 应用。如需更新购物平台商品详情,您可以在提交任何更改之前创建草稿。