建立 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 專案新增協作者。這可確保團隊成員隨時都能存取外掛程式的 Cloud 設定。

如要建立 Google Cloud 專案，請參閱「建立 Google Cloud 專案」一文。

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

在開始建立外掛程式前，決定外掛程式的外觀和行為。請思考外掛程式應該在哪些情況下提供解決方案。您可以先從簡單的設計開始著手，再新增更多修正建議。

請參閱「Google Workspace 外掛程式風格指南」，瞭解如何設計外掛程式使用者體驗。

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

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

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

當您在外掛程式中新增程式碼和功能時，請視需要編輯資訊清單，產生必要的外掛程式外觀和行為。

編寫外掛程式的程式碼

您必須為這個外掛程式實作卡片式介面。請使用 Apps Script 的資訊卡服務，或者如要以其他程式碼語言編寫，請傳回格式正確的 JSON，讓介面能以資訊卡的形式顯示。

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

製作卡片

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

在 Apps Script 中，您可以使用 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 外掛程式」。