瞭解如何設計、建構及發布 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 UI」。
設定外掛程式的專案,並選擇擁有者和協作者
如果您在 Apps Script 中建構外掛程式,則需要建立 Apps Script 專案和 Google Cloud 專案。如果您使用 Apps Script 以外的語言建構外掛程式,只需要建立 Google 雲端專案。
如要建構外掛程式,您必須同時設定指令碼專案和雲端專案。
開始開發外掛程式前,請選擇一個使用者帳戶擁有專案,並決定哪些其他帳戶是協作者。專案擁有者負責建立及管理專案檔案和相關設定,協作者則可協助編碼和測試。
Apps Script 專案
建構外掛程式前,請先詳閱 Apps Script 配額和限制,確保專案設計符合這些規範。Apps Script 最適合輕量開發個人或內部外掛程式,且使用者族群人數不多。如果外掛程式需要支援大量使用者、低延遲或全面控管基礎架構,請考慮其他執行階段。
在共用雲端硬碟中建立外掛程式的 Apps Script 專案檔案,避免單一帳戶擁有專屬擁有權。將外掛程式指令碼檔案放在共用雲端硬碟中,可確保所有協作者都能存取指令碼專案。
發布外掛程式時,只有一個使用者帳戶是發布者。發布帳戶必須具備指令碼專案的編輯權限,但不一定要是擁有者。
如要建立 Apps Script 專案,請參閱指令碼專案。
Google Cloud 專案
將協作者新增至外掛程式的雲端專案。確保團隊成員隨時都能存取外掛程式的雲端設定。
如要建立 Google Cloud 專案,請參閱「建立 Google Cloud 專案」。
設計及設定外掛程式的外觀和行為
建構外掛程式前,請先決定外掛程式的外觀和行為。請考慮外掛程式解決哪些用途。 先從基本設計開始,然後再進行微調。
如需外掛程式使用者體驗設計指南,請參閱 Google Workspace 外掛程式樣式指南。
設定外掛程式資訊清單
在外掛程式資訊清單中實作設計。在資訊清單中設定外掛程式的外觀和行為,包括外掛程式擴充的 Google Workspace 代管應用程式。
詳情請參閱「Google Workspace 外掛程式的資訊清單」。
新增程式碼和功能時,請視需要更新資訊清單,定義外掛程式的外觀和行為。
設定 Google Chat 應用程式的外觀和行為
如果您設計的外掛程式會擴充 Google Chat,請使用 Google Chat API 設定 Chat 應用程式的外觀和行為。如需相關步驟,請參閱「使用 Google Chat API」。
建構外掛程式
為外掛程式實作卡片式介面。使用 Card 服務,或使用其他程式碼語言,傳回格式化的 JSON,供介面以資訊卡形式顯示。
實作外掛程式資訊清單中指定的任何觸發函式。如果外掛程式使用 OAuth 連線至第三方服務,請為該服務設定 OAuth。
建構資訊卡
建立 Card 物件並新增小工具,定義外掛程式使用者介面。資訊清單中指定的觸發函式必須傳回單一 Card 物件,或是代表外掛程式介面不同「頁面」的 Card 物件陣列。外掛程式也可以建立及顯示新資訊卡,以回應使用者動作。
在 Apps Script 中,使用 CardBuilder 類別建立資訊卡。每張資訊卡都需要 CardHeader 和一或多個 CardSections。在每個資訊卡區塊中填入構成介面的個別小工具。互動小工具通常會連結至動作,以定義互動行為。
透過 CardBuilder 將所有區段和小工具新增至資訊卡後,請呼叫 CardBuilder.build 建立對應的 Card 物件。
使用內建的 Apps Script 服務](/apps-script/guides/services/) (例如 CalendarApp) 擷取要在外掛程式資訊卡中顯示的資訊。使用非 Google 服務的資料。
如果外掛程式需要存取必須使用 OAuth 的非 Google API,請設定並連線至該服務,詳情請參閱「連線至非 Google 服務」指南。
施工順序
建構資訊卡時,請從頂端開始。請按照以下順序建構:
- 建構小工具。
- 將小工具新增至卡片區段。
- 重複上述步驟,直到資訊卡區塊包含所有小工具為止。
- 在卡片中新增卡片區段。
這是因為將小工具新增至資訊卡或資訊卡區塊時,您實際新增的是該小工具的副本。加入小工具物件後,對該物件所做的任何變更都不會反映在最終卡片中。
通用動作
使用通用動作提供與內容無關的功能。通用動作是外掛程式 UI 中提供的選單項目,與資訊卡無關。所有已定義的通用動作都會顯示在外掛程式的資訊卡選單中。
詳情請參閱「通用動作」。
驗證外掛程式 OAuth 範圍
範圍定義外掛程式可代表使用者執行的動作。外掛程式應只具備運作所需的範圍。
在外掛程式專案中,設定外掛程式範圍,確保外掛程式使用最寬鬆的範圍組合。在外掛程式資訊清單中定義範圍。
詳情請參閱「範圍」。
測試外掛程式
如要測試未發布的外掛程式,請先安裝未發布的外掛程式。安裝並授權後,您可以在帳戶中使用外掛程式,測試外掛程式在擴充代管應用程式中的外觀和行為。確認外掛程式在各種情境和使用者動作下,是否都能正常運作。
如要開始測試外掛程式,請參閱下列指南:
發布外掛程式
發布後,其他使用者就能使用外掛程式。 發布前,請先查看發布總覽。發布是複雜的程序,需要事先準備。
Google Workspace 外掛程式會發布至 Google Workspace Marketplace。公開發布的增益集必須先通過應用程式審查,才能發布。
詳情請參閱「發布 Google Workspace 外掛程式」。