安装插件并向其授权

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

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

安装插件

您必须先安装插件,然后才能使用该插件。安装后,该插件可在其扩展的 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 服务使用 Google Workspace 插件

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

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

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

如需了解详情,请参阅将 Google Workspace 插件连接到第三方服务

第三方会议系统

用于扩展 Google 日历的 Google Workspace 插件还可以添加额外的会议解决方案,让用户在修改 Google 日历活动时可以选择第三方会议系统。如果您的插件提供的会议选项要求用户登录,则您的插件必须允许用户登录。

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

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

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

授权未发布的编辑器插件

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

为插件取消授权

在开发插件时,建议您取消对这些插件的授权,以便重新测试授权流程。

您可以通过执行以下操作来取消对插件的授权:

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

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