最佳做法

請按照這些外掛程式設計的指南,改善使用者的整體體驗。

一般最佳做法

建議您針對自己開發的所有外掛程式遵循以下最佳做法。

開始之前先決定外掛程式擁有權

外掛程式是由 Apps Script 專案定義,這類專案必須由特定帳戶擁有,或放入共用雲端硬碟中。在編寫外掛程式的程式碼之前,請先決定哪個帳戶應擁有專案,以及哪個帳戶做為發布商。請一併決定要將哪些帳戶當做協作者,並確認這些帳戶有權存取指令碼專案及其相關聯的 Cloud Platform 專案

擴充 Google Workspace,請勿複製

外掛程式旨在為其擴充的 Google Workspace 應用程式提供新功能,或將複雜工作自動化。如果外掛程式只是複製應用程式中既有的功能,或不會對工作流程進行大幅改善的外掛程式,可能無法通過外掛程式審查進行發布。

縮小範圍

明確定義範圍時,請一律選擇最寬鬆的範圍組合。例如,如果外掛程式要求僅需要讀取權限,則請勿在具有 https://www.googleapis.com/auth/calendar 範圍的情況下要求取得使用者日曆的完整存取權。如需唯讀存取權,請使用 https://www.googleapis.com/auth/calendar.readonly 範圍。

避免過度仰賴程式庫

使用 Apps Script 程式庫時,如果所有 Apps Script 程式碼都包含在單一指令碼專案中,則會導致外掛程式執行速度變慢。雖然 Apps Script 程式庫可以在外掛程式中運作,但使用時可能會降低效能。請避免在專案中加入不必要的程式庫,並考慮減少外掛程式依賴的方法。

上述延遲時間僅適用於做為伺服器端程式庫的 Apps Script 專案。您可以自由使用用戶端 JavaScript 程式庫 (例如 jQuery),而且不會發生此延遲情形。

編輯器外掛程式最佳做法

下列最佳做法僅適用於編輯器外掛程式}。

將介面 HTML 和用戶端 JavaScript 放入自己的指令碼檔案中

您可以在 Apps Script 專案中建立多個指令碼檔案。如果 HTML 和 JavaScript 定義了外掛程式側欄和對話方塊的專屬指令碼檔案,就能更輕鬆地管理複雜的外掛程式。

透過不同的授權模式進行測試

測試外掛程式時,請務必嘗試使用不同的檔案和授權狀態