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 郵件時,顯示新資訊卡或執行其他動作。
- 編輯器 onFileScopeGranted 觸發事件:當使用者授予目前編輯器文件中的
drive.file
OAuth 範圍授權時,會顯示新資訊卡。
在上述清單中,只有首頁觸發條件不是情境觸發條件,其餘皆為情境觸發條件。如要進一步瞭解資訊清單觸發事件定義,請參閱「資訊清單」。
除了資訊清單觸發事件外,Google Workspace 外掛程式也可以使用 Apps Script 可安裝的觸發事件。
限制
資訊清單觸發事件的使用方式有特定限制。
- 這些觸發事件僅用於 Google Workspace 外掛程式專案,在其他應用程式中沒有任何用途。
- 由於這些觸發事件是在外掛程式資訊清單中定義,而非在程式碼中定義,因此您無法使用 Apps Script
Script
服務建立或修改這些觸發事件。 - Gmail 內容觸發條件目前只能使用
unconditional
條件。也就是說,無論內容為何,每封電子郵件都會觸發比對內容觸發條件。 - 每個外掛程式只能在每個使用者和每份文件中,設定一種觸發條件。