un déclencheur de script ;
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
get | Event | Renvoie le type d'événement sur lequel le déclencheur s'active. |
get | String | Renvoie la fonction appelée lorsque le déclencheur est activé. |
get | Trigger | Renvoie la source des événements qui provoquent l'activation du déclencheur. |
get | String | Renvoie l'ID spécifique à la source. |
get | String | Renvoie un identifiant unique qui peut être utilisé pour distinguer les déclencheurs les uns des autres. |
Documentation détaillée
get Event Type()
Renvoie le type d'événement sur lequel le déclencheur s'active.
const triggers = ScriptApp.getProjectTriggers(); for (let i = 0; i < triggers.length; i++) { if (triggers[i].getEventType() === ScriptApp.EventType.CLOCK) { // Some code here - other options are: // ScriptApp.EventType.ON_EDIT // ScriptApp.EventType.ON_FORM_SUBMIT // ScriptApp.EventType.ON_OPEN } }
Renvois
Event : type d'événement pour lequel il s'agit d'un déclencheur.
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
get Handler Function()
Renvoie la fonction appelée lorsque le déclencheur est activé.
// Create a trigger for the script. ScriptApp.newTrigger('myFunction') .forSpreadsheet('id of my spreadsheet') .onEdit() .create(); Logger.log(ScriptApp.getProjectTriggers()[0] .getHandlerFunction()); // logs "myFunction"
Renvois
String : nom de la méthode.
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
get Trigger Source()
Renvoie la source des événements qui provoquent l'activation du déclencheur.
Par exemple, un déclencheur onEdit de feuille de calcul renvoie SPREADSHEETS, ou un déclencheur basé sur l'heure renvoie CLOCK.
const triggers = ScriptApp.getProjectTriggers(); for (let i = 0; i < triggers.length; i++) { if (triggers[i].getTriggerSource() === ScriptApp.TriggerSource.CLOCK) { Logger.log(`${triggers[i].getUniqueId()} source is clock`); } else if ( triggers[i].getTriggerSource() === ScriptApp.TriggerSource.SPREADSHEETS) { Logger.log(`${triggers[i].getUniqueId()} source is spreadsheets`); } }
Renvois
Trigger : éditeur pour lequel le déclencheur est activé.
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
get Trigger Source Id()
Renvoie l'ID spécifique à la source.
Par exemple, si la source du déclencheur est une feuille de calcul, il s'agit de l'ID de la feuille de calcul. Pour les événements d'horloge, cette méthode renvoie null.
Renvois
String : ID de l'entité de l'éditeur pour laquelle il s'agit d'un déclencheur.
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
get Unique Id()
Renvoie un identifiant unique qui peut être utilisé pour distinguer les déclencheurs les uns des autres.
Renvois
String : identifiant unique du déclencheur.
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