測試編輯器外掛程式

發布前請徹底測試外掛程式,確保運作方式符合預期。您可以使用 Apps Script,在特定的 Google 文件、試算表、表單或簡報檔案中,測試開發中的編輯器外掛程式。這項功能可用於:

  • 確認以獨立指令碼編寫的外掛程式套用至試算表、文件、簡報或表單時,是否能正常運作。
  • 確認外掛程式安裝流程運作正常,特別是針對不同的初始授權生命週期狀態 (已安裝、已啟用或兩者皆是)。
  • 確認外掛程式在處理特定文件及其內容時,是否能正常運作。
  • 測試及比較外掛程式的目前版本和先前版本。

建立測試部署作業

測試部署作業是指外掛程式和測試文件的組合。 開發指令碼版本後,如要以外掛程式形式測試,請按照下列步驟操作:

  1. 如果沒有,請建立試算表、文件、簡報或表單,以便測試外掛程式。
  2. 開啟包含外掛程式的指令碼專案。
  3. 依序點選「部署」>「測試部署作業」
  4. 按一下「選取類型」旁邊的「啟用部署類型」圖示 ,然後選取「編輯器外掛程式」
  5. 按一下「建立新測試」或「新增測試」
  6. 選擇程式碼版本或選取「最新程式碼」
  7. 在「設定」部分,選取測試的初始授權狀態
  8. 在「測試文件」下方,按一下「未選取任何文件」。選取要用來測試外掛程式的 Google 試算表、文件、簡報或表單檔案,然後按一下「插入」
  9. 按一下「儲存測試」

所有已儲存的測試部署作業都會顯示在「測試部署作業」對話方塊中。這樣一來,您稍後就能重新進行相同的測試部署作業。

執行測試部署

如果您已儲存一或多個測試部署作業,可以按照下列步驟執行其中一個:

  1. 開啟包含外掛程式的指令碼專案。
  2. 依序點選「部署」>「測試部署作業」
  3. 在「已儲存的測試」下方,選取要執行的已儲存測試部署旁邊的單選按鈕,然後按一下「執行」

測試文件會在新分頁中開啟。外掛程式處於測試部署作業中指定的授權狀態。您可以與外掛程式的選單和 UI 元素互動,確認外掛程式是否正常運作。

如要在外掛程式上測試精細 OAuth 功能,請確認專案尚未取得授權。如要使現有授權失效,請使用 ScriptApp.invalidateAuth

測試詳細資料

以這種方式測試編輯器外掛程式時,請注意下列事項:

  • 測試時不支援可安裝的觸發條件。仰賴可安裝觸發條件的功能無法測試。
  • 執行設為使用最新程式碼測試的測試部署作業時,只要重新整理測試文件,即可查看儲存至外掛程式指令碼的變更。
  • 測試文件會有專屬網址,您可以將這個網址提供給原始測試文件的編輯者。這樣一來,您就能在測試及開發期間,更輕鬆地與他人協作。
  • 如果外掛程式使用 Properties 服務,屬性會持續存在,下次執行測試部署時仍可使用。
  • 此外,凡是使用相同外掛程式和測試文件組合的測試部署作業,都能存取相同的屬性資訊。舉例來說,如果您建立兩項測試部署作業,則在執行第二項作業時,可以使用執行第一項作業時儲存的屬性,反之亦然,但前提是部署作業使用相同的指令碼和測試文件。
  • 如果您執行測試部署,系統可能會提示您授權 (如果您先前未執行過指令碼)。請注意,在測試期間授權指令碼,也會授權指令碼在測試以外的情況下執行。