升級已發布的外掛程式

如果您已建構並發布用來擴充 Gmail 或 Google 日曆的外掛程式,則可升級至 Google Workspace 外掛程式。本頁的操作說明詳細說明瞭如何在現有 Gmail 或日曆外掛程式中新增 Google Workspace 功能,然後發布升級的外掛程式,以便尋找及安裝。

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

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

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

  1. 開啟現有的 Gmail 外掛程式或 Google 日曆會議外掛程式 Apps Script 專案。
  2. 按一下左側的「Overview」
  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」(擴充功能) 下方,按一下「升級至 Google Workspace 外掛程式」按鈕。在隨即顯示的文字方塊中,輸入您在上一步中為 Google Workspace 外掛程式建立的新部署 ID。如果部署項目 ID 有效,系統就會顯示支援的主機清單。

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

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

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

常見問題

以下為加購升級服務的常見問題:

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

大部分編輯器外掛程式都可以移至 Google Workspace 外掛程式。但是,這些外掛程式無法像 Gmail 和日曆的附加服務一樣簡單地升級至 Google Workspace 外掛程式。

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

現有編輯器外掛程式中的部分服務可能無法在卡片服務中使用。舉例來說,如果您的編輯器外掛程式包含檔案挑選器,則 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 外掛程式可以隨附多個外掛程式嗎?

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