Déclencheurs pour les modules complémentaires Google Workspace

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 actions, 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 é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 des éditeurs, les modules complémentaires Google Workspace ne peuvent pas utiliser les déclencheurs simples Google 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 définis dans le fichier manifeste du module complémentaire Google Workspace. Voici quelques exemples :

  • 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 Google Agenda affichent une nouvelle fiche ou effectuent d'autres actions lorsqu'un événement est ouvert.
  • Les déclencheurs de mise à jour d'événements d'agenda qui affichent une nouvelle fiche ou effectuent d'autres actions lorsqu'un utilisateur modifie et enregistre un événement.
  • Google Drive onItemsSelected triggers qui affichent une nouvelle fiche ou effectuent d'autres actions lorsqu'un utilisateur sélectionne des fichiers ou des dossiers.
  • 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.
  • Déclencheurs contextuels Gmail qui affichent une nouvelle fiche ou effectuent d'autres actions lorsque l'utilisateur ouvre un message.
  • Les déclencheurs Editor.onFileScopeGranted affichent une nouvelle fiche lorsque les utilisateurs accordent l'autorisation pour l'habilitation OAuth drive.file dans le document.

Dans la liste, seuls les déclencheurs de page d'accueil sont non contextuels. Les autres sont 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 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.
  • Étant donné qu'ils sont définis dans le fichier manifeste du module complémentaire et non dans le code, vous ne pouvez pas utiliser le service Apps Script Script pour les créer ni les modifier.
  • Les déclencheurs contextuels Gmail se déclenchent pour chaque e-mail, 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.