构建编辑器插件

构建编辑器插件时,请遵循以下一般流程:

  1. 创建一个 Apps 脚本项目。
  2. 使用内置的 Apps 脚本 HTML 服务编写代码来定义插件的外观和行为。
  3. 测试插件。
  4. 发布该插件。

创建脚本项目

编辑器插件是一个独立的 Apps 脚本项目。独立脚本指南提供了有关创建新项目的说明。您也可以直接打开新脚本。如果您这样做,项目文件(最初命名为 Untitled project)会放置在根云端硬盘文件夹中。

协作

当您与他人协作开发插件时,插件项目由单个用户账号拥有。发布插件时,单个用户账号会充当发布商。发布账号必须对插件脚本项目拥有修改权限,但不需要是项目所有者。

请务必避免因项目所有者离开贵组织而导致您无法访问插件代码或设置的情况。

为避免失去对插件代码的访问权限,我们建议您在协作开发插件时使用共享云端硬盘。将您的插件脚本文件放在共享云端硬盘中可确保项目没有单独的所有者。

我们还建议您将协作者添加到脚本项目的 Cloud Platform (GCP) 项目。这有助于确保团队中的某位成员始终可以访问该插件在云端的设置。

编写插件代码

创建脚本项目后,您就可以开始编写代码来定义插件外观和行为。您可以使用 Apps Script 的 HtmlService 使用传统 HTML 和 CSS 构建插件界面(对话框和边栏)。编辑器插件还可以定义自定义菜单项

在编写代码时,请参阅编辑器插件样式指南,了解如何设计插件用户体验。此外,请务必了解您的插件可能会遇到的不同授权生命周期状态,并针对这些状态进行编程。

测试插件

您可以在发布编辑器插件之前对其进行测试,以确保其行为符合预期。如需进行测试,您需要创建测试配置,并使用测试文档、电子表格、表单或演示文稿。

如需了解详情,请参阅测试编辑器插件

发布插件

发布您的插件后,您可以将其提供给其他用户,无论是公开发布,还是仅面向您网域中的用户发布。在开始发布流程之前,请务必查看发布概览

编辑器插件会发布到 Google Workspace Marketplace。公开提供的插件必须先完成插件审核,然后才能发布。

如需了解详情,请参阅发布编辑器插件