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

如果您已建構並發布外掛程式來擴充 Gmail 或 Google 日曆功能,可以將其升級為 Google Workspace 外掛程式。本頁的說明詳細介紹如何將 Google Workspace 功能新增至現有的 Gmail 或 Google 日曆外掛程式,然後發布升級版外掛程式,供使用者探索及安裝。

您可以將新功能轉移至原始外掛程式,保留 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 郵件串Google 日曆活動

  4. 更新外掛程式中對事件物件的任何存取 (在小工具回呼函式或情境觸發函式中),以使用更新的事件物件結構。新結構仍包含 Gmail 和 Google 日曆會議外掛程式使用的相同活動物件欄位,但這些原始欄位已遭淘汰,最終會移除。

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

Google Workspace 外掛程式的資訊清單結構儲存設定資訊的方式,與 Gmail 外掛程式和日曆會議外掛程式使用的結構大不相同。升級外掛程式時,您必須根據下表更新外掛程式的 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」。

日曆會議外掛程式

原始資訊清單欄位 敬請採取行動
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 專案中)。請勿嘗試使用 Head 部署作業發布。

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

步驟 6:提供升級版外掛程式

  1. 開啟 Google Workspace Marketplace SDK。

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

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

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

  5. 如果您在 Google Workspace 外掛程式中新增範圍,請務必在「設定」頁面的「OAuth 2.0 範圍」部分新增這些範圍。該部分列出的範圍應與外掛程式資訊清單中列出的範圍完全相符。

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

如果您在升級 Google Workspace 外掛程式的過程中遇到問題或有任何疑問,請與我們聯絡

常見問題

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

我可以升級 Editor 外掛程式嗎?

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

如要將編輯器外掛程式遷移至 Google Workspace 外掛程式,您需要將外掛程式的 UI 從 HTML 重新編寫為以資訊卡為基礎的介面,並將 JavaScript 處理方式更新為 Card Service

現有編輯器外掛程式中的部分服務可能無法在 Card Service 中使用。舉例來說,如果編輯器外掛程式包含檔案挑選器,Google Workspace 外掛程式的 Card Service 就沒有對應的挑選器。

我可以建立獨立的 Google Workspace 外掛程式,並保留現有外掛程式嗎?

您可以建立其他品牌名稱的 Google Workspace 外掛程式,但不得使用與 Google Workspace 外掛程式相同的品牌名稱,建立個別的 Gmail 或 Google 日曆會議外掛程式。如有任何疑問或想申請例外情況,請與我們聯絡

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

只要 Google Workspace 外掛程式使用相同的基礎 Cloud Platform (GCP) 專案,並與 OAuth 用戶端 ID 建立關聯,使用者就不必重新授權先前為原始外掛程式授權的權限。不過,如果您在升級過程中新增範圍,使用者首次使用 Google Workspace 版外掛程式時,必須授權這些新範圍。

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

否。您無法轉移 Chrome 擴充功能的使用者、安裝次數和評論。您必須建立新的 Google Workspace 外掛程式,並將 Chrome 擴充功能的現有使用者導向 Google Workspace Marketplace。

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

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