簡易觸發條件和可安裝的觸發條件可讓 Apps Script 在特定事件發生時自動執行函式。觸發條件啟動時，Apps Script 會將函式物件做為引數傳遞 (通常稱為 e)。事件物件包含觸發觸發事件的背景資訊相關資訊。舉例來說，下方的程式碼範例顯示 Google 試算表指令碼的簡易 onEdit(e) 觸發條件，該指令碼會使用事件物件判斷編輯的儲存格。
function onEdit(e){
// Set a comment on the edited cell to indicate when it was changed.
var range = e.range;
range.setNote('Last modified: ' + new Date());
}
本頁面針對不同觸發事件類型詳細說明事件物件中的欄位。
Google 試算表活動
各種 Google 試算表專屬觸發條件可讓指令碼在試算表中回應使用者的動作。
開啟(簡單易用且可安裝) |
|
|---|---|
authMode |
LIMITED |
source |
Spreadsheet |
triggerUid |
產生此事件的觸發條件 ID (僅限可安裝的觸發條件)。 4034124084959907503 |
user |
amin@example.com |
變更(可安裝) |
|
|---|---|
authMode |
FULL |
changeType |
變更的類型 ( INSERT_ROW |
source |
Spreadsheet |
triggerUid |
產生此事件的觸發條件 ID。 4034124084959907503 |
user |
amin@example.com |
編輯(簡單易用且可安裝) |
|
|---|---|
authMode |
LIMITED |
oldValue |
編輯之前的儲存格值 (如果有的話)。只有在編輯的範圍是單一儲存格時才能使用。如果儲存格沒有之前的內容，則為未定義。 1234 |
range |
Range |
source |
Spreadsheet |
triggerUid |
產生此事件的觸發條件 ID (僅限可安裝的觸發條件)。 4034124084959907503 |
user |
amin@example.com |
value |
編輯後的新儲存格值。只有在編輯的範圍是單一儲存格時才能使用。 10 |
提交表單(可安裝) |
|
|---|---|
authMode |
FULL |
namedValues |
包含表單提交中問題名稱和值的物件。 {
'First Name': ['Jane'],
'Timestamp': ['6/7/2015 20:54:13'],
'Last Name': ['Doe']
}
|
range |
Range |
triggerUid |
產生此事件的觸發條件 ID。 4034124084959907503 |
values |
陣列值與試算表中顯示的順序相同。 ['2015/05/04 15:00', 'amin@example.com', 'Bob', '27', 'Bill', '28', 'Susan', '25'] |
Google 文件活動
觸發條件可讓 Google 文件在使用者開啟文件時回應要求。
開啟(簡單易用且可安裝) |
|
|---|---|
authMode |
LIMITED |
source |
Document |
triggerUid |
產生此事件的觸發條件 ID (僅限可安裝的觸發條件)。 4034124084959907503 |
user |
amin@example.com |
Google 簡報活動
觸發條件可讓 Google 簡報在使用者開啟簡報時回應回應。
開啟(簡單) |
|
|---|---|
authMode |
LIMITED |
source |
Presentation |
user |
amin@example.com |
Google 表單活動
Google 表單專屬的觸發條件可在使用者編輯表單或提交回應時，讓指令碼做出回應。
開啟* (簡單且可安裝) |
|
|---|---|
authMode |
LIMITED |
source |
Form |
triggerUid |
產生此事件的觸發條件 ID (僅限可安裝的觸發條件)。 4034124084959907503 |
user |
amin@example.com |
* 如果使用者開啟表單回覆內容，而非編輯者開啟表單修改表單，則不會發生這個事件。
提交表單(可安裝) |
|
|---|---|
authMode |
FULL |
response |
FormResponse |
source |
Form |
triggerUid |
產生此事件的觸發條件 ID。 4034124084959907503 |
Google 日曆活動
使用者的日曆活動更新 (建立、編輯或刪除) 時就會觸發日曆。
但請放心，這些觸發條件不會指出哪個事件有變動，或是該事件的變更方式。 而是表示程式碼需要執行漸進式同步處理作業，才能納入日曆最近的變更。如需這項程序的完整說明，請參閱 calendar API 的同步處理資源指南。
如要與 Apps Script 中的 Google 日曆同步處理，請執行下列步驟：
- 為指令碼專案啟用日曆進階服務。內建的日曆服務並不足以滿足這個工作流程。
- 決定要同步處理的日曆。對於這類日曆，請使用 Google 日曆進階服務的 Events.list() 方法執行初始同步處理作業。
- 初次同步處理的結果會傳回該日曆的
nextSyncToken。請儲存這個憑證，以便日後使用。 - 當 Apps Script
EventUpdated觸發條件觸發指出日曆活動變更時，請使用儲存的nextSyncToken為受影響的日曆執行漸進式同步作業。這基本上是另一個 Events.list() 要求，但提供nextSyncToken會將回應限制於上次同步處理後已變更的事件。 - 檢查同步處理的回應，瞭解有哪些事件已更新，且您的程式碼能適當回應。例如，您可以記錄變更、更新試算表、傳送電子郵件通知，或執行其他動作。
- 使用漸進式同步要求傳回的
nextSyncToken，更新您為該日曆儲存的nextSyncToken。這樣會強制下一次同步處理作業只傳回最新的變更。
EventUpdated(可安裝) |
|
|---|---|
authMode |
FULL |
calendarId |
發生事件更新的日曆字串 ID。 susan@example.com |
triggerUid |
產生此事件的觸發條件 ID。 4034124084959907503 |
Google Workspace 外掛程式活動
當使用者安裝外掛程式時，onInstall() 觸發條件會自動執行。
安裝(簡單) |
|
|---|---|
authMode |
FULL |
Google Chat 應用程式事件
如要瞭解 Google Chat 中的事件物件，請參閱「接收及回覆與 Google Chat 應用程式的互動」。
時間導向事件
時間型觸發條件 (也稱為時鐘觸發條件) 可讓指令碼在特定時間或以週期性間隔執行。
| 時間導向 (可安裝) | |
|---|---|
authMode |
FULL |
day-of-month |
介於 這個屬性名稱含有破折號，因此必須透過 31 |
day-of-week |
介於 這個屬性名稱含有破折號，因此必須透過 7 |
hour |
介於 23 |
minute |
介於 59 |
month |
介於 12 |
second |
介於 59 |
timezone |
時區。 UTC |
triggerUid |
產生此事件的觸發條件 ID。 4034124084959907503 |
week-of-year |
介於 這個屬性名稱含有破折號，因此必須透過 52 |
year |
所屬年。 2015 |