如要建立新的 Google Workspace 外掛程式,請按照這個一般步驟操作 程序:
- 設定外掛程式的專案並選擇擁有者 和協作者
- 設計外掛程式的外觀和行為。
- 設定外掛程式的專案資訊清單,或 管理 Deployment 資源
- 編寫程式碼來定義外掛程式的外觀 行為
- 驗證外掛程式的 OAuth 範圍。
- 在 託管應用程式 持續擴充
- 發布外掛程式。
設定外掛程式的專案,並選擇擁有者和協作者
如果您使用 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 的 卡片服務;如果是使用其他程式碼語言撰寫,請返回 正確格式化的 JSON,能讓介面算繪為資訊卡。
您還必須導入任何觸發條件 函式, 外掛程式資訊清單如果您的 外掛程式連結至第三方的非 Google 服務 使用 OAuth,就必須為該 API 設定 OAuth 服務。
製作卡片
如要定義外掛程式使用者介面
Card
物件,並填入
小工具。觸發以下項目中指定的函式:
資訊清單必須傳回一則
Card
物件或
Card
物件,代表
不同的「網頁」外掛程式介面中您的
外掛程式也可以在下列位置建立及顯示新資訊卡:
或回應使用者動作的回應
在 Apps Script 中,建立資訊卡時必須使用
CardBuilder
類別。每項
卡片需要 CardHeader
還有一或多個
CardSections
。請
在每個資訊卡部分填入
外掛程式介面互動
小工具,為
通常會與動作連結
他們的互動行為。
透過
CardBuilder
,你必須呼叫
CardBuilder.build()
建立對應的 Card
物件。
您可以使用其他內建 Apps Script
或服務,例如
擷取 CalendarApp
即可擷取
資訊,顯示在您建立的外掛程式資訊卡中。
您可以使用從非 Google 服務擷取的資料。
如果 Google Workspace 外掛程式需要存取需要 OAuth 的非 Google API 存取權, 必須設定並連線至該服務,請參閱連線至 非 Google 服務指南: 瞭解詳情
施工順序
建構資訊卡時,您必須從向上建構。也就是說,您必須使用 API 施工順序:
- 建構小工具。
- 將小工具新增至資訊卡區段。
- 重複上述步驟,直到資訊卡區塊包含所有小工具為止。
- 在資訊卡中新增資訊卡專區。
請務必提供這項資訊,因為在資訊卡或資訊卡區段中加入小工具時, 其實就是新增該小工具的副本您對小工具所做的任何變更 物件不會反映在最終的資訊卡中。
通用動作
您可以使用通用動作 提供與情境無關的功能通用動作是選單項目 都適用於外掛程式使用者介面 高度。所有已定義的通用動作一律會在 資訊卡選單
詳情請參閱「通用動作」 詳細資料。
驗證外掛程式 OAuth 範圍
範圍會定義 外掛程式可代表使用者執行這是 外掛程式的最佳做法,僅適用於執行外掛程式的動作 必須依循序間且無其他程式碼
在外掛程式專案中,明確設定 外掛程式 範圍,藉此確保 這個外掛程式採用的一組範圍最小 您可以定義外掛程式使用的範圍 外掛程式 manifest。
詳情請參閱「範圍」一節。
測試外掛程式
如要測試尚未發布的外掛程式,請先 未發布 外掛程式。 安裝並授權後 並測試其在主機應用程式中的外觀與行為 。您應確認外掛程式的行為 情境和使用者動作的關聯
詳情請參閱「測試 Google Workspace 外掛程式」。
發布外掛程式
發布外掛程式可讓他人存取 可以公開或只限自己網域內的使用者開始發布前的準備 請務必詳閱出版品總覽。發布是複雜的程序, 準備工作與完成的時間
Google Workspace 外掛程式已發布至 Google Workspace Marketplace。一般大眾亦可取得 外掛程式必須完成應用程式審查 已發布的 Pod
請參閱:發布 Google Workspace 外掛程式: 瞭解詳情