Déclencheurs des modules complémentaires Google Workspace

Les déclencheurs Apps Script déclenchent l'exécution d'une fonction de script spécifiée (la fonction 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 d'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éclenchement. La fonction déclencheur est une fonction de rappel que vous devez implémenter vous-même pour prendre les mesures 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 interface de fiche lorsque l'utilisateur ouvre un fil de discussion. Dans ce cas, vous mettez en œuvre une fonction de rappel contextuelle pour créer les fiches composant la nouvelle interface utilisateur à l'aide des données transmises dans l'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 du fichier manifeste

Contrairement aux modules complémentaires d'éditeur, les modules complémentaires Google Workspace ne peuvent pas utiliser de déclencheurs simples Apps Script à la place. Ils utilisent plutôt des déclencheurs spécialement conçus pour les modules complémentaires Google Workspace : les déclencheurs de manifeste.

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

  • Déclencheurs de la page d'accueil permettant de créer et d'afficher la page d'accueil du module complémentaire
  • Déclencheurs d'événement d'agenda qui affichent une nouvelle fiche ou effectuent d'autres actions lorsqu'un événement d'agenda est ouvert.
  • 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 d'agenda.
  • Déclencheurs "onItemsSelected" de Drive 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 Gmail qui affichent une fiche 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 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 d'éditeur 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 des déclencheurs de fichier manifeste, consultez le fichier manifeste.

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

Restrictions

Leur utilisation est soumise à certaines restrictions pour les déclencheurs du fichier manifeste.

  • Ces déclencheurs ne sont utilisés que dans les projets de modules complémentaires Google Workspace. Ils ne servent à aucune 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 Script d'Apps Script pour créer ou modifier ces déclencheurs.
  • Les déclencheurs contextuels Gmail ne peuvent actuellement contenir qu'un critère unconditional. Cela signifie que les déclencheurs contextuels se déclenchent pour chaque e-mail, quel que soit son contenu.