安装插件并向其授权

用户必须先安装并授权插件,然后才能打开和使用它。由于这些步骤是插件用户体验的第一部分,因此您应先了解这些步骤,然后再开始创建自己的插件。

本文档部分介绍了用户如何安装、授权和开始使用插件。

安装插件

您必须先安装插件,然后才能使用它。安装后,该插件将在其扩展的 Google Workspace 托管应用中提供。

您可以通过 Google Workspace 托管应用或 Google Workspace Marketplace 安装已发布的插件。网域管理员还可以代表其用户从 Google Workspace Marketplace 安装插件。您还可以安装您正在开发的未发布插件,以便对其进行测试。首次使用已安装的插件之前,您必须先授权该插件。

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

授权插件

安装插件后,该插件将在其扩展的 Google Workspace 托管应用中可用。当用户首次尝试使用该插件时,托管应用会向其显示授权卡片或对话框。此卡片会说明该插件需要获得哪些权限才能为用户执行操作,例如访问当前 Google 表格的内容。然后,用户可以授予这些权限,并允许该插件继续运行。如果用户拒绝授予插件权限,则无法使用该插件。

编辑器插件使用的授权模型与 Google Workspace 插件不同。由于编辑器插件会在 Google 云端硬盘文件上运行,因此编辑器授权模型定义了在将插件与各个文件搭配使用时会出现的各种授权模式。在开发编辑器插件时,请务必了解不同的模式以及插件如何在这些模式之间切换。

授权已发布的插件

安装已发布的插件后,系统会立即开始授权流程:

  1. 系统会提示您选择一个账号来安装该插件。
  2. 然后,系统会显示该插件运行所需的授权列表,以便您了解该插件尝试执行的操作。仔细查看此列表,如果您仍想授予授权,请点击允许。这样就可以使用该插件了。
  3. 现在,您可以通过它扩展的托管应用运行它。如果应用已在浏览器标签页中打开,您可能需要刷新该标签页,才能使用该插件。

如果您安装的插件日后更新,并且需要您授予尚未授予的额外授权,系统会在您下次使用该插件时提示您提供这些权限。

授权未发布的 Google Workspace 插件

插件授权卡

未发布的插件与已发布的插件采用不同的授权流程,因为它们尚未在 Google Workspace Marketplace 中列出。安装未发布的插件后,系统不会立即要求您授权。而是在您首次尝试使用该插件时启动授权流程。

运行插件时,它会确定是否需要任何用户授权。如果需要授权,该插件会显示授权卡片。在插件首次执行时,始终需要授权;如果新版插件使用之前未获授权的服务,也可能需要授权。授予访问权限按钮会提供一个对话框窗口,供用户为该插件授予或拒绝授予访问权限。

为 Google Workspace 插件授权使用非 Google 服务

Google Workspace 插件可能会连接到本身需要授权的第三方服务。连接到此类服务的 Google Workspace 插件需要用户执行两项单独的操作:

  • 在插件安装或首次启动时对插件本身进行授权。
  • 首次访问非 Google 服务时授予的权限。

如果您正在开发的 Google Workspace 插件需要使用 OAuth 访问非 Google 服务,则必须在构建插件时为该服务配置连接。

如需了解详情,请参阅将 Google Workspace 插件与第三方服务相关联

第三方会议系统

用于扩展 Google 日历的 Google Workspace 插件还可以添加其他会议解决方案,让用户在修改 Google 日历活动时选择第三方会议系统。如果您的插件提供需要用户登录的会议选项,则必须让用户能够执行此操作。

如果用户尝试在不进行必要登录的情况下使用您的插件创建会议,会议解决方案的 onCreateFunction 方法应返回一个 ConferenceData 对象,其中包含一个包含身份验证网址ConferenceError

收到此对象后,Google 日历会在活动修改界面中创建一个登录按钮,该按钮会链接到该插件提供的身份验证网址。然后,用户可以在进一步使用该插件之前使用此按钮登录第三方系统。

如需详细了解如何使用 ConferenceError 处理授权,请参阅创建第三方会议

授权未发布的编辑器插件

最佳做法是在开发编辑器插件时对其进行测试。授权流程与已发布的编辑器插件的授权流程完全相同,只不过该流程会在您首次尝试测试插件时启动。如果您日后重新测试同一插件,系统不会再次提示您授权。

撤消对插件的授权

在开发插件时,取消授权插件会很有用,这样您就可以重新测试授权流程。

如需撤消对某个插件的授权,请执行以下操作:

  1. 打开账号安全控制台
  2. 找到并点击您要撤消授权的插件。
  3. 点击撤消访问权限

在撤消对插件授权后,再次运行该插件时,系统会再次显示授权流程。

卸载插件

如需卸载从 Google Workspace Marketplace 安装的插件,请参阅卸载 Marketplace 中的应用或插件

如需卸载未发布的 Apps 脚本内置插件,请参阅卸载未发布的插件