Class TriggerBuilder

    • TriggerBuilder is a generic builder used for creating script triggers in Apps Script.

    • It provides methods to create trigger builders for specific Google services such as Documents, Forms, Spreadsheets, and Calendar.

    • TriggerBuilder also allows the creation of time-based triggers using the timeBased() method.

    • Each method returns a specialized builder for the respective service or time-based triggers.

    • Creating triggers requires appropriate authorization scopes depending on the service being used.
    TriggerBuilder

    A generic builder for script triggers.

    Methods

    Method Return type Brief description
    for Document(document)
    		Document Trigger Builder Creates and returns a Document Trigger Builder tied to the given document.
    for Document(key)
    		Document Trigger Builder Creates and returns a Document Trigger Builder tied to the document with the given ID.
    for Form(form)
    		Form Trigger Builder Creates and returns a Form Trigger Builder tied to the given form.
    for Form(key)
    		Form Trigger Builder Creates and returns a Form Trigger Builder tied to the form with the given ID.
    for Spreadsheet(sheet)
    		Spreadsheet Trigger Builder Creates and returns a Spreadsheet Trigger Builder tied to the given spreadsheet.
    for Spreadsheet(key)
    		Spreadsheet Trigger Builder Creates and returns a Spreadsheet Trigger Builder tied to the spreadsheet with the given ID.
    for User Calendar(emailId)
    		Calendar Trigger Builder Returns a builder for building calendar triggers.
    time Based()
    		Clock Trigger Builder Creates and returns a Clock Trigger Builder for building time-based triggers.

    Detailed documentation

    forDocument(document)

    Creates and returns a DocumentTriggerBuilder tied to the given document.

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

    Parameters

    Name Type Description
    document
    		Document The document.

    Return

    DocumentTriggerBuilder — The new DocumentTriggerBuilder.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    forDocument(key)

    Creates and returns a DocumentTriggerBuilder tied to the document with the given ID.

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

    Parameters

    Name Type Description
    key
    		String The ID for the document.

    Return

    DocumentTriggerBuilder — The new DocumentTriggerBuilder.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    forForm(form)

    Creates and returns a FormTriggerBuilder tied to the given form.

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

    Parameters

    Name Type Description
    form
    		Form The form.

    Return

    FormTriggerBuilder — The new FormTriggerBuilder.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    forForm(key)

    Creates and returns a FormTriggerBuilder tied to the form with the given ID.

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

    Parameters

    Name Type Description
    key
    		String The ID for the form.

    Return

    FormTriggerBuilder — The new FormTriggerBuilder.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    forSpreadsheet(sheet)

    Creates and returns a SpreadsheetTriggerBuilder tied to the given spreadsheet.

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

    Parameters

    Name Type Description
    sheet
    		Spreadsheet The spreadsheet.

    Return

    SpreadsheetTriggerBuilder — The new SpreadsheetTriggerBuilder.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    forSpreadsheet(key)

    Creates and returns a SpreadsheetTriggerBuilder tied to the spreadsheet with the given ID.

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

    Parameters

    Name Type Description
    key
    		String The ID for the spreadsheet.

    Return

    SpreadsheetTriggerBuilder — The new SpreadsheetTriggerBuilder.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    forUserCalendar(emailId)

    Returns a builder for building calendar triggers.

    Parameters

    Name Type Description
    email Id
    		String Email ID of the user calendar the trigger monitors.

    Return

    CalendarTriggerBuilder — The new CalendarTriggerBuilder.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

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

    Creates and returns a ClockTriggerBuilder for building time-based triggers.

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

    Return

    ClockTriggerBuilder — The new ClockTriggerBuilder.

    Authorization

    Scripts that use this method require authorization with one or more of the following scopes :

    • https://www.googleapis.com/auth/script.scriptapp
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: