最佳做法

請參閱這些外掛程式設計指南,提升整體使用者體驗。

一般最佳做法

建議您為開發的所有外掛程式採用下列最佳做法。

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

外掛程式是由 Apps Script 專案定義,且必須由特定帳戶擁有,或放在共用雲端硬碟中。編寫外掛程式程式碼前,請先決定專案的擁有者帳戶,以及做為發布者的帳戶。此外,請決定要將哪些帳戶設為協作者,並確保這些帳戶有權存取指令碼專案和相關聯的 Google 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 放在專屬的指令碼檔案中,就能更輕鬆管理複雜的外掛程式。

在不同授權模式下進行全面測試

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