Déclencheurs installables

Comme les déclencheurs simples, les déclencheurs installables permettent à Apps Script d'exécuter automatiquement une fonction lorsqu'un certain événement, tel que l'ouverture d'un document, se produit. Les déclencheurs installables offrent plus de flexibilité que les déclencheurs simples: ils peuvent appeler des services nécessitant une autorisation, ils proposent plusieurs types d'événements supplémentaires, y compris des déclencheurs basés sur l'heure (horloge), et ils peuvent être contrôlés de manière programmatique. Pour les déclencheurs simples et les déclencheurs installables, Apps Script transmet à la fonction déclenchée un objet d'événement contenant des informations sur le contexte dans lequel l'événement s'est produit.

Restrictions

Bien que les déclencheurs installables offrent plus de flexibilité que les déclencheurs simples, ils sont toujours soumis à plusieurs restrictions:

  • Elles ne s'exécutent pas si un fichier est ouvert en lecture seule (lecture ou commentaire). Pour les scripts autonomes, les utilisateurs doivent au moins disposer d'un accès en lecture au fichier de script pour que les déclencheurs s'exécutent correctement.

  • Les exécutions de scripts et les requêtes API n'entraînent pas l'exécution des déclencheurs. Par exemple, l'appel de FormResponse.submit() pour envoyer une nouvelle réponse à un formulaire n'entraîne pas l'exécution du déclencheur d'envoi du formulaire.

  • Les déclencheurs installables s'exécutent toujours sous le compte de la personne qui les a créés. Par exemple, si vous créez un déclencheur d'ouverture installable, il s'exécute lorsque votre collègue ouvre le document (si votre collègue dispose d'un accès en modification), mais il s'exécute en tant que compte. Cela signifie que si vous créez un déclencheur pour envoyer un e-mail lorsqu'un document est ouvert, l'e-mail est toujours envoyé depuis votre compte, pas nécessairement celui qui a ouvert le document. Toutefois, vous pouvez créer un déclencheur installable pour chaque compte, ce qui entraînerait l'envoi d'un e-mail par chaque compte.

  • Un compte donné ne peut pas voir les déclencheurs installés à partir d'un deuxième compte, même si le premier compte peut toujours les activer.

  • Les déclencheurs installables sont soumis aux limites de quota des déclencheurs Apps Script.

Déclencheurs basés sur le temps

Un déclencheur temporel (également appelé déclencheur d'horloge) est semblable à une tâche Cron dans Unix. Les déclencheurs basés sur le temps permettent aux scripts de s'exécuter à un moment précis ou à des intervalles récurrents, toutes les minutes ou une fois par mois. (Notez qu'un module complémentaire peut utiliser un déclencheur temporel une fois par heure au maximum.) L'heure peut être légèrement aléatoire. Par exemple, si vous créez un déclencheur récurrent à 9h, Apps Script choisit une heure comprise entre 9h et 10h, puis s'assure de la cohérence de l'heure d'un jour à l'autre afin qu'un délai de 24 heures s'écoule avant que le déclencheur ne se déclenche à nouveau.

Voici un exemple d'application Google Chat qui publie un message toutes les minutes dans chaque espace où l'application se trouve:

// Example app for Google Chat that demonstrates app-initiated messages
// by spamming the user every minute.
//
// This app makes use of the Apps Script OAuth2 library at:
//     https://github.com/googlesamples/apps-script-oauth2
//
// Follow the instructions there to add the library to your script.

// When added to a space, we store the space's ID in ScriptProperties.
function onAddToSpace(e) {
  PropertiesService.getScriptProperties()
      .setProperty(e.space.name, '');
  return {
    'text': 'Hi! I\'ll post a message here every minute. ' +
            'Please remove me after testing or I\'ll keep spamming you!'
  };
}

// When removed from a space, we remove the space's ID from ScriptProperties.
function onRemoveFromSpace(e) {
  PropertiesService.getScriptProperties()
      .deleteProperty(e.space.name);
}

// Add a trigger that invokes this function every minute in the
// "Edit > Current Project's Triggers" menu. When it runs, it
// posts in each space the app was added to.
function onTrigger() {
  var spaceIds = PropertiesService.getScriptProperties()
      .getKeys();
  var message = { 'text': 'Hi! It\'s now ' + (new Date()) };
  for (var i = 0; i < spaceIds.length; ++i) {
    postMessage(spaceIds[i], message);
  }
}
var SCOPE = 'https://www.googleapis.com/auth/chat.bot';
// The values below are copied from the JSON file downloaded upon
// service account creation.
// For SERVICE_ACCOUNT_PRIVATE_KEY, remember to include the BEGIN and END lines
// of the private key
var SERVICE_ACCOUNT_PRIVATE_KEY = '...';
var SERVICE_ACCOUNT_EMAIL = 'service-account@project-id.iam.gserviceaccount.com';

// Posts a message into the given space ID via the API, using
// service account authentication.
function postMessage(spaceId, message) {
  var service = OAuth2.createService('chat')
      .setTokenUrl('https://accounts.google.com/o/oauth2/token')
      .setPrivateKey(SERVICE_ACCOUNT_PRIVATE_KEY)
      .setClientId(SERVICE_ACCOUNT_EMAIL)
      .setPropertyStore(PropertiesService.getUserProperties())
      .setScope(SCOPE);
  if (!service.hasAccess()) {
    Logger.log('Authentication error: %s', service.getLastError());
    return;
  }
  var url = 'https://chat.googleapis.com/v1/' + spaceId + '/messages';
  UrlFetchApp.fetch(url, {
    method: 'post',
    headers: { 'Authorization': 'Bearer ' + service.getAccessToken() },
    contentType: 'application/json',
    payload: JSON.stringify(message),
  });
}

Déclencheurs basés sur des événements

D'un point de vue conceptuel, les déclencheurs basés sur des événements installables sont semblables aux déclencheurs simples tels que onOpen(), mais ils peuvent répondre à des événements supplémentaires et se comporter différemment.

Par exemple, le déclencheur d'ouverture installable de Google Sheets s'active chaque fois que la feuille de calcul est ouverte par un utilisateur disposant d'un accès en modification, tout comme le déclencheur onOpen() simple. Cependant, la version installable peut appeler des services nécessitant une autorisation. La version installable s'exécute avec l'autorisation de l'utilisateur qui a créé le déclencheur, même si un autre utilisateur disposant d'un accès en modification ouvre la feuille de calcul.

Plusieurs déclencheurs peuvent être installés pour les applicationsGoogle Workspace :

  • Un déclencheur open installable s'exécute lorsqu'un utilisateur ouvre une feuille de calcul, un document ou un formulaire qu'il est autorisé à modifier.
  • Un déclencheur edit installable s'exécute lorsqu'un utilisateur modifie une valeur dans une feuille de calcul.
  • Un déclencheur de modification installable s'exécute lorsqu'un utilisateur modifie la structure d'une feuille de calcul elle-même, par exemple en ajoutant une feuille ou en supprimant une colonne.
  • Un déclencheur d'envoi de formulaire installable s'exécute lorsqu'un utilisateur répond à un formulaire. Il existe deux versions du déclencheur d'envoi de formulaire : une pour Google Forms et une pour Sheets si le formulaire est envoyé dans une feuille de calcul.
  • Un déclencheur d'événement d'agenda installable s'exécute lorsque les événements d'agenda d'un utilisateur sont mis à jour (créés, modifiés ou supprimés).

Vous pouvez utiliser des déclencheurs installables dans des scripts autonomes et liés. Par exemple, un script autonome peut créer de manière automatisée un déclencheur installable pour un fichier Google Sheets arbitraire en appelant TriggerBuilder.forSpreadsheet(key) et en transmettant l'ID de la feuille de calcul.

Gérer les déclencheurs manuellement

Pour créer manuellement un déclencheur installable dans l'éditeur de script, procédez comme suit:

  1. Ouvrez votre projet Apps Script.
  2. À gauche, cliquez sur Déclencheurs .
  3. En bas à droite, cliquez sur Ajouter un déclencheur.
  4. Sélectionnez et configurez le type de déclencheur que vous souhaitez créer.
  5. Cliquez sur Enregistrer.

Gérer les déclencheurs par programmation

Vous pouvez également créer et supprimer des déclencheurs de manière automatisée avec le service Script. Commencez par appeler ScriptApp.newTrigger(functionName), qui renvoie un TriggerBuilder.

L'exemple suivant montre comment créer deux déclencheurs basés sur l'heure : un déclencheur toutes les 6 heures et un autre tous les lundis à 9h (dans le fuseau horaire défini pour votre script).

déclencheurs/déclencheurs.gs
/**
 * Creates two time-driven triggers.
 * @see https://developers.google.com/apps-script/guides/triggers/installable#time-driven_triggers
 */
function createTimeDrivenTriggers() {
  // Trigger every 6 hours.
  ScriptApp.newTrigger('myFunction')
      .timeBased()
      .everyHours(6)
      .create();
  // Trigger every Monday at 09:00.
  ScriptApp.newTrigger('myFunction')
      .timeBased()
      .onWeekDay(ScriptApp.WeekDay.MONDAY)
      .atHour(9)
      .create();
}

L'exemple suivant montre comment créer un déclencheur d'ouverture installable pour une feuille de calcul. Notez que, contrairement à un déclencheur onOpen() simple, le script du déclencheur installable n'a pas besoin d'être lié à la feuille de calcul. Pour créer ce déclencheur à partir d'un script autonome, remplacez simplement SpreadsheetApp.getActive() par un appel à SpreadsheetApp.openById(id).

déclencheurs/déclencheurs.gs
/**
 * Creates a trigger for when a spreadsheet opens.
 * @see https://developers.google.com/apps-script/guides/triggers/installable
 */
function createSpreadsheetOpenTrigger() {
  const ss = SpreadsheetApp.getActive();
  ScriptApp.newTrigger('myFunction')
      .forSpreadsheet(ss)
      .onOpen()
      .create();
}

Pour modifier de manière automatisée un déclencheur installable existant, vous devez le supprimer et en créer un autre. Si vous avez déjà stocké l'ID d'un déclencheur, vous pouvez le supprimer en le transmettant en tant qu'argument à la fonction ci-dessous.

déclencheurs/déclencheurs.gs
/**
 * Deletes a trigger.
 * @param {string} triggerId The Trigger ID.
 * @see https://developers.google.com/apps-script/guides/triggers/installable
 */
function deleteTrigger(triggerId) {
  // Loop over all triggers.
  const allTriggers = ScriptApp.getProjectTriggers();
  for (let index = 0; index < allTriggers.length; index++) {
    // If the current trigger is the correct one, delete it.
    if (allTriggers[index].getUniqueId() === triggerId) {
      ScriptApp.deleteTrigger(allTriggers[index]);
      break;
    }
  }
}

Erreurs dans les déclencheurs

Lorsqu'un déclencheur installable s'exécute, mais que la fonction génère une exception ou échoue à s'exécuter correctement, aucun message d'erreur ne s'affiche à l'écran. En effet, lorsqu'un déclencheur basé sur l'heure s'exécute ou qu'un autre utilisateur active votre déclencheur d'envoi de formulaire, vous n'êtes peut-être même pas devant votre ordinateur.

À la place, Apps Script vous envoie un e-mail semblable à celui-ci:

From: noreply-apps-scripts-notifications@google.com
Subject: Summary of failures for Google Apps Script
Your script has recently failed to finish successfully.
A summary of the failure(s) is shown below.

L'e-mail contient un lien permettant de désactiver ou de reconfigurer le déclencheur. Si le script est lié à un fichier Google Sheets, Docs ou Forms, l'e-mail inclut également un lien vers ce fichier. Ces liens vous permettent de désactiver le déclencheur ou de modifier le script pour corriger le bug.

Pour examiner tous les déclencheurs associés à votre compte Google et désactiver ceux dont vous n'avez plus besoin, procédez comme suit:

  1. Accédez à script.google.com.
  2. À gauche, cliquez sur Mes déclencheurs.

  3. Pour supprimer un déclencheur, à droite de celui-ci, cliquez sur Plus > Supprimer le déclencheur.

Déclencheurs installables dans les modules complémentaires

Pour en savoir plus sur l'utilisation de déclencheurs installables dans les modules complémentaires, consultez la section Déclencheurs de modules complémentaires.