最佳实践

请遵循这些插件设计指南,提升用户的整体体验。

一般最佳实践

建议您为您开发的所有插件都遵循以下最佳实践。

在开始之前确定插件所有权

插件是由 Apps 脚本项目定义的,必须归特定帐号所有或位于共享云端硬盘中。在对插件进行编码之前,请确定哪个帐号应该拥有该项目,以及哪个帐号将作为其发布商。此外,还要确定哪些帐号充当协作者,并确保这些帐号可以访问脚本项目及其关联的 Cloud Platform 项目

扩展 Google Workspace,而不要复制

插件旨在为它们扩展的 Google Workspace 应用提供新功能,或自动执行复杂的任务。如果插件只是复制应用内已有的功能,或者不会复制重大的工作流改进,很可能无法通过插件审核进行发布。

缩小范围

明确定义范围时,请始终尽可能选择权限最小的范围。例如,如果您的插件请求只需要读取权限,则不要授予使用 https://www.googleapis.com/auth/calendar 范围的用户日历的完整访问权限。如需获得只读权限,请使用 https://www.googleapis.com/auth/calendar.readonly 范围。

避免过度依赖库

与所有 Apps 脚本代码都包含在单个脚本项目中相比,使用 Apps 脚本可能会导致插件运行速度更慢。尽管 Apps 脚本库适用于插件,但如果使用插件,性能可能会下降。避免在项目中包含不必要的库,并考虑如何减少插件对它们的依赖。

上述延迟时间仅适用于用作服务器端库的 Apps 脚本项目。您可以随意使用 jQuery 等客户端 JavaScript 库,而不会遇到这种延迟。

编辑器插件最佳做法

以下最佳实践仅适用于编辑器插件}。

将界面 HTML 和客户端 JavaScript 放入其各自的脚本文件中

您可以在一个 Apps 脚本项目中创建多个脚本文件。如果您将定义插件边栏和对话框的 HTML 和 JavaScript 放置在专门的脚本文件中,就能更轻松地管理复杂的插件。

在不同的授权模式下全面测试

测试插件时,请务必尝试使用具有不同文件和授权状态的配置。