建立 Google Workspace 外掛程式

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

如要建立新的 Google Workspace 外掛程式,請按照下列一般程序操作:

  1. 設定外掛程式的專案,並選擇擁有者與協作者。
  2. 設計外掛程式的外觀與行為。
  3. 設定外掛程式的專案資訊清單或部署資源。
  4. 撰寫程式碼以定義外掛程式的外觀和行為。
  5. 驗證外掛程式的 OAuth 範圍。
  6. 在擴充的主機應用程式中測試外掛程式。
  7. 發布外掛程式。

設定外掛程式專案,並選擇擁有者和協作者

如果您在 Apps Script 中建立外掛程式,將同時建立 Apps Script 專案和 Google Cloud 專案。如果您使用 Apps Script 以外的語言建立外掛程式,則只需要建立 Google Cloud 專案。

開始開發外掛程式之前,請選擇單一使用者帳戶來擁有專案,並決定哪些帳戶是協作者。專案擁有者可以建立及管理專案檔案和相關設定,協作者則能協助進行程式設計與測試。

Apps Script 專案

您可以在共用雲端硬碟中建立外掛程式的 Apps Script 專案檔案,避免單一帳戶擁有唯一擁有權。將外掛程式指令碼檔案放入共用雲端硬碟後,您就能輕鬆確保多個協作者始終能夠存取指令碼專案。

當您發布外掛程式時,單一使用者帳戶就是發布者。發布帳戶必須具備指令碼專案的編輯權限,但不一定要是擁有者。

Google Cloud 專案

建議您將外掛程式新增至外掛程式的 Cloud 專案。這有助於確保您的團隊能隨時存取外掛程式的雲端設定。

設計您的外掛程式外觀和行為

開始建立外掛程式之前,請先決定外掛程式的外觀及運作方式。請考量外掛程式應如何提供解決方案的用途。您可以先從簡單的設計著手,再著手進行更多分類調整。

請參閱 Google Workspace 外掛程式樣式指南,瞭解如何設計附加的使用者體驗。

設定外掛程式專案資訊清單

在 Apps Script 專案中,專案資訊清單是一個特殊的 JSON 檔案。可指定專案的各種詳細資料,例如程式庫的依附元件。針對 Google Workspace 外掛程式,資訊清單也提供主機應用程式正確顯示外掛程式所需的基本資訊。

如要進一步瞭解如何在 Apps Script 中設定外掛程式的資訊清單,請參閱資訊清單

在外掛程式中加入程式碼和功能時,請視需要編輯資訊清單,以產生必要的外掛程式外觀與行為。

編碼外掛程式

您必須為外掛程式實作以卡片為基礎的介面。使用 Apps Script 的卡片服務;或者,如果您使用其他的程式碼語言編寫,則傳回適當格式的 JSON 介面,讓介面顯示為資訊卡。

您也必須實作外掛程式資訊清單中指定的任何觸發函式。如果您的外掛程式使用 OAuth 連線至第三方非 Google 服務,您還必須為該服務設定 OAuth

建立資訊卡

您可以建立 Card 物件並填入小工具,藉此定義外掛程式使用者介面。資訊清單中指定的觸發條件函式必須傳回單一 Card 物件,或代表外掛程式介面不同「頁面」的 Card 物件陣列。您的外掛程式也可以回應使用者動作,建立及顯示新的資訊卡。

在 Apps 指令碼中,您可以使用 CardBuilder 類別建立資訊卡。每張卡片都需要 CardHeader 和一或多個 CardSections。您必須在每個資訊卡區段中填入構成外掛程式介面的個別小工具。互動小工具:通常會連結到動作,以便定義互動行為。

透過 CardBuilder 將所有區段和小工具加入資訊卡後,您必須呼叫 CardBuilder.build() 以建立對應的 Card 物件。

您可以使用其他內建 Apps Script 服務 (例如 CalendarApp) 來擷取資訊,以便顯示在您所建立的外掛程式資訊卡中。您可以使用從非 Google 服務擷取的資料。

如果 Google Workspace 外掛程式需要存取需要 OAuth 的非 Google API,您必須設定並連線至該服務,詳情請參閱連線至非 Google 服務指南

施工順序

建立資訊卡時,您必須從上往下建構。也就是說,您必須使用這個建構順序:

  1. 建構小工具。
  2. 將小工具新增至資訊卡區段。
  3. 重複以上步驟,直到卡片區段包含所有小工具。
  4. 將卡片部分新增至卡片。

這是必要步驟,因為當您將小工具新增到卡片或資訊卡區段時,您實際上將會新增該小工具的副本。您對小工具物件所做的任何變更,都不會反映在最終資訊卡中。

通用動作

您可以使用通用動作來提供與內容無關的功能。通用動作是外掛程式 UI 提供的選單項目,無論目前顯示的資訊卡為何。外掛程式資訊卡選單中一律會顯示所有已定義的通用動作。

詳情請參閱通用動作

驗證外掛程式 OAuth 範圍

「範圍」定義了外掛程式可代表使用者執行哪些動作。最佳做法是讓外掛程式僅針對其必須按順序排列的操作範圍設定範圍。

針對外掛程式專案,請明確設定外掛程式範圍,確保外掛程式會使用範圍最寬限的範圍。您可以在外掛程式資訊清單中定義外掛程式使用的範圍。

詳情請參閱「範圍」一文。

測試外掛程式

您可以先安裝未發布的外掛程式,藉此測試未發布的外掛程式。安裝並授權之後,您就可以在帳戶中使用外掛程式,並在所擴充的主機應用程式中測試其外觀和行為。請確認外掛程式在情境和使用者動作中是否如預期運作。

詳情請參閱「測試 Google Workspace 外掛程式」一文。

發布外掛程式

發布您的外掛程式之後,所有人都能將其公開,或提供給您網域中的使用者。開始發布程序之前,請務必查看發布內容總覽。發布是一項複雜的程序,需要準備和時間才能完成。

Google Workspace 外掛程式會發布到 Google Workspace Marketplace。公開發布的外掛程式必須先通過應用程式審查才能發布。

詳情請參閱發布 Google Workspace 外掛程式

Google Workspace 外掛程式範例

Google Workspace 外掛程式側欄

為協助您瞭解 Google Workspace 外掛程式的建構方式,Google Workspace 「貓」外掛程式快速入門導覽課程會示範如何建立簡易的 Google Workspace外掛程式,包括首頁、卡片導覽以及與第三方服務之間的連線。完成快速入門導覽課程後,您可以安裝外掛程式,並嘗試以程式碼進行實驗。