最佳实践

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

一般最佳实践

建议您为开发的所有插件采用以下最佳实践。

先确定插件的所有权,然后再开始

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

扩展 Google Workspace,而不是复制它

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

保持范围较小

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

避免过度依赖库

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

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

编辑器插件最佳实践

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

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

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

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

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