Class TriggerBuilder

TriggerBuilder

Outil de création générique pour les déclencheurs de script

Méthodes

MéthodeType renvoyéBrève description
forDocument(document)DocumentTriggerBuilderCrée et renvoie un objet DocumentTriggerBuilder lié au document donné.
forDocument(key)DocumentTriggerBuilderCrée et renvoie un DocumentTriggerBuilder lié au document avec l'ID donné.
forForm(form)FormTriggerBuilderCrée et renvoie un FormTriggerBuilder lié au formulaire donné.
forForm(key)FormTriggerBuilderCrée et renvoie un FormTriggerBuilder lié 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 avec l'ID donné.
forUserCalendar(emailId)CalendarTriggerBuilderRenvoie un compilateur permettant de créer des déclencheurs d'agenda.
timeBased()ClockTriggerBuilderCrée et renvoie un ClockTriggerBuilder pour créer des déclencheurs basés sur l'heure.

Documentation détaillée

forDocument(document)

Crée et renvoie un objet DocumentTriggerBuilder lié au document donné.

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

Paramètres

NomTypeDescription
documentDocumentle document

Aller-retour

DocumentTriggerBuilder : le nouveau DocumentTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

forDocument(key)

Crée et renvoie un DocumentTriggerBuilder lié au document avec l'ID donné.

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

Paramètres

NomTypeDescription
keyStringID du document

Aller-retour

DocumentTriggerBuilder : le nouveau DocumentTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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

forForm(form)

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

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

Paramètres

NomTypeDescription
formFormle formulaire

Aller-retour

FormTriggerBuilder : le nouveau FormTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

forForm(key)

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

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

Paramètres

NomTypeDescription
keyStringID du formulaire

Aller-retour

FormTriggerBuilder : le nouveau FormTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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

Aller-retour

SpreadsheetTriggerBuilder : nouveau SpreadsheetTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 avec l'ID donné.

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

Paramètres

NomTypeDescription
keyStringID de la feuille de calcul

Aller-retour

SpreadsheetTriggerBuilder : nouveau SpreadsheetTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

forUserCalendar(emailId)

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

Paramètres

NomTypeDescription
emailIdStringAdresse e-mail de l'agenda de l'utilisateur surveillé par le déclencheur.

Aller-retour

CalendarTriggerBuilder : nouveau CalendarTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 basés sur l'heure.

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

Aller-retour

ClockTriggerBuilder : le nouveau ClockTriggerBuilder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

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