Class SpreadsheetTriggerBuilder

AI-generated Key Takeaways

SpreadsheetTriggerBuilder is a builder used to create triggers for spreadsheets.
You can create triggers that fire on changes, edits, form submissions, or when the spreadsheet is opened.
The create() method finalizes and returns the trigger.
Methods like onChange(), onEdit(), onFormSubmit(), and onOpen() return the builder for method chaining.

Builder for spreadsheet triggers.

Method	Return type	Brief description
`create()`	`Trigger`	Creates the trigger and returns it.
`onChange()`	`SpreadsheetTriggerBuilder`	Specifies a trigger that will fire when the spreadsheet's content or structure is changed.
`onEdit()`	`SpreadsheetTriggerBuilder`	Specifies a trigger that will fire when the spreadsheet is edited.
`onFormSubmit()`	`SpreadsheetTriggerBuilder`	Specifies a trigger that will fire when the spreadsheet has a form submitted to it.
`onOpen()`	`SpreadsheetTriggerBuilder`	Specifies a trigger that will fire when the spreadsheet is opened.

Creates the trigger and returns it.

Trigger — The created trigger.

Specifies a trigger that will fire when the spreadsheet's content or structure is changed.

const sheet = SpreadsheetApp.getActive();
ScriptApp.newTrigger('myFunction').forSpreadsheet(sheet).onChange().create();

SpreadsheetTriggerBuilder — a builder for chaining

Specifies a trigger that will fire when the spreadsheet is edited.

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

SpreadsheetTriggerBuilder — a builder for chaining

Specifies a trigger that will fire when the spreadsheet has a form submitted to it.

const sheet = SpreadsheetApp.getActive();
ScriptApp.newTrigger('myFunction')
    .forSpreadsheet(sheet)
    .onFormSubmit()
    .create();

SpreadsheetTriggerBuilder — A builder for chaining.

Specifies a trigger that will fire when the spreadsheet is opened.

const sheet = SpreadsheetApp.getActive();
ScriptApp.newTrigger('myFunction').forSpreadsheet(sheet).onOpen().create();

SpreadsheetTriggerBuilder — a builder for chaining