升级旧版 Gmail 和 Google 日历插件

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

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

第 1 步:为插件的 Apps 脚本项目创建副本

升级后的插件与您发布的插件使用同一个 Google Cloud 项目 但请务必为底层应用创建副本 为项目编写脚本,以便在测试时不影响现有用户 升级后的版本。同时升级原始脚本项目的副本 意味着您始终可以访问原始代码,并且 。

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

第 2 步:集成 Google Workspace 插件

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

  1. 计划在插件中显示哪些内容 首页卡片以及 在 Gmail、Google 日历、Google 云端硬盘或以上三者的任意组合中显示 主机。如果您希望在多个托管商处拥有同一个首页,请确定 可以是同一个首页,或者如果您希望针对每个托管商使用自定义首页卡片。
  2. 在您复制的 Apps 脚本插件项目中,构建主页 包含homepageTrigger的卡片 函数。请务必包含 控制新的首页界面。
  3. 您可以考虑添加由用户的操作(如打开 Gmail 邮件会话日历活动

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

第 3 步:更新插件的清单

配置信息在 清单结构 与 Gmail 插件的结构相比,Google Workspace 插件发生了很大变化 和 Google 日历会议插件使用。在升级插件时,您必须根据 下表所示。您必须将所有相关的子媒体资源更新为新的 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 Marketplace 中上架。

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

  1. 请确保您的插件满足 附加发布要求

  2. 创建版本控制的部署 您的 Google Workspace 插件(位于新的 Apps 脚本项目中)的 和要发布的代码请勿尝试使用标题发布内容 部署。

  3. 如果您在升级插件时添加了新范围,则必须 请求 OAuth 验证。 例如,如果您的 Gmail 插件在 Google Workspace 插件版本,您必须提交这些新范围进行验证。 验证通常需要几天时间才能完成,因此请按照以下方式开始验证流程 。请确保您的插件已通过验证,然后再继续操作 到第 6 步。

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

  1. 打开 Google Workspace Marketplace SDK。

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

  3. 更新以下内容的简短说明、详细说明和屏幕截图: 以反映 Google Workspace 插件的新功能。

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

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

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

如果您在此次 Google Workspace 插件升级过程中有疑问或遇到问题 流程,请与我们联系

常见问题解答

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

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

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

如果您想将编辑器插件迁移到 Google Workspace 插件,则需要执行以下操作: 将该插件的界面从 HTML 重写为基于卡片的 界面,并更新您的 JavaScript Card 服务的处理。

现有编辑器插件中的某些服务可能无法在 银行卡服务。例如,如果您的编辑器插件包含文件选择器,则 无法通过适用于 Google Workspace 插件的 Card Service 的等效功能获得。

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

欢迎您以不同品牌名称开发其他 Google Workspace 插件, 但我们不允许在 Google Cloud 控制台中单独使用 使用与您的 Google Workspace 插件相同的品牌名称。如果您有疑问或想要请求 请与我们联系

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

只要您的 Google Workspace 插件使用相同的底层基础架构, Cloud Platform (GCP) 项目 关联 OAuth 客户端 ID 后,您的用户就无需重新授权 授予的权限。但是,如果 您在升级过程中添加新范围时,您的用户必须对这些范围进行授权 新范围(在首次使用 Google Workspace 时) 版本的插件。

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

不可以。您无法转移 Chrome 扩展程序的用户、安装和商品详情 审核。您必须创建新的 Google Workspace 插件,并定向到您的 Chrome 用户 Google Workspace Marketplace 的扩展程序。

我的 Google Workspace 插件可以捆绑多个插件吗?

请参阅一起列出应用集成