本頁將概述如何設計、建構及發布 Google Workspace 外掛程式。本總覽將說明下列步驟:
- 決定要讓使用者在哪些 Google Workspace 應用程式中使用外掛程式。
- 設定外掛程式的專案,並選擇擁有者和協作者。
- 設計及設定外掛程式的外觀和行為。
- 建構外掛程式。
- 驗證外掛程式的 OAuth 範圍。
- 在一或多個 Google Workspace 應用程式中測試外掛程式。
- 發布外掛程式。
您可以使用 Apps Script 或 HTTP 建構外掛程式。如需比較,請觀看「Apps Script vs. HTTP endpoints: Which should you choose? 🤔」。
選擇 Google Workspace 主機應用程式
您可以設定 Google Workspace 外掛程式,使其顯示在下列 Google Workspace 主機應用程式中:
- Gmail
- Google 日曆
- Google Chat
- Google 文件
- Google 雲端硬碟
- Google Meet
- Google 試算表
- Google 簡報
如要瞭解如何為 Google Workspace 應用程式建構擴充功能,請參閱「擴充 Google Workspace 使用者介面」。
設定外掛程式的專案,並選擇擁有者和協作者
如果您使用 Apps Script 建立外掛程式,則需要建立 Apps Script 專案和 Google Cloud 專案。如果您使用 Apps Script 以外的語言建構外掛程式,只需要建立 Google Cloud 專案。
開始開發外掛程式前,請選擇一個使用者帳戶擁有專案,並決定哪些其他帳戶是協作者。專案擁有者負責建立及管理專案檔案和相關設定,協作者則可協助編碼和測試。
Apps Script 專案
建構外掛程式前,請先詳閱 Apps Script 配額和限制,確保專案設計符合這些規範。Apps Script 最適合輕量開發個人或內部外掛程式,使用者人數不多。如果您預計要建構的大型外掛程式需要處理大量使用者、要求低延遲,或是需要全面控管基礎架構,建議在其他執行階段環境中開發。
您可以在共用雲端硬碟中建構外掛程式的 Apps Script 專案檔案,這樣一來,就不會由單一帳戶獨自擁有。將外掛程式指令碼檔案放在共用雲端硬碟中,可確保多位協作者都能存取指令碼專案。
發布外掛程式時,單一使用者帳戶會做為發布者。發布帳戶必須具備指令碼專案的編輯權限,但不一定要是擁有者。
如要建立 Apps Script 專案,請參閱「指令碼專案」。
Google Cloud 專案
建議您將協作者新增至外掛程式的 Cloud 專案。 確保團隊成員隨時都能存取外掛程式的雲端設定。
如要建立 Google Cloud 專案,請參閱「建立 Google Cloud 專案」。
設計及設定外掛程式的外觀和行為
開始建構外掛程式前,請先決定外觀和行為。請考慮外掛程式應嘗試解決哪些用途。先從簡單的設計開始,然後再加入更多精修內容。
如要瞭解如何設計外掛程式使用者體驗,請參閱 Google Workspace 外掛程式樣式指南。
設定外掛程式資訊清單
設計完外掛程式後,即可開始在外掛程式資訊清單中實作設計。您可以在資訊清單中設定外掛程式的大部分外觀和行為,包括外掛程式擴充的 Google Workspace 主機應用程式。
詳情請參閱「Google Workspace 外掛程式資訊清單」。
在外掛程式中新增程式碼和功能時,請視需要編輯資訊清單,以產生所需的外掛程式外觀和行為。
設定 Google Chat 應用程式的外觀和行為
如果您設計的外掛程式可擴充 Google Chat 功能,就必須使用 Google Chat API 設定 Chat 應用程式的外觀和行為。如需相關步驟,請參閱「設定 Google Chat 應用程式」。
建構外掛程式
您必須為外掛程式實作卡片式介面。使用 Apps Script 的 Card 服務,或以其他程式碼語言編寫,並傳回格式正確的 JSON,供介面以資訊卡形式呈現。
您也必須實作外掛程式資訊清單中指定的任何觸發函式。如果外掛程式使用 OAuth 連線至第三方非 Google 服務,您也必須為該服務設定 OAuth。
建構資訊卡
如要定義外掛程式使用者介面,請建立 Card 物件,並填入小工具。資訊清單中指定的觸發函式必須傳回單一 Card 物件,或是代表外掛程式介面不同「頁面」的 Card 物件陣列。外掛程式也可以建立及顯示新資訊卡,以回應使用者動作。
在 Apps Script 中,您可以使用 CardBuilder 類別建立資訊卡。每張資訊卡都需要 CardHeader 和一或多個 CardSections。您應在每個資訊卡區塊中填入組成外掛程式介面的個別小工具。互動小工具通常會連結至動作,以定義互動行為。
透過 CardBuilder 將所有區段和小工具新增至資訊卡後,您必須呼叫 CardBuilder.build() 來建立對應的 Card 物件。
您可以使用其他內建 Apps Script 服務,例如 CalendarApp,擷取要在外掛程式資訊卡中顯示的資訊。您可以使用從非 Google 服務擷取的資料。
如果外掛程式需要存取必須使用 OAuth 的非 Google API,您必須設定並連線至該服務,詳情請參閱「連線至非 Google 服務」指南。
施工單
建構資訊卡時,必須從頂端開始。也就是說,您必須按照以下順序建構:
- 建構小工具。
- 將小工具新增至卡片部分。
- 重複上述步驟,直到卡片區段包含所有小工具為止。
- 將卡片區塊新增至卡片。
這是必要步驟,因為將小工具新增至資訊卡或資訊卡區塊時,您實際新增的是該小工具的「副本」。加入小工具物件後,對該物件所做的任何變更都不會反映在最終的資訊卡中。
通用動作
您可以使用通用動作提供與情境無關的功能。無論顯示哪個資訊卡,外掛程式 UI 中都會提供通用動作選單項目。所有已定義的通用動作一律會顯示在外掛程式的資訊卡選單中。
詳情請參閱「通用動作」。
驗證外掛程式 OAuth 範圍
範圍會定義外掛程式可代表使用者執行的動作。最佳做法是,外掛程式只應具備運作所需的動作範圍,不應有其他範圍。
在外掛程式專案中,明確設定外掛程式範圍,確保外掛程式使用最寬鬆的範圍組合。您可以在外掛程式資訊清單中,定義外掛程式使用的範圍。
詳情請參閱「範圍」。
測試外掛程式
如要測試未發布的外掛程式,請先安裝未發布的外掛程式。安裝並授權後,您就可以在帳戶中使用外掛程式,並在擴充外掛程式的主機應用程式中測試外觀和行為。您應確認外掛程式在各種情境和使用者動作中,是否都能正常運作。
如要開始測試外掛程式,請參閱下列指南:
發布外掛程式
發布外掛程式後,其他使用者就能存取, 無論是公開發布,還是只開放網域中的使用者存取,開始發布程序前,請務必先查看出版品總覽。發布作業相當複雜,需要準備和時間才能完成。
Google Workspace 外掛程式會發布至 Google Workspace Marketplace。公開發布的增益集必須先完成應用程式審查,才能發布。
詳情請參閱「發布 Google Workspace 外掛程式」。