Google Workspace 外掛程式的觸發條件

Apps Script 觸發條件會在發生指定事件時，觸發指定的指令碼函式 (觸發函式)。只有特定事件可能會導致觸發條件觸發，而且每個 Google Workspace 應用程式支援不同的事件組合。

觸發條件啟動時，系統會建立事件物件。此 JSON 結構包含發生事件的詳細資料。事件物件結構中的資訊因觸發條件類型而異。

建立事件物件後，Apps Script 會將該物件做為參數傳遞至觸發函式。觸發函式是一種回呼函式，您必須自行實作回呼函式，以採取任何適當的動作來回應事件。舉例來說，在擴充 Gmail 的 Google Workspace 外掛程式中，您可以定義觸發條件，在使用者開啟訊息執行緒時建立新的卡片介面。在這種情況下，您可以實作內容相關回呼函式，使用事件物件中傳遞的資料，建立組成新 UI 的資訊卡。

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

資訊清單觸發條件

與編輯器外掛程式不同，Google Workspace 外掛程式目前無法使用 Apps Script 簡易觸發條件，請改用專為 Google Workspace 外掛程式設計的觸發條件：資訊清單觸發條件。

資訊清單觸發條件完全在 Google Workspace 外掛程式的資訊清單中定義。資訊清單觸發條件的範例包括：

  • 首頁觸發條件，會建立並顯示外掛程式首頁。
  • Calendar eventOpen 觸發條件：顯示新資訊卡或在開啟日曆活動時執行其他動作。
  • 日曆 eventUpdate 觸發條件會在使用者編輯並儲存日曆活動時顯示新資訊卡或執行其他動作。
  • Drive onItemsSelected 觸發條件會在使用者在雲端硬碟中選取一或多個檔案或資料夾時，顯示新資訊卡或採取其他動作。
  • Gmail 撰寫觸發條件會在使用者在 Gmail 撰寫視窗中開啟外掛程式時顯示外掛程式資訊卡。
  • Gmail 內容相關觸發條件會在使用者開啟 Gmail 郵件時，顯示新資訊卡或執行其他動作。
  • 編輯者 onFileScopeGranted 觸發條件，系統會在使用者授予目前編輯器文件的 drive.file OAuth 範圍授權時，顯示新資訊卡。

在上方清單中，只有首頁觸發事件與內容相關，其餘則為內容觸發條件。如要進一步瞭解資訊清單觸發條件定義，請參閱「資訊清單」。

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

違規內容

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

  • 這些觸發條件僅用於 Google Workspace 外掛程式專案，在任何其他應用程式中都沒有用途。
  • 由於這些觸發條件是在外掛程式資訊清單中定義，而非在其程式碼中，您無法使用 Apps Script Script 服務建立或修改這些觸發條件。
  • Gmail 內容比對觸發條件目前只能有 unconditional 條件。 這表示不論內容為何，每封電子郵件都會觸發情境觸發條件。
  • 針對每份文件，每個外掛程式只能針對每位使用者與每位使用者設定一個觸發條件。