Déclencheurs pour les 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éclenchement) 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 é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 é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éclenchement. La fonction de déclenchement 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 interface utilisateur à l'aide des données transmises dans le objet é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 pas utiliser les déclencheurs simples de 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 manifeste. Voici quelques exemples :

  • Déclencheurs de page d'accueil qui créent et affichent la page d'accueil du module complémentaire.
  • Déclencheurs Google Agenda eventOpen qui affichent une nouvelle carte ou effectuent d'autres actions lorsqu'un événement est ouvert.
  • Déclencheurs Agenda eventUpdate qui affichent une nouvelle carte ou effectuent d'autres actions lorsqu'un utilisateur modifie et enregistre un événement.
  • Déclencheurs Google Drive onItemsSelected qui affichent une nouvelle carte ou effectuent d'autres actions lorsqu'un utilisateur sélectionne des fichiers ou des dossiers.
  • Déclencheurs de rédaction Gmail qui affichent une carte 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 carte ou effectuent d'autres actions lorsque l'utilisateur ouvre un message.
  • Déclencheurs de l'éditeur onFileScopeGranted qui affichent une nouvelle carte 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 ne sont pas contextuels. Les autres le sont. Pour en savoir plus sur les définitions des déclencheurs de fichier manifeste, consultez Fichier manifeste pour plus d'informations.

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 ou 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.