Déclencheurs simples

Les déclencheurs permettent à Google Apps Script d'exécuter automatiquement une fonction lorsqu'un événement spécifique se produit, par exemple lorsqu'un document est ouvert. Les déclencheurs simples sont un ensemble de fonctions réservées intégrées à Apps Script, comme la fonction onOpen(e), qui s'exécute lorsqu'un utilisateur ouvre un fichier Google Docs, Sheets, Slides ou Forms. Les déclencheurs installables offrent plus de fonctionnalités que les déclencheurs simples, mais doivent être activés avant utilisation. Pour les deux types de déclencheurs, Apps Script transmet à la fonction déclenchée un objet d'événement qui contient des informations sur le contexte dans lequel l'événement s'est produit.

Pour savoir comment utiliser les déclencheurs dans les projets de modules complémentaires Google Workspace, consultez Déclencheurs pour les modules complémentaires Google Workspace.

Premiers pas

Pour utiliser un déclencheur simple, créez une fonction qui utilise l'un des noms de fonction réservés suivants :

• onOpen(e) s'exécute lorsqu'un utilisateur ouvre une feuille de calcul, un document, une présentation ou un formulaire qu'il est autorisé à modifier.
• onInstall(e) s'exécute lorsqu'un utilisateur installe un module complémentaire de l'éditeur depuis Google Docs, Sheets, Slides ou Forms.
• onEdit(e) s'exécute lorsqu'un utilisateur modifie une valeur dans une feuille de calcul.
• onSelectionChange(e) s'exécute lorsqu'un utilisateur modifie la sélection dans une feuille de calcul.
• doGet(e) s'exécute lorsqu'un utilisateur consulte une application Web ou qu'un programme envoie une requête HTTP GET à une application Web.
• doPost(e) s'exécute lorsqu'un programme envoie une requête HTTP POST à une application Web.

Le paramètre e dans les noms de fonction ci-dessus est un objet d'événement transmis à la fonction. L'objet contient des informations sur le contexte qui a déclenché le déclencheur, mais son utilisation est facultative.

Restrictions

Étant donné que les déclencheurs simples se déclenchent automatiquement, sans demander d'autorisation à l'utilisateur, ils sont soumis à plusieurs restrictions :

• Le script doit être lié à un fichier Google Sheets, Slides, Docs ou Forms, ou être un module complémentaire qui étend l'une de ces applications.
• Ils ne s'exécutent pas si un fichier est ouvert en mode lecture seule (affichage ou commentaire).
• Les exécutions de script et les requêtes API n'entraînent pas l'exécution des déclencheurs. Par exemple, l'appel de Range.setValue() pour modifier une cellule n'entraîne pas l'exécution du déclencheur onEdit de la feuille de calcul.
• Ils ne peuvent pas accéder aux services qui nécessitent une autorisation. Par exemple, un déclencheur simple ne peut pas envoyer d'e-mail, car le service Gmail nécessite une autorisation, mais il peut traduire une expression avec le service Language, qui est anonyme.
• Ils peuvent modifier le fichier auquel ils sont liés, mais ne peuvent pas accéder à d'autres fichiers, car cela nécessiterait une autorisation.
• Ils peuvent ou non être en mesure de déterminer l'identité de l'utilisateur actuel, en fonction d'un ensemble complexe de restrictions de sécurité.
• Ils ne peuvent pas s'exécuter pendant plus de 30 secondes.
• Dans certains cas, les modules complémentaires de l'éditeur exécutent leurs onOpen(e) et onEdit(e) déclencheurs simples en mode sans autorisation, ce qui présente quelques complications supplémentaires. Pour en savoir plus, consultez le guide sur le cycle de vie de l'autorisation des modules complémentaires.
• Les déclencheurs simples sont soumis aux limites de quotas des déclencheurs Apps Script quota limits.

Ces restrictions ne s'appliquent pas à doGet(e) ni à doPost(e).

onOpen(e)

Le déclencheur onOpen(e) s'exécute automatiquement lorsqu'un utilisateur ouvre une feuille de calcul, un document, une présentation ou un formulaire qu'il est autorisé à modifier. (Le déclencheur ne s'exécute pas lorsque vous répondez à un formulaire, mais uniquement lorsque vous l'ouvrez pour le modifier.) onOpen(e) est le plus souvent utilisé pour ajouter des éléments de menu personnalisés à Google Sheets, Slides, Docs ou Forms.

/**
 * The event handler triggered when opening the spreadsheet.
 * @param {Event} e The onOpen event.
 * @see https://developers.google.com/apps-script/guides/triggers#onopene
 */
function onOpen(e) {
  // Add a custom menu to the spreadsheet.
  SpreadsheetApp.getUi() // Or DocumentApp, SlidesApp, or FormApp.
    .createMenu("Custom Menu")
    .addItem("First item", "menuItem1")
    .addToUi();
}

onInstall(e)

Le déclencheur onInstall(e) s'exécute automatiquement lorsqu'un utilisateur installe un module complémentaire de l'éditeur depuis Google Docs, Sheets, Slides ou Forms. Le déclencheur ne s'exécute pas lorsqu'un utilisateur installe le module complémentaire depuis le site Web Google Workspace Marketplace. L'utilisation la plus courante de onInstall(e) consiste à appeler onOpen(e) pour ajouter des menus personnalisés. Une fois qu'un module complémentaire est installé, le fichier est déjà ouvert. Par conséquent, onOpen(e) ne s'exécute pas seul, sauf si le fichier est rouvert. Notez que certaines restrictions s'appliquent à ce que onInstall(e) peut faire. En savoir plus sur l'autorisation.

/**
 * The event handler triggered when installing the add-on.
 * @param {Event} e The onInstall event.
 * @see https://developers.google.com/apps-script/guides/triggers#oninstalle
 */
function onInstall(e) {
  onOpen(e);
}

onEdit(e)

Le déclencheur onEdit(e) s'exécute automatiquement lorsqu'un utilisateur modifie la valeur d'une cellule dans une feuille de calcul. La plupart des onEdit(e) déclencheurs utilisent les informations de l' objet d'événement pour répondre de manière appropriée. Par exemple, la fonction onEdit(e) ci-dessous définit un commentaire sur la cellule qui enregistre la dernière fois qu'elle a été modifiée.

/**
 * The event handler triggered when editing the spreadsheet.
 * @param {Event} e The onEdit event.
 * @see https://developers.google.com/apps-script/guides/triggers#onedite
 */
function onEdit(e) {
  // Set a comment on the edited cell to indicate when it was changed.
  const range = e.range;
  range.setNote(`Last modified: ${new Date()}`);
}

Le déclencheur onEdit() ne met en file d'attente que deux événements de déclenchement au maximum.

onSelectionChange(e)

Le déclencheur onSelectionChange(e) s'exécute automatiquement lorsqu'un utilisateur modifie la sélection dans une feuille de calcul. Pour activer ce déclencheur, actualisez la feuille de calcul une fois le déclencheur ajouté et chaque fois qu'elle est ouverte.

Si la sélection se déplace entre plusieurs cellules en peu de temps, certains événements de modification de la sélection peuvent être ignorés pour réduire la latence. Par exemple, si de nombreuses modifications de la sélection sont effectuées à moins de deux secondes d'intervalle, seules la première et la dernière modification de la sélection activent le déclencheur onSelectionChange(e).

Dans l'exemple suivant, si une cellule vide est sélectionnée, la fonction onSelectionChange(e) définit l'arrière-plan de la cellule sur rouge.

/**
 * The event handler triggered when the selection changes in the spreadsheet.
 * @param {Event} e The onSelectionChange event.
 * @see https://developers.google.com/apps-script/guides/triggers#onselectionchangee
 */
function onSelectionChange(e) {
  // Set background to red if a single empty cell is selected.
  const range = e.range;
  if (
    range.getNumRows() === 1 &&
    range.getNumColumns() === 1 &&
    range.getCell(1, 1).getValue() === ""
  ) {
    range.setBackground("red");
  }
}

doGet(e) et doPost(e)

Le déclencheur doGet(e) s'exécute automatiquement lorsqu'un utilisateur consulte une application Web ou qu'un programme envoie une requête HTTP GET à une application Web. doPost(e) s'exécute lorsqu'un programme envoie une requête HTTP POST à une application Web. Ces déclencheurs sont présentés plus en détail dans les guides sur les applications Web, le service HTML, et le service Content. Notez que doGet(e) et doPost(e) ne sont pas soumis aux restrictions listées ci-dessus.

Types de déclencheurs disponibles

Si les restrictions sur les déclencheurs simples les empêchent de répondre à vos besoins, vous pouvez utiliser un déclencheur installable à la place. Le tableau ci-dessous récapitule les types de déclencheurs disponibles pour chaque type d'événement. Par exemple, Google Sheets, Slides, Forms et Docs sont tous compatibles avec les déclencheurs d'ouverture simples, mais seuls Sheets, Docs et Forms sont compatibles avec les déclencheurs d'ouverture installables.

Événement	Déclencheurs simples	Déclencheurs installables
Ouvrir	function onOpen(e)
Modifier	function onEdit(e)
Modification de la sélection	function onSelectionChange(e)
Installer	function onInstall(e)
Modifier
Envoi de formulaire
Déclenché par le temps (horloge)
Télécharger	function doGet(e)
Publier	function doPost(e)

* L'événement d'ouverture de Google Forms ne se produit pas lorsqu'un utilisateur ouvre un formulaire pour y répondre, mais lorsqu'un éditeur l'ouvre pour le modifier.