Déclencheurs des modules complémentaires Google Workspace

Les déclencheurs Apps Script entraînent l'exécution d'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 accepte un ensemble d'événements différent.

Lorsqu'un déclencheur est exécuté, un objet d'événement est créé. Cette structure JSON contient des détails sur l'événement qui s'est produit. Les informations de la structure de l'objet é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éclenchement 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 fiche 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 constituent la nouvelle interface utilisateur à l'aide des données transmises dans l'objet d'événement.

Cette page fournit des consignes sur l'utilisation de déclencheurs dans les projets de modules complémentaires Google Workspace.

Déclencheurs du fichier manifeste

Contrairement aux modules complémentaires des éditeurs, les modules complémentaires Google Workspace ne peuvent actuellement pas utiliser les déclencheurs simples Apps Script, mais ils utilisent des déclencheurs conçus spécialement pour les modules complémentaires Google Workspace: les déclencheurs du fichier manifeste.

Les déclencheurs du fichier manifeste sont entièrement définis dans le fichier manifeste du module complémentaire Google Workspace. Voici quelques exemples de déclencheurs de fichiers manifestes:

  • Les déclencheurs de page d'accueil qui créent et affichent la page d'accueil du module complémentaire.
  • Les déclencheurs "Calendar eventOpen" qui affichent une nouvelle carte ou effectuent d'autres actions lorsqu'un événement Agenda est ouvert.
  • Déclencheurs Calendar eventUpdate qui affiche une nouvelle carte ou effectue d'autres actions lorsqu'un utilisateur modifie et enregistre un événement d'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.
  • Déclencheurs de rédaction de Gmail qui affichent une fiche de module complémentaire lorsque l'utilisateur ouvre le module complémentaire dans la fenêtre de rédaction de Gmail.
  • Les déclencheurs contextuels de Gmail qui affichent une nouvelle carte ou effectuent d'autres actions lorsque l'utilisateur ouvre un message Gmail.
  • Les déclencheurs onFileScopeGranted de l'éditeur, qui affichent une nouvelle fiche lorsque les utilisateurs accordent une autorisation pour le champ d'application OAuth drive.file dans le document Editor actuel.

Dans la liste ci-dessus, seuls les déclencheurs de la page d'accueil sont non contextuels. Les autres sont des déclencheurs contextuels. Pour en savoir plus sur les définitions des déclencheurs du fichier manifeste, consultez la section Fichier manifeste.

Outre les déclencheurs de fichiers manifestes, les modules complémentaires Google Workspace peuvent également utiliser des déclencheurs installables Apps Script.

Restrictions

L'utilisation des déclencheurs du 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 Apps Script Script pour créer ou modifier ces déclencheurs.
  • Pour le moment, les déclencheurs contextuels de Gmail ne peuvent avoir qu'un critère unconditional. Cela signifie que des déclencheurs contextuels se déclenchent pour chaque e-mail, quel que soit son contenu.
  • Chaque module complémentaire ne peut être associé qu'à un seul déclencheur de chaque type, par utilisateur et par document.