Les déclencheurs Apps Script permettent d'exécuter une fonction de script spécifiée (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 est compatible avec 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 de la structure de l'objet d'événement sont organisées différemment en fonction du type de déclencheur.
Une fois l'objet d'é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 pour répondre à 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 nouvelle 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 fiches constituant la nouvelle UI à l'aide des données transmises dans l'objet d'événement.
Cette page fournit des instructions 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. À la place, ils utilisent 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:
- Déclencheurs de page d'accueil qui compilent et affichent la page d'accueil du module complémentaire.
- Déclencheurs d'ouverture d'événement Agenda qui affichent une nouvelle fiche ou effectuent d'autres actions lorsqu'un événement Agenda est ouvert.
- 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.
- 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.
- Déclencheurs de la fenêtre 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.
- Déclencheurs contextuels Gmail qui affichent une nouvelle fiche ou effectuent d'autres actions lorsque l'utilisateur ouvre un message Gmail.
- Déclencheurs Editor onFileScopeGranted qui affichent une nouvelle fiche lorsque les utilisateurs autorisent l'étendue OAuth
drive.filedans le document Editor actuel.
Dans la liste ci-dessus, seuls les déclencheurs de la page d'accueil ne sont pas contextuels. Les autres sont des déclencheurs contextuels. Pour en savoir plus sur les définitions de déclencheur de fichier manifeste, consultez la section Fichier 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 une autre application.
- É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
Scriptd'Apps Script pour créer ni modifier ces déclencheurs. - Les déclencheurs contextuels Gmail ne peuvent actuellement comporter qu'un seul critère
unconditional. Cela signifie que les déclencheurs contextuels se déclenchent pour chaque e-mail, quel que soit son contenu. - Chaque module complémentaire ne peut avoir qu'un seul déclencheur de chaque type, par utilisateur et par document.