建立 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 共用區中 雲端硬碟,則不需要 一個帳戶只具備唯一擁有權。放置外掛程式 共用雲端硬碟中的指令碼檔案,確保多位協作者都擁有 建立指令碼

發布外掛程式時,單一使用者帳戶會充當發布者。發布帳戶必須具備指令碼專案的編輯存取權,但不必是擁有者。

如要建立 Apps Script 專案,請參閱「指令碼專案」一文。

Google Cloud 專案

我們建議您新增協作者 外掛程式 Cloud 專案 這樣一來,團隊成員就能隨時存取外掛程式的雲端設定。

如要建立 Google Cloud 專案,請參閱「建立 Google Cloud 專案」。

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

請先決定要讓外掛程式呈現什麼樣貌,以及應如何運作,再開始建構。思考哪些用途 外掛程式,系統就會嘗試提供相應的解決方案。起始 提供簡單的設計,以便優先處理問題,然後再進行更多修正

如需設計外掛程式使用者體驗的規範,請參閱 Google Workspace 外掛程式樣式指南

設定外掛專案資訊清單

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

請參閱資訊清單,進一步瞭解如何設定 外掛程式的資訊清單。

在外掛程式中新增程式碼和功能時 產生必要的外掛程式 外觀和行為

編寫外掛程式的程式碼

您必須為外掛程式實作資訊卡介面。使用 Apps Script 的 卡片服務;如果是使用其他程式碼語言撰寫,請返回 正確格式化的 JSON,能讓介面算繪為資訊卡。

您還必須導入任何觸發條件 函式, 外掛程式資訊清單如果外掛程式使用 OAuth 連線至第三方非 Google 服務,您也必須為該服務設定 OAuth

登錄卡片

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

在 Apps Script 中,您可以使用 CardBuilder 類別建立資訊卡。每項 卡片需要 CardHeader 還有一或多個 CardSections。您應在每個資訊卡部分填入構成外掛程式介面的個別小工具。互動 小工具 通常會與動作連結 以及他們的互動行為

透過 CardBuilder,你必須呼叫 CardBuilder.build() 建立對應的 Card 物件。

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

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

施工順序

建構資訊卡時,您必須從頂端開始建構。也就是說,您必須使用以下建構順序:

  1. 建構小工具。
  2. 將小工具新增至資訊卡片部分。
  3. 重複執行上述步驟,直到資訊卡專區包含所有小工具為止。
  4. 在資訊卡中新增資訊卡專區。

請務必提供這項資訊,因為在資訊卡或資訊卡區段中加入小工具時, 其實就是新增該小工具的副本您對小工具所做的任何變更 物件不會反映在最終的資訊卡中。

通用動作

您可以使用通用動作 提供與情境無關的功能無論顯示哪個資訊卡,通用動作都是可在外掛程式 UI 中使用的選單項目。所有定義的通用動作一律會顯示在外掛程式的資訊卡選單中。

詳情請參閱「通用動作」 詳細資料。

驗證外掛程式 OAuth 範圍

範圍會定義 外掛程式可代表使用者執行最佳做法是,外掛程式只應針對必須具備的動作設定範圍,不應超過這個範圍。

在外掛程式專案中,明確設定 外掛程式 範圍,藉此確保 這個外掛程式採用的一組範圍最小 您可以定義外掛程式使用的範圍 外掛程式 manifest

詳情請參閱「範圍」。

測試外掛程式

如要測試未發布的外掛程式,請先安裝未發布的外掛程式。安裝並授權後 並測試其在主機應用程式中的外觀與行為 。您應確認外掛程式的行為 情境和使用者動作的關聯

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

發布外掛程式

發布外掛程式可讓他人存取 可以公開或只限自己網域內的使用者開始發布程序前,請務必詳閱出版總覽。發布是複雜的程序,需要準備和時間才能完成。

Google Workspace 外掛程式會發布至 Google Workspace Marketplace。公開提供的擴充功能必須先完成應用程式審查,才能發布。

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