Class TriggerBuilder

TriggerBuilder

用於指令碼觸發條件的通用建構工具。

方法

方法傳回類型簡短說明
forDocument(document)DocumentTriggerBuilder建立並傳回與指定文件相連結的 DocumentTriggerBuilder。
forDocument(key)DocumentTriggerBuilder建立並傳回與具有指定 ID 的文件繫結的 DocumentTriggerBuilder。
forForm(form)FormTriggerBuilder建立並傳回與指定表單繫結的 FormTriggerBuilder。
forForm(key)FormTriggerBuilder建立並傳回與具有指定 ID 的表單繫結的 FormTriggerBuilder。
forSpreadsheet(sheet)SpreadsheetTriggerBuilder建立並傳回與指定試算表相連結的 SpreadsheetTriggerBuilder。
forSpreadsheet(key)SpreadsheetTriggerBuilder使用指定的試算表來建立並傳回 SpreadsheetTriggerBuilder 編號。
forUserCalendar(emailId)CalendarTriggerBuilder傳回用來建立日曆觸發條件的建構工具。
timeBased()ClockTriggerBuilder建立並傳回 ClockTriggerBuilder，用於建構時間型觸發條件。

內容詳盡的說明文件

forDocument(document)

建立並傳回與指定文件相連結的 DocumentTriggerBuilder。 

ScriptApp.newTrigger('myFunction')
  .forDocument(DocumentApp.getActiveDocument())
  .onOpen()
  .create();

參數

名稱類型說明
documentDocument文件

回攻員

DocumentTriggerBuilder：新的 DocumentTriggerBuilder

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

forDocument(key)

建立並傳回與具有指定 ID 的文件繫結的 DocumentTriggerBuilder。 

ScriptApp.newTrigger('myFunction')
  .forDocument('1234567890abcdefghijklmnopqrstuvwxyz')
  .onOpen()
  .create();

參數

名稱類型說明
keyString文件 ID

回攻員

DocumentTriggerBuilder：新的 DocumentTriggerBuilder

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

forForm(form)

建立並傳回與指定表單繫結的 FormTriggerBuilder。 

ScriptApp.newTrigger('myFunction')
  .forForm(FormApp.getActiveForm())
  .onFormSubmit()
  .create();

參數

名稱類型說明
formForm表單

回攻員

FormTriggerBuilder - 新的 FormTriggerBuilder

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

forForm(key)

建立並傳回與具有指定 ID 的表單繫結的 FormTriggerBuilder。 

ScriptApp.newTrigger('myFunction')
  .forForm('1234567890abcdefghijklmnopqrstuvwxyz')
  .onFormSubmit()
  .create();

參數

名稱類型說明
keyString表單 ID

回攻員

FormTriggerBuilder - 新的 FormTriggerBuilder

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

  • https://www.googleapis.com/auth/forms.currentonly
  • https://www.googleapis.com/auth/forms

forSpreadsheet(sheet)

建立並傳回與指定試算表相連結的 SpreadsheetTriggerBuilder。 

ScriptApp.newTrigger('myFunction')
  .forSpreadsheet(SpreadsheetApp.getActive())
  .onEdit()
  .create();

參數

名稱類型說明
sheetSpreadsheet此試算表

回攻員

SpreadsheetTriggerBuilder — 新的 SheetTriggerBuilder

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forSpreadsheet(key)

使用指定的試算表來建立並傳回 SpreadsheetTriggerBuilder 編號。 

ScriptApp.newTrigger('myFunction')
  .forSpreadsheet('1234567890abcdefghijklmnopqrstuvwxyz')
  .onEdit()
  .create();

參數

名稱類型說明
keyString試算表 ID

回攻員

SpreadsheetTriggerBuilder — 新的 SheetTriggerBuilder

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

forUserCalendar(emailId)

傳回用來建立日曆觸發條件的建構工具。

參數

名稱類型說明
emailIdString觸發條件監控的使用者日曆電子郵件 ID。

回攻員

CalendarTriggerBuilder：新的 CalendarTriggerBuilder。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

  • https://www.googleapis.com/auth/calendar
  • https://www.googleapis.com/auth/calendar.readonly
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/calendar.events.readonly
  • https://www.google.com/calendar/feeds

timeBased()

建立並傳回 ClockTriggerBuilder，用於建構時間型觸發條件。 

ScriptApp.newTrigger('myFunction')
  .timeBased()
  .atDate(2013, 10, 31)
  .create();

回攻員

ClockTriggerBuilder - 新的 ClockTriggerBuilder

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

  • https://www.googleapis.com/auth/script.scriptapp