了解如何设计、构建和发布 Google Workspace 插件:
- 确定您希望用户在哪些 Google Workspace 应用中使用您的插件。
- 设置插件的项目,然后选择所有者和协作者。
- 设计和配置插件的外观和行为。
- 构建插件。
- 验证插件的 OAuth 范围。
- 在一个或多个 Google Workspace 应用中测试该插件。
- 发布插件。
使用 Apps 脚本或 HTTP 构建插件。如需比较这两者,请观看视频“Apps 脚本与 HTTP 端点:您应该选择哪个?🤔”。
选择 Google Workspace 托管应用
您可以配置 Google Workspace 插件,使其显示在以下 Google Workspace 托管应用中:
- Gmail
- Google 日历
- Google Chat
- Google 文档
- Google 云端硬盘
- Google Meet
- Google 表格
- Google 幻灯片
如需为 Google Workspace 应用构建功能,请参阅扩展 Google Workspace 界面。
设置插件的项目并选择所有者和协作者
如果您在 Apps 脚本中构建插件,则需要同时创建 Apps 脚本项目和 Google Cloud 项目。如果您使用 Apps 脚本以外的语言构建插件,则只需创建 Google Cloud 项目。
如需构建插件,您必须同时配置脚本项目和云项目。
在开始开发插件之前,请选择一个用户账号来拥有项目,并决定哪些其他账号是协作者。项目的所有者负责创建和管理项目文件及相关设置,而协作者可以协助进行编码和测试。
Apps 脚本项目
在构建插件之前,请先查看 Apps 脚本配额和限制,以便使项目设计符合这些准则。Apps 脚本最适合开发用户群较小的个人或内部插件。如果您的插件需要支持大量用户、低延迟或对基础架构的完全控制,请考虑使用其他运行时。
在共享云端硬盘中构建插件的 Apps 脚本项目文件,这样就不会有任何单个账号拥有唯一的所有权。将插件脚本文件放在共享云端硬盘中可确保所有协作者都能访问该脚本项目。
发布插件时,发布者是单个用户账号。发布账号必须拥有对脚本项目的编辑权限,但不必是所有者。
如需创建 Apps 脚本项目,请参阅脚本项目。
Google Cloud 项目
向插件的云项目添加协作者。这样可确保您的团队始终可以访问该插件的 Cloud 设置。
如需创建 Google Cloud 项目,请参阅创建 Google Cloud 项目。
设计和配置插件的外观和行为
在构建插件之前,请先确定插件的外观和行为。考虑加购项可解决哪些使用场景问题。 先从基本设计入手,然后逐步完善。
如需有关如何设计插件用户体验的指南,请参阅 Google Workspace 加购项样式指南。
配置插件清单
在插件清单中实现设计。在清单中配置插件的外观和行为,包括插件扩展的 Google Workspace 托管应用。
如需了解详情,请参阅 Google Workspace 插件的清单。
随着您添加代码和功能,请根据需要更新清单,以定义所需的插件外观和行为。
配置 Google Chat 应用的外观和行为
如果您设计的加购项可扩展 Google Chat,请使用 Google Chat API 配置 Chat 应用的外观和行为。如需了解相关步骤,请参阅使用 Google Chat API。
构建插件
为插件实现基于卡片的界面。使用 Card 服务,或者如果您使用其他代码语言,请返回格式化的 JSON 以供界面呈现为卡片。
实现插件清单中指定的任何触发函数。如果您的插件使用 OAuth 连接到第三方服务,请为该服务配置 OAuth。
构建卡片
通过创建 Card 对象并添加微件来定义插件界面。清单中指定的触发函数必须返回单个 Card 对象或一个 Card 对象数组,这些对象表示插件界面的不同“页面”。该插件还可以创建和显示新卡片,以响应用户操作。
在 Apps 脚本中,使用 CardBuilder 类创建卡片。每张卡片都需要一个 CardHeader 和一个或多个 CardSections。使用构成界面的各个 widget 填充每个卡片部分。
互动 widget 通常与操作相关联,以定义其互动行为。
通过 CardBuilder 将所有版块和小部件添加到卡片后,调用 CardBuilder.build 以创建相应的 Card 对象。
使用内置的 Apps 脚本服务](/apps-script/guides/services/)(例如 CalendarApp)检索要在插件卡片中显示的信息。使用非 Google 服务中的数据。
如果您的插件需要访问需要 OAuth 的非 Google API,请配置并连接到相应服务 - 请参阅连接到非 Google 服务指南。
施工顺序
制作卡片时,请从顶部开始制作。请按以下顺序构建:
- 构建 widget。
- 将 widget 添加到卡片部分。
- 重复上述步骤,直到卡片部分包含所有 widget。
- 将卡片部分添加到卡片中。
这是因为,当您向卡片或卡片部分添加 widget 时,实际上添加的是该 widget 的副本。添加 widget 对象后,您对其所做的任何更改都不会反映在最终卡片中。
通用操作
使用通用操作来提供独立于上下文的功能。无论卡片如何,通用操作都是插件界面中提供的菜单项。所有已定义的通用操作都会显示在插件的卡片菜单中。
如需了解详情,请参阅通用操作。
验证插件 OAuth 范围
范围用于定义插件可以代表用户执行的操作。插件应仅具有运行所需的范围。
在插件项目中,设置插件范围,以确保插件使用尽可能最宽松的范围集。在插件清单中定义范围。
如需了解详情,请参阅范围。
测试插件
您可以先安装未发布的插件,然后测试该插件。 安装并授权后,您可以在账号中使用该插件,以测试其在所扩展的托管应用中的外观和行为。验证插件在不同情境和用户操作下的行为是否符合预期。
如需开始测试插件,请参阅以下指南:
发布插件
发布后,您的插件便可供他人使用。 在发布之前,请查看发布概览。发布是一个复杂的过程,需要做好准备。
Google Workspace 加购项会发布到 Google Workspace Marketplace。公开提供的插件需要先通过应用审核,然后才能发布。
如需了解详情,请参阅发布 Google Workspace 加购项。