在构建编辑器插件之前,请查看 Apps 脚本配额和限制,确保您的项目设计符合这些准则。在开发过程的早期阶段熟悉这些限制有助于防止日后出现潜在问题。Apps 脚本非常适合为自己、团队或组织开发轻量级插件。不过,如果您打算构建需要处理大量用户、延迟时间短或需要完全控制基础架构的大规模插件,请考虑在其他运行时环境中开发 Google Workspace 插件。
构建编辑器插件时,请遵循以下一般流程:
- 创建 Apps 脚本项目。
- 使用内置的 Apps 脚本 HTML 服务编写代码来定义插件的外观和行为。
- 测试插件。
- 发布插件。
创建脚本项目
编辑器插件是一个独立的 Apps 脚本项目。独立脚本指南提供了创建新项目的说明。您也可以直接打开新脚本。
如果您这样做,项目文件(最初名为 Untitled project)将放置在您的根云端硬盘文件夹中。
协作
当您与他人协作开发插件时,插件项目归单个用户账号所有。发布插件时,单个用户账号会充当发布者。发布账号必须对插件脚本项目拥有修改权限,但无需是项目所有者。
请务必避免因项目所有者离开组织而导致您无法访问插件的代码或设置的情况。
为防止无法再访问插件代码,我们建议您在协作开发插件时使用共享云端硬盘。将插件脚本文件放在共享云端硬盘中,可确保没有单个账号是项目的唯一所有者。
另建议您向脚本项目的 Cloud Platform (GCP) 项目添加协作者。 这有助于确保团队中的某个人始终可以访问该插件的云设置。
为插件编写代码
创建脚本项目后,您就可以开始编写代码来定义插件的外观和行为。您可以使用常规 HTML 和 CSS,通过 Apps 脚本的 HtmlService 构建插件界面(对话框和侧边栏)。编辑器插件还可以定义自定义菜单项。
在编写代码时,请参阅编辑器插件样式指南,了解有关如何设计插件用户体验的指南。此外,请务必了解并针对插件可能遇到的不同授权生命周期状态进行编程。
测试插件
您可以在发布编辑器插件之前对其进行测试,以确保其行为符合预期。测试需要您创建测试配置,并使用测试文档、电子表格、表单或演示文稿。
如需了解详情,请参阅测试编辑器插件。
发布插件
发布插件后,其他人(公开或仅限您网域中的用户)即可使用该插件。在开始发布流程之前,请务必查看出版物概览。
编辑器插件会发布到 Google Workspace Marketplace。公开提供的插件必须先完成插件审核,然后才能发布。
如需了解详情,请参阅发布编辑器插件。