Google Workspace 外掛程式的觸發條件

Apps Script 觸發條件會在指定事件發生時,執行指定的指令碼函式 (即觸發函式)。只有特定事件會觸發動作,且每個 Google Workspace 應用程式支援的事件都不盡相同。

觸發條件啟動時,系統會建立事件物件。這個 JSON 結構包含發生的事件詳細資料。事件物件結構中的資訊會根據觸發類型,以不同方式整理。

建立事件物件後,Apps Script 會將其做為參數傳遞至觸發函式。觸發函式是您必須自行實作的回呼函式,可採取適當的動作來回應事件。舉例來說,在擴充 Gmail 的 Google Workspace 外掛程式中,您可以定義觸發條件,在使用者開啟郵件串時建立新的資訊卡介面。在本例中,您會實作情境式回呼函式,使用事件物件中傳遞的資料建立構成新 UI 的資訊卡。

本頁面提供在 Google Workspace 外掛程式專案中使用觸發條件的相關指南。

資訊清單觸發條件

與編輯器外掛程式不同,Google Workspace 外掛程式目前無法使用 Apps Script 簡易觸發條件,而是使用專為 Google Workspace 外掛程式設計的觸發條件:資訊清單觸發條件

資訊清單觸發條件完全是在 Google Workspace 外掛程式的資訊清單中定義。以下列舉一些觸發資訊清單的例子:

  • 首頁觸發條件:建構及顯示外掛程式首頁。
  • 日曆活動開啟觸發條件:在日曆活動開啟時顯示新資訊卡或採取其他動作。
  • 日曆活動更新觸發條件:使用者編輯並儲存日曆活動時,顯示新資訊卡或採取其他動作。
  • Drive onItemsSelected 觸發條件:使用者在雲端硬碟中選取一或多個檔案或資料夾時,系統會顯示新資訊卡或採取其他動作。
  • Gmail 撰寫觸發條件:使用者在 Gmail 撰寫視窗中開啟外掛程式時,會顯示外掛程式資訊卡。
  • Gmail 內容比對觸發條件:使用者開啟 Gmail 郵件時,顯示新資訊卡或採取其他動作。
  • Editor onFileScopeGranted 觸發程序:當使用者在目前的 Google 試算表文件中授予 drive.file OAuth 範圍的授權時,系統會顯示新資訊卡。

在上述清單中,只有首頁觸發條件屬於非情境式觸發條件,其餘都是情境式觸發條件。如要進一步瞭解資訊清單觸發條件定義,請參閱資訊清單

除了資訊清單觸發條件,Google Workspace 外掛程式也可以使用 Apps Script 可安裝的觸發條件

限制

資訊清單觸發條件的使用方式有特定限制。

  • 這些觸發條件僅適用於 Google Workspace 外掛程式專案,無法用於其他應用程式。
  • 由於這些觸發條件是在外掛程式資訊清單中定義,而非程式碼中,因此您無法使用 Apps Script Script 服務建立或修改這些觸發條件。
  • Gmail 內容觸發條件目前只能有 unconditional 條件。也就是說,無論電子郵件內容為何,都會觸發內容比對觸發條件。
  • 每位使用者在每個文件中,每種外掛程式只能有一個觸發條件。