Cette page a été traduite par l'API Cloud Translation.

Déclencheurs installables

Comme les déclencheurs simples, les déclencheurs installables permettent à Apps Script d'exécuter automatiquement une fonction lorsqu'un événement spécifique, tel que l'ouverture d'un document, se produit. Toutefois, 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 le temps (horloge), et ils peuvent être contrôlés de manière programmatique. Pour les déclencheurs simples et 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

Même si 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 mode lecture seule (consultation 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 script et les requêtes API ne déclenchent pas l'exécution des déclencheurs. Par exemple, l'appel de FormResponse.submit() pour envoyer une nouvelle réponse au formulaire n'entraîne pas l'exécution du déclencheur d'envoi du formulaire.

Remarque :Form.submitGrades() fait exception à cette restriction. Si votre code utilise un déclencheur onFormSubmit, l'appel de Form.submitGrades() déclenche la condition onFormSubmit et entraîne une boucle infinie. Pour éviter la boucle infinie, ajoutez du code qui vérifie si des notes existent déjà avant d'appeler submitGrades().
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 (s'il dispose d'un accès en modification), mais il s'exécute en tant que votre 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, et non nécessairement depuis celui qui a ouvert le document. Toutefois, vous pouvez créer un déclencheur installable pour chaque compte, ce qui entraînera l'envoi d'un e-mail depuis 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 temporels

Un déclencheur basé sur le temps (également appelé déclencheur par horloge) est semblable à une tâche Cron sous Unix. Les déclencheurs basés sur le temps permettent d'exécuter des scripts à une heure précise ou à un intervalle récurrent, aussi fréquemment que toutes les minutes ou aussi rarement qu'une fois par mois. (Notez qu'un module complémentaire ne peut utiliser un déclencheur basé sur le temps qu'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 maintient cette heure cohérente d'un jour à l'autre afin que 24 heures s'écoulent 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 tous les espaces dans lesquels elle 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

Les déclencheurs basés sur les événements installables sont conceptuellement similaires aux déclencheurs simples tels que onOpen(), mais ils peuvent répondre à des événements supplémentaires et se comportent différemment.

Par exemple, le déclencheur d'ouverture installable pour 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. Toutefois, la version installable peut appeler des services qui nécessitent 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.

Il existe plusieurs déclencheurs installables pour les applications :

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 Modification installable s'exécute lorsqu'un utilisateur modifie une valeur dans une feuille de calcul.
Un déclencheur 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 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é vers 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 les scripts autonomes et liés. Par exemple, un script autonome peut créer par programmation 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 manuellement les déclencheurs

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

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

Gérer les déclencheurs de manière programmatique

Vous pouvez également créer et supprimer des déclencheurs de manière programmatique à l'aide du service de script. Commencez par appeler ScriptApp.newTrigger(functionName), qui renvoie un TriggerBuilder.

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

triggers/triggers.gs

Afficher sur GitHub

/**
 * 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).

triggers/triggers.gs

Afficher sur GitHub

/**
 * 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 un déclencheur installable existant de manière programmatique, 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 transmettant l'ID en tant qu'argument à la fonction ci-dessous.

triggers/triggers.gs

Afficher sur GitHub

/**
 * 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 se déclenche, mais que la fonction génère une exception ou ne s'exécute pas correctement, aucun message d'erreur ne s'affiche à l'écran. Après tout, lorsque le déclencheur basé sur le temps 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 inclut 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:

Accédez à script.google.com.
Sur la gauche, cliquez sur Mes déclencheurs.
Pour supprimer un déclencheur, cliquez sur Plus > Supprimer le déclencheur à droite du déclencheur.

Remarque :Vous ne pouvez pas désactiver les déclencheurs simples tels que onOpen() à partir de cette page. Vous devez plutôt modifier le script approprié et supprimer ou renommer la fonction onOpen().

Déclencheurs dans les modules complémentaires

En plus des déclencheurs installables, vous pouvez utiliser des déclencheurs de fichier manifeste dans les modules complémentaires. Pour en savoir plus, consultez Déclencheurs pour les modules complémentaires Google Workspace.