Class SpreadsheetTriggerBuilder

    • 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.
    SpreadsheetTriggerBuilder

    Builder for spreadsheet triggers.

    Methods

    Method Return type Brief description
    create()
    		Trigger Creates the trigger and returns it.
    on Change()
    		Spreadsheet Trigger Builder Specifies a trigger that fires when the spreadsheet's content or structure is changed.
    on Edit()
    		Spreadsheet Trigger Builder Specifies a trigger that fires when the spreadsheet is edited.
    on Form Submit()
    		Spreadsheet Trigger Builder Specifies a trigger that fires when the spreadsheet has a form submitted to it.
    on Open()
    		Spreadsheet Trigger Builder Specifies a trigger that fires when the spreadsheet is opened.

    Detailed documentation

    create()

    Creates the trigger and returns it.

    Return

    Trigger — The created trigger.

    onChange()

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

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

    Return

    SpreadsheetTriggerBuilder — A builder for chaining.

    onEdit()

    Specifies a trigger that fires when the spreadsheet is edited.

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

    Return

    SpreadsheetTriggerBuilder — A builder for chaining.

    onFormSubmit()

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

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

    Return

    SpreadsheetTriggerBuilder — A builder for chaining.

    onOpen()

    Specifies a trigger that fires when the spreadsheet is opened.

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

    Return

    SpreadsheetTriggerBuilder — A builder for chaining.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: