Étendre l'interface utilisateur de rédaction avec des actions de rédaction

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

En plus de fournir une interface basée sur une carte lorsqu'un utilisateur lit un message Gmail, Google Workspace les modules complémentaires qui étendent Gmail peuvent fournir une autre interface lorsque l'utilisateur rédige de nouveaux messages ou répond à des messages existants. Cela permet Google Workspace d'automatiser la tâche de rédaction des e-mails à l'utilisateur.

Accéder à l'interface utilisateur du module complémentaire Compose

Il existe deux façons d'afficher l'interface utilisateur de rédaction d'un module complémentaire. La première consiste à rédiger un nouveau brouillon ou une nouvelle réponse alors que le module complémentaire est déjà ouvert. La seconde consiste à démarrer le module complémentaire lors de la rédaction d'un brouillon.

Dans les deux cas, le module complémentaire exécute la fonction de déclenchement de nouveau message correspondante, définie dans le fichier manifeste du module complémentaire. Le déclencheur de rédaction crée l'UI de rédaction de cette action, que Gmail affiche ensuite à l'utilisateur.

Créer un module complémentaire Compose

Pour ajouter une fonctionnalité de rédaction à un module complémentaire, procédez comme suit:

  1. Ajoutez le champ gmail.composeTrigger au fichier manifeste du projet de script du module complémentaire, puis mettez à jour les champs d'application du fichier manifeste pour inclure ceux requis pour les actions de rédaction.
  2. Implémentez une fonction de déclencheur de rédaction qui crée une interface utilisateur de Compose lorsque le déclencheur est exécuté. Les fonctions de déclenchement de Compose renvoient un seul objet Card ou un tableau d'objets Card comprenant l'UI de Compose pour l'action de composition.
  3. Implémentez les fonctions de rappel associées nécessaires pour réagir aux interactions de l'utilisateur dans l'interface utilisateur. Il ne s'agit pas de l'action de rédaction proprement dite (qui entraîne uniquement l'affichage de l'interface utilisateur de rédaction). Au contraire, ce sont les fonctions individuelles qui régissent ce qui se passe lorsque différents éléments de l'interface utilisateur de composition sont sélectionnés. Par exemple, une carte d'interface utilisateur contenant un bouton est généralement associée à une fonction de rappel qui s'exécute lorsqu'un utilisateur clique dessus. La fonction de rappel des widgets qui mettent à jour le contenu du brouillon de message doit renvoyer un objet UpdateDraftActionResponse.

Fonction de déclencheur "Nouveau message"

L'interface utilisateur de rédaction d'un module complémentaire est conçue de la même manière que l'interface des messages de ce module, en utilisant le service Card d'Apps Script pour créer des fiches et les remplir avec des widgets.

Vous devez implémenter le gmail.composeTrigger.selectActions[].runFunction que vous définissez dans votre fichier manifeste. La fonction de déclenchement de la composition doit renvoyer un seul objet Card ou un tableau d'objets Card comprenant l'interface utilisateur de rédaction pour cette action. Ces fonctions sont très semblables aux fonctions de déclenchement contextuel et doivent créer des fiches de la même manière.

Rédiger des objets d'événement de déclencheur

Lorsqu'une action Compose est sélectionnée, elle exécute la fonction de déclenchement correspondante et lui transmet un objet d'événement en tant que paramètre. L'objet événement peut contenir des informations sur le contexte du module complémentaire et le brouillon en cours de rédaction dans la fonction de déclenchement.

Consultez la page Structure des objets d'événement pour savoir comment les informations sont organisées dans l'objet d'événement. Les informations contenues dans l'objet événement sont partiellement contrôlées par la valeur du champ de manifeste gmail.composeTrigger.draftAccess:

  • Si le champ de manifeste gmail.composeTrigger.draftAccess est NONE ou n'est pas inclus, l'objet événement ne contient que très peu d'informations.

  • Si gmail.composeTrigger.draftAccess est défini sur METADATA, l'objet d'événement transmis à la fonction de déclenchement de la composition est renseigné avec les listes des destinataires de l'e-mail en cours de composition.