升級舊版 Gmail 和日曆外掛程式

如果您已經建立並發布外掛程式來擴充 Gmail 或 Google 日曆,可將其升級至 Google Workspace 外掛程式。本頁的操作說明詳細說明如何將 Google Workspace 功能新增至現有 Gmail 或日曆外掛程式,然後發布升級後的外掛程式,讓使用者能夠找到及安裝您的應用程式。

您可以將新功能轉移至原本的外掛程式,以便保留 Google Workspace Marketplace 資訊、安裝項目和使用者。升級後,您也可以利用 Google Workspace 外掛程式的新功能,例如首頁

步驟 1:複製外掛程式的 Apps Script 專案

升級版外掛程式使用與已發布外掛程式相同的 Google Cloud 專案。不過,請務必建立及使用基礎 Apps Script 專案的副本,以免現有使用者在測試已升級版本時受到影響。升級原始指令碼專案的副本也代表您隨時可以存取原始程式碼,日後有需要時再重新部署。

  1. 開啟現有 Gmail 外掛程式或日曆會議外掛程式 Apps Script 專案。
  2. 按一下左側的「總覽」
  3. 按一下右側的「建立副本」圖示
  4. 按一下左側的「專案設定」>「變更專案」
  5. 按一下「GCP 專案編號」
  6. 輸入與已發布的 Apps Script 外掛程式專案相關聯的相同專案編號
  7. 按一下「設定專案」

步驟 2:整合 Google Workspace 外掛程式

您必須設計並實作任何想要新增至外掛程式的 Google Workspace 外掛程式功能。

  1. 規劃要在外掛程式首頁資訊卡顯示的內容,以及是否應顯示在 Gmail、日曆、雲端硬碟,或者這三個主機的任意組合中。如果您想讓多個主機設定同一個首頁,請決定要將首頁設為同一個首頁,還是為每個主機自訂首頁資訊卡。
  2. 在複製的 Apps Script 專案中,使用 homepageTrigger 函式建構首頁資訊卡。請務必加入控制新版首頁介面所需的所有支援功能或邏輯。
  3. 建議您新增由使用者動作觸發的內容資訊卡,例如開啟 Gmail 郵件串日曆活動

  4. 更新外掛程式中對事件物件的任何存取設定 (小工具回呼函式或內容相關觸發條件函式中),使用更新後的事件物件結構。新結構仍會包含 Gmail 和 Google 日曆會議外掛程式使用的事件物件欄位,但這些原始欄位會淘汰,最終會遭到移除。

步驟 3:更新外掛程式的資訊清單

在 Google Workspace 外掛程式的資訊清單結構中,設定資訊的儲存方式與 Gmail 外掛程式和 Google 日曆會議外掛程式的架構有顯著不同。升級外掛程式時,您必須按照下表更新外掛程式的 Apps Script 專案資訊清單欄位。您必須將所有相關子資源更新為新的 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 Script 專案中)。請勿嘗試使用頭部部署發布。

  3. 如果您在升級外掛程式時新增了範圍,則必須要求 OAuth 驗證。舉例來說,如果您的 Gmail 外掛程式在 Google Workspace 外掛程式版本中使用新的雲端硬碟或日曆範圍,您必須提交這些新範圍進行驗證。驗證程序通常需要幾天才會完成,因此請盡早開始程序。請先確認外掛程式已通過驗證,再繼續進行步驟 6。

步驟 6:啟用升級版外掛程式

  1. 開啟 Google Workspace Marketplace SDK。

  2. 按一下左側的「設定」。這個面板包含一份表單,您可以在其中提供外掛程式的相關資訊。

  3. 更新商家資訊的簡短說明、詳細說明和螢幕截圖,以反映 Google Workspace 外掛程式的新功能。

  4. 在「Extensions」(擴充功能) 下方,按一下 [Upgrade to Google Workspace Add-on] (升級至 Google Workspace 外掛程式) 按鈕。在隨即顯示的文字方塊中,輸入您在上一步中為 Google Workspace 外掛程式建立的新「部署 ID」。如果部署 ID 有效,系統會顯示支援的主機清單。

  5. 如果您已在 Google Workspace 外掛程式中新增範圍,請務必將這些範圍新增至「設定」頁面的「OAuth 2.0 範圍」區段。該節中列出的範圍應與外掛程式資訊清單中列出的範圍完全一致。

  6. 確認你在表單中輸入的資訊正確無誤。然後按一下「Save changes」(儲存變更)。

在這個 Google Workspace 外掛程式升級程序中如有任何問題或遇到問題,請與我們聯絡

常見問題

以下是關於外掛程式升級的常見問題:

我可以升級編輯器外掛程式嗎?

大多數的編輯器外掛程式都可以移至 Google Workspace 外掛程式。不過,升級後無法像 Gmail 和日曆的外掛程式一樣輕鬆升級至 Google Workspace 外掛程式。

如要將編輯器外掛程式遷移至 Google Workspace 外掛程式,您必須將外掛程式的 UI 從 HTML 重新編寫為卡片式介面,並將 JavaScript 處理更新為卡片服務

現有編輯器外掛程式中的某些服務可能無法在卡片服務中使用。舉例來說,如果您的編輯器外掛程式內含檔案選擇器,Google Workspace 外掛程式的卡片服務就不會提供對等項目。

我可以另外建立 Google Workspace 外掛程式並繼續使用現有外掛程式嗎?

您可以以不同品牌名稱建立其他 Google Workspace 外掛程式,但我們不允許使用與 Google Workspace 外掛程式相同的品牌名稱單獨建立 Gmail 或日曆會議外掛程式。如有疑問或想申請豁免,請與我們聯絡

外掛程式升級後,使用者是否需要重新授權?

只要您的 Google Workspace 外掛程式使用相同的基礎 Cloud Platform (GCP) 專案,搭配相關聯的 OAuth 用戶端 ID,使用者就不必重新授權他們先前授予原始外掛程式的權限。不過,如果您在升級程序期間新增範圍,則使用者在首次使用 Google Workspace 版本的外掛程式時,就必須授權這些新範圍。

我可以將 Chrome 擴充功能升級至 Google Workspace 外掛程式並轉移使用者嗎?

不可以。您無法轉移 Chrome 擴充功能的使用者、安裝和商店資訊評論。您必須建立新的 Google Workspace 外掛程式,並將 Chrome 擴充功能的使用者導向 Google Workspace Marketplace。

我可以將多個外掛程式與 Google Workspace 外掛程式搭配使用嗎?

請參閱「一併列出應用程式整合作業」。