Class TriggerBuilder

Outil de création de déclencheurs

Générateur générique pour les déclencheurs de script.

Méthodes

MéthodeType renvoyéBrève description
forDocument(document)DocumentTriggerBuilderCrée et renvoie un DocumentTriggerBuilder associé au document donné.
forDocument(key)DocumentTriggerBuilderCrée et renvoie un DocumentTriggerBuilder associé au document dont l'ID est spécifié.
forForm(form)FormTriggerBuilderCrée et renvoie un FormTriggerBuilder associé au formulaire donné.
forForm(key)FormTriggerBuilderCrée et renvoie un FormTriggerBuilder associé au formulaire avec l'ID donné.
forSpreadsheet(sheet)SpreadsheetTriggerBuilderCrée et renvoie un SpreadsheetTriggerBuilder associé à la feuille de calcul donnée.
forSpreadsheet(key)SpreadsheetTriggerBuilderCrée et renvoie un SpreadsheetTriggerBuilder associé à la feuille de calcul dont l'ID est spécifié.
forUserCalendar(emailId)CalendarTriggerBuilderRenvoie un compilateur pour créer des déclencheurs d'agenda.
timeBased()ClockTriggerBuilderCrée et renvoie un ClockTriggerBuilder pour créer des déclencheurs temporels.

Documentation détaillée

forDocument(document)

Crée et renvoie un DocumentTriggerBuilder associé au document donné. 

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

Paramètres

NomTypeDescription
documentDocumentDocument.

Renvois

DocumentTriggerBuilder : nouveau DocumentTriggerBuilder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

forDocument(key)

Crée et renvoie un DocumentTriggerBuilder associé au document dont l'ID est spécifié. 

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

Paramètres

NomTypeDescription
keyStringID du document.

Renvois

DocumentTriggerBuilder : nouveau DocumentTriggerBuilder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

forForm(form)

Crée et renvoie un FormTriggerBuilder associé au formulaire donné. 

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

Paramètres

NomTypeDescription
formFormLe formulaire.

Renvois

FormTriggerBuilder : le nouveau FormTriggerBuilder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

forForm(key)

Crée et renvoie un FormTriggerBuilder associé au formulaire avec l'ID donné. 

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

Paramètres

NomTypeDescription
keyStringID du formulaire.

Renvois

FormTriggerBuilder : le nouveau FormTriggerBuilder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

forSpreadsheet(sheet)

Crée et renvoie un SpreadsheetTriggerBuilder associé à la feuille de calcul donnée. 

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

Paramètres

NomTypeDescription
sheetSpreadsheetLa feuille de calcul.

Renvois

SpreadsheetTriggerBuilder : le nouveau SpreadsheetTriggerBuilder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

forSpreadsheet(key)

Crée et renvoie un SpreadsheetTriggerBuilder associé à la feuille de calcul dont l'ID est spécifié. 

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

Paramètres

NomTypeDescription
keyStringID de la feuille de calcul.

Renvois

SpreadsheetTriggerBuilder : le nouveau SpreadsheetTriggerBuilder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

forUserCalendar(emailId)

Renvoie un compilateur pour créer des déclencheurs d'agenda.

Paramètres

NomTypeDescription
emailIdStringID de messagerie de l'agenda utilisateur que le déclencheur surveille.

Renvois

CalendarTriggerBuilder : nouveau CalendarTriggerBuilder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Crée et renvoie un ClockTriggerBuilder pour créer des déclencheurs temporels. 

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

Renvois

ClockTriggerBuilder : nouveau ClockTriggerBuilder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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