升级已发布的插件

如果您已构建并发布了用于扩展 Gmail 或日历的插件,则可以将其升级为 Google Workspace 插件。本页中的说明详细介绍了如何将 Google Workspace 功能添加到现有的 Gmail 或 Google 日历插件中,然后发布升级后的插件,以便用户发现和安装。

您可以将新功能转移到原始插件中,以保留您的 Google Workspace Marketplace 商品详情、安装量和用户。升级后,您还可以利用新的 Google Workspace 附加功能,例如首页

第 1 步:复制插件的 Apps 脚本项目

升级后的插件会使用与已发布的插件相同的 Google Cloud 项目,但务必创建并使用基础 Apps 脚本项目的副本,以免现有用户在测试升级版本时受到影响。升级原始脚本项目的副本还意味着您始终可以访问原始代码,并可以稍后重新部署(如果需要)。

  1. 打开现有的 Gmail 插件或日历会议插件 Apps 脚本项目。
  2. 点击左侧的概览
  3. 点击右侧的“复制”图标
  4. 在左侧,依次点击项目设置 &gt 更改项目
  5. 点击 GCP 项目编号
  6. 输入与现有已发布的插件 Apps 脚本项目关联的同一项目编号
  7. 点击设置项目

第 2 步:集成 Google Workspace 附加功能

您必须设计和实现任何要添加到插件的附加功能。 Google Workspace

  1. 规划要在插件的首页卡片中显示哪些内容,以及这些内容应显示在 Gmail、Google 日历、云端硬盘还是三种主机的任意组合中。如果您希望一个首页在多个主机中,请确定它是否可以是同一个首页,或者您是否想要为每个主机使用自定义首页卡片。
  2. 在复制的插件 Apps 脚本项目中,使用 homepageTrigger 函数构建首页卡片。请务必提供所需的任何支持函数或逻辑来控制新的首页界面。
  3. 考虑添加用户的操作触发的上下文卡片,例如打开 Gmail 邮件会话日历活动

  4. 请更新插件(在微件回调函数或上下文触发器函数中)中对事件对象的所有访问权限,以使用更新后的事件对象结构。 新结构仍然包含 Gmail 和 Google 日历会议插件使用的相同事件对象字段,但这些原有字段已废弃,最终将被移除。

第 3 步:更新插件的清单

Google Workspace 插件清单结构中存储配置信息的方式与 Gmail 插件和日历会议插件所使用的结构相比发生了很大变化。升级插件时,您必须根据下表更新 Apps 脚本项目的清单字段。您必须将所有相关子属性更新为新的 addOns 属性。

此外,请务必根据需要更新清单的 oauthScopes 字段,以反映更新后的插件所需的权限。

如需详细了解插件清单 Google Workspace ,请参阅清单

Gmail 插件

原始清单字段 需要执行相关操作
gmail.composeTrigger 移至 addOns.gmail.composeTrigger
gmail.contextualTriggers[] 将列表移至 addOns.gmail.contextualTriggers[]
gmail.logoUrl 移至 addOns.common.logoUrl
gmail.name 移至 addOns.common.name
gmail.openLinkUrlPrefixes[] 将列表移至 addOns.common.openLinkUrlPrefixes[]
gmail.primaryColor 移至 addOns.common.layoutProperties.primaryColor
gmail.secondaryColor 移至 addOns.common.layoutProperties.secondaryColor
gmail.universalActions[] 将列表移至 addOns.common.universalActions[]
gmail.universalActions[].text 将每个 gmail.universalActions[].text 字段移至相应的 addOns.common.universalActions[].label 字段。
gmail.useLocalFromApp 移至 addOns.common.useLocaleFromApp

Google 日历会议插件

原始清单字段 需要执行相关操作
calendar.createSettingsUrlFunction 移至 addOns.calendar.createSettingsUrlFunction
calendar.conferenceSolution[] 移至 addOns.calendar.conferenceSolution[]
calendar.logoUrl 移至 addOns.common.logoUrl
calendar.name 移至 addOns.common.name

第 4 步:测试已升级的插件

如需在发布之前测试已升级的插件,请参阅测试 Google Workspace 插件

第 5 步:申请审核升级后的插件

所有插件 Google Workspace 无论是升级后的插件还是从头开始构建的插件,都必须获得批准,然后才能在 Google Workspace 市场中上架。

请按照以下步骤提交插件以供审核:

  1. 确保您的插件符合所有插件发布要求

  2. 使用要发布的代码版本,为插件(在新 Apps 脚本项目中)创建版本化部署。不要尝试使用 Head 部署进行发布。

  3. 如果您在升级插件时添加了新范围,则必须请求 OAuth 验证。例如,如果您的 Gmail 插件在Google Workspace 插件版本中使用了新的云端硬盘或日历范围,那么您必须提交这些新范围进行验证。验证通常需要几天的时间才能完成,因此请尽早开始该流程。在继续执行第 6 步之前,请确保插件已经过验证。

第 6 步:提供升级后的插件

  1. 打开 Google Workspace Marketplace SDK。

  2. 点击左侧的 Configuration(配置)。此面板包含一个表单,您可以在其中提供插件的相关信息。

  3. 更新商品详情的简短说明、详细说明和屏幕截图,以反映插件的新功能 Google Workspace 。

  4. 扩展程序下,点击升级到Google Workspace 插件按钮。在显示的文本框中,输入您在 Google Workspace 上一步中为插件创建的新部署 ID。如果您的部署 ID 有效,则会显示受支持的主机列表。

  5. 如果您向插件中添加了 Google Workspace 新的范围,请务必将其添加到 Configuration 页面的 OAuth 2.0 范围部分。该部分列出的范围应与插件清单中列出的范围完全匹配。

  6. 验证您在表单中输入的信息是否正确。然后,点击保存更改

在此附加服务升级过程中,如果您有任何疑问或遇到问题,请 Google Workspace 与我们联系。

常见问题解答

以下是有关插件升级的常见问题:

我可以升级编辑器插件吗?

大多数编辑器插件都可以 Google Workspace 迁移到插件。但是,它们不能像 Gmail 和 Google 日历这样的插件那样 Google Workspace 升级为插件。

如果您想将编辑器插件迁移到 Google Workspace 插件,则需要将插件的界面从 HTML 重写为基于卡片的界面,并将 JavaScript 处理更新为卡片服务

现有编辑器插件中的部分服务可能无法在银行卡服务中使用。例如,如果您的编辑器插件包含文件选择器,就没有与卡片服务相同的插件插件。 Google Workspace

我可以构建单独的插件 Google Workspace 并保留现有的插件吗?

欢迎您为不同的品牌名称 Google Workspace 开发其他插件,但我们不允许使用与您的品牌插件相同的品牌名称。 Google Workspace 如果您有疑问或想要申请豁免,请与我们联系

插件升级后,我的用户需要重新为其授权吗?

只要您的插件使用相同的基础 Cloud Platform (GCP) 项目 Google Workspace (带有关联的 OAuth 客户端 ID),您的用户就无需重新授权之前为原始插件授权的权限。但是,如果您在升级过程中添加了新范围,则您的用户必须在首次使用插件的 Google Workspace版本时授权这些新范围。

我可以将 Chrome 扩展程序升级为 Google Workspace 插件并转移用户吗?

不可以。您无法转移 Chrome 扩展程序的用户、安装和商家信息评价。您必须创建新的插件 Google Workspace 并将您的 Chrome 扩展程序用户定向到 Google Workspace Marketplace。

我可以将多个插件与 Google Workspace 插件绑定吗?

请参阅同时列出应用集成