最佳做法

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

一般最佳做法

建議您在開發所有外掛程式時,遵循下列最佳做法。

開始前確認外掛程式的擁有權

外掛程式是由 Apps Script 專案定義,這些專案必須由特定帳戶擁有,或放置在共用雲端硬碟中。在編寫外掛程式程式碼前,請先決定專案的擁有者帳戶,以及發布者帳戶。也請決定哪些帳戶將擔任協作者,並確保這些帳戶具有指令碼專案及其相關Cloud 平台專案的存取權。

擴充 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 專案。您可以自由使用 jQuery 等用戶端 JavaScript 程式庫,而不會遇到延遲問題。

編輯器外掛程式的最佳做法

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

將介面 HTML 和用戶端 JavaScript 置於各自的指令碼檔案中

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

在不同授權模式下徹底測試

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