最佳实践

请遵循以下关于插件设计的指南,提升用户的整体体验。

一般最佳实践

我们建议您针对自己开发的所有插件遵循以下最佳实践。

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

插件由 Apps Script 项目定义,这些项目必须归特定账号所有,或者放置在共享云端硬盘中。在编写插件代码之前,请确定哪个账号应拥有该项目,以及哪个账号应充当其发布商。此外,还要确定哪些账号将充当协作者,并确保这些账号有权访问脚本项目及其关联的 Cloud 平台项目

扩展 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 Script 项目中创建多个脚本文件。如果您将用于定义插件边栏和对话框的 HTML 和 JavaScript 放入专门的脚本文件中,则可以更轻松地管理复杂的插件。

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

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