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	创建并返回与具有给定 ID 的电子表格相关联的 SpreadsheetTriggerBuilder。
forUserCalendar(emailId)	CalendarTriggerBuilder	返回用于构建日历触发器的构建器。
timeBased()	ClockTriggerBuilder	创建并返回 ClockTriggerBuilder，以构建基于时间的触发器。

详细文档

forDocument(document)

创建并返回与给定文档相关联的 DocumentTriggerBuilder。

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

参数

名称	类型	说明
document	Document	文档

返回

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();

参数

名称	类型	说明
key	String	文档的 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();

参数

名称	类型	说明
form	Form	表单

返回

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();

参数

名称	类型	说明
key	String	表单的 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();

参数

名称	类型	说明
sheet	Spreadsheet	电子表格

返回

SpreadsheetTriggerBuilder - 新的 SpreadsheetTriggerBuilder

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

forSpreadsheet(key)

创建并返回与具有给定 ID 的电子表格相关联的 SpreadsheetTriggerBuilder。

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

参数

名称	类型	说明
key	String	电子表格的 ID

返回

SpreadsheetTriggerBuilder - 新的 SpreadsheetTriggerBuilder

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

---

forUserCalendar(emailId)

返回用于构建日历触发器的构建器。

参数

名称	类型	说明
emailId	String	触发器监控的用户日历的电子邮件 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