Class Trigger

Déclencheur

Un déclencheur de script.

Méthodes

Méthode	Type renvoyé	Brève description
getEventType()	EventType	Indique le type d'événement sur lequel le déclencheur se déclenche.
getHandlerFunction()	String	Renvoie la fonction qui sera appelée lorsque le déclencheur se déclenchera.
getTriggerSource()	TriggerSource	Indique la source des événements qui déclencheront le déclencheur.
getTriggerSourceId()	String	Renvoie l'ID propre à la source.
getUniqueId()	String	Renvoie un identifiant unique qui permet de distinguer les déclencheurs les uns des autres.

Documentation détaillée

getEventType()

Indique le type d'événement sur lequel le déclencheur se déclenche.

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

EventType : 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 champs d'application suivants:

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

---

getHandlerFunction()

Renvoie la fonction qui sera appelée lorsque le déclencheur se déclenchera.

// 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 champs d'application suivants:

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

---

getTriggerSource()

Indique la source des événements qui déclencheront le déclencheur.

Par exemple, un déclencheur de feuille de calcul onEdit renverrait SPREADSHEETS, ou un déclencheur basé sur le temps renverrait 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

TriggerSource : éditeur pour lequel le déclencheur est défini

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

---

getTriggerSourceId()

Renvoie l'ID propre à 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 valeur renvoie la valeur nulle.

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 champs d'application suivants:

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

---

getUniqueId()

Renvoie un identifiant unique qui permet de 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 champs d'application suivants:

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