Déclencheurs pour les modules complémentaires Google Workspace
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Les déclencheurs Apps Script permettent d'exécuter une fonction de script spécifique (la fonction de déclencheur) chaque fois qu'un événement spécifié se produit. Seuls certains événements peuvent déclencher des déclencheurs, et chaque application Google Workspace prend en charge un ensemble d'événements différent.
Lorsqu'un déclencheur se déclenche, un objet d'événement est créé. Cette structure JSON contient des informations sur l'événement qui s'est produit. Les informations contenues dans la structure de l'objet d'événement sont organisées différemment en fonction du type de déclencheur.
Une fois l'objet événement créé, Apps Script le transmet en tant que paramètre à la fonction de déclencheur. La fonction de déclencheur est une fonction de rappel que vous devez implémenter vous-même pour effectuer les actions appropriées en réponse à l'événement. Par exemple, dans un module complémentaire Google Workspace qui étend Gmail, vous pouvez définir un déclencheur qui crée une interface de carte lorsque l'utilisateur ouvre un fil de discussion. Dans ce cas, vous implémentez une fonction de rappel contextuelle pour créer les cartes qui composent la nouvelle UI à l'aide des données transmises dans l'objet d'événement.
Cette page fournit des consignes sur l'utilisation des déclencheurs dans les projets de modules complémentaires Google Workspace.
Déclencheurs de fichier manifeste
Contrairement aux modules complémentaires de l'éditeur, les modules complémentaires Google Workspace ne peuvent actuellement pas utiliser les déclencheurs simples Apps Script. Ils utilisent plutôt des déclencheurs conçus spécifiquement pour les modules complémentaires Google Workspace : les déclencheurs de fichier manifeste.
Les déclencheurs de fichier manifeste sont entièrement définis dans le fichier manifeste du module complémentaire Google Workspace. Voici quelques exemples de déclencheurs de fichier manifeste :
Les déclencheurs de page d'accueil qui créent et affichent la page d'accueil du module complémentaire.
Les déclencheurs d'ouverture d'événement Agenda affichent une nouvelle fiche ou effectuent d'autres actions lorsqu'un événement Agenda est ouvert.
Les déclencheurs eventUpdate d'Agenda qui affichent une nouvelle fiche ou effectuent d'autres actions lorsqu'un utilisateur modifie et enregistre un événement Agenda.
Les déclencheurs Drive onItemsSelected qui affichent une nouvelle fiche ou effectuent d'autres actions lorsqu'un utilisateur sélectionne un ou plusieurs fichiers ou dossiers dans Drive.
Les déclencheurs de rédaction Gmail qui affichent une fiche de module complémentaire lorsque l'utilisateur ouvre le module complémentaire dans la fenêtre de rédaction Gmail.
Les déclencheurs contextuels Gmail qui affichent une nouvelle fiche ou effectuent d'autres actions lorsque l'utilisateur ouvre un message Gmail.
Les déclencheurs Editor.onFileScopeGranted affichent une nouvelle fiche lorsque les utilisateurs accordent l'autorisation pour l'habilitation OAuth drive.file dans le document Editor actuel.
Dans la liste ci-dessus, seuls les déclencheurs de page d'accueil ne sont pas contextuels. Les autres sont des déclencheurs contextuels. Pour en savoir plus sur les définitions de déclencheurs de fichier manifeste, consultez Manifeste.
En plus des déclencheurs de fichier manifeste, les modules complémentaires Google Workspace peuvent également utiliser des déclencheurs installables Apps Script.
Restrictions
L'utilisation des déclencheurs de fichier manifeste est soumise à certaines restrictions.
Ces déclencheurs ne sont utilisés que dans les projets de modules complémentaires Google Workspace. Ils n'ont aucune utilité dans d'autres applications.
Étant donné qu'ils sont définis dans le fichier manifeste du module complémentaire et non dans son code, vous ne pouvez pas utiliser le service Apps Script Script pour créer ni modifier ces déclencheurs.
Les déclencheurs contextuels Gmail ne peuvent actuellement comporter qu'un critère unconditional.
Cela signifie que les déclencheurs contextuels se déclenchent pour chaque message électronique, quel que soit son contenu.
Chaque module complémentaire ne peut comporter qu'un seul déclencheur de chaque type, par utilisateur et par document.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/31 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/07/31 (UTC)."],[[["\u003cp\u003eApps Script triggers execute a specific function when a defined event occurs within a Google Workspace application.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Workspace add-ons utilize manifest triggers, defined in the add-on's manifest, to respond to events like opening a document or composing an email.\u003c/p\u003e\n"],["\u003cp\u003eManifest triggers can be contextual, reacting to specific user actions within a document or application, or non-contextual, like those that build the add-on's homepage.\u003c/p\u003e\n"],["\u003cp\u003eWhile manifest triggers offer event-driven functionality, they have limitations, including restrictions on their use and creation methods.\u003c/p\u003e\n"]]],["Apps Script triggers initiate a script function when specific events occur, creating an event object with event details. This object is then passed to a user-implemented trigger function, enabling actions based on the event. Google Workspace add-ons use manifest triggers, defined in the add-on's manifest, to trigger actions like displaying cards on homepage, when opening/updating Calendar events, selecting Drive items, or opening a message in Gmail. Contextual triggers and installable triggers are also supported but with some restrictions.\n"],null,["# Triggers for Google Workspace add-ons\n\n[Apps Script triggers](/apps-script/guides/triggers) cause a specified script\nfunction (the *trigger function*) to execute whenever a specified event\noccurs. Only certain events can cause triggers to fire, and each\nGoogle Workspace application supports a different set of events.\n\nWhen a trigger fires, an *event object* is created. This JSON structure\ncontains details about the event that occurred. The information in the event\nobject structure is organized differently based on the trigger type.\n\nOnce the event object is created, Apps Script passes it as a parameter to the\ntrigger function. The trigger function is a callback function that you must\nimplement yourself, to take whatever actions are appropriate to respond to the\nevent. For example, in a\nGoogle Workspace add-on that extends Gmail, you can\ndefine a trigger that creates a new card interface when the user opens a message\nthread. In this case, you implement a contextual callback function to create\nthe cards making up the new UI using the data passed in the\n[event object](/workspace/add-ons/concepts/event-objects).\n\nThis page provides guidelines on using triggers in\nGoogle Workspace\nadd-on projects.\n\nManifest triggers\n-----------------\n\nUnlike Editor add-ons, Google Workspace add-ons\ncurrently can't use Apps Script [simple triggers](/apps-script/guides/triggers)\nInstead, they use triggers designed specifically for\nGoogle Workspace add-ons: *manifest triggers*.\n\nManifest triggers are defined completely in the\nGoogle Workspace add-on's\n[manifest](/workspace/add-ons/concepts/workspace-manifests). Examples of manifest triggers include the\nfollowing:\n\n- **Homepage triggers** that build and display the add-on homepage.\n- **Calendar eventOpen triggers** that display a new card or take other actions when a Calendar event is opened.\n- **Calendar eventUpdate triggers** that display a new card or take other actions when a user edits and saves a Calendar event.\n- **Drive onItemsSelected triggers** that display a new card or take other actions when a user selects one or more files or folders in Drive.\n- **Gmail compose triggers** that display an add-on card when the user opens the add-on in the Gmail compose window.\n- **Gmail contextual triggers** that display a new card or take other actions when the user opens a Gmail message.\n- **Editor onFileScopeGranted triggers** that display a new card when users grant authorization for the `drive.file` OAuth scope in the current Editor document.\n\nIn the above list, only homepage triggers are non-contextual; the rest are\ncontextual triggers. See [Manifest](/workspace/add-ons/concepts/workspace-manifests)\nfor more information about manifest trigger definitions.\n\nIn addition to manifest triggers, Google Workspace\nadd-ons can also use Apps Script\n[installable triggers](/apps-script/guides/triggers/installable).\n\n### Restrictions\n\nManifest triggers have certain restrictions to their use.\n\n- These triggers are only used in Google Workspace add-on projects; they have no purpose in any other application.\n- Since they are defined in the add-on manifest and not in its code, you can't use the Apps Script [`Script`](/apps-script/reference/script) service to create or modify these triggers.\n- Gmail contextual triggers currently can only have an `unconditional` criteria. This means contextual triggers fire for every email message, regardless of content.\n- Each add-on can only have one trigger of each type, per user, per document."]]
