Les modules complémentaires Google Workspace peuvent fournir des interfaces personnalisées lorsque l'utilisateur consulte ou modifie des agendas et des événements Agenda. Vous pouvez ainsi fournir à l'utilisateur des informations supplémentaires pertinentes, automatiser des tâches et connecter des systèmes tiers à Google Agenda.
Lorsque vous créez une interface de module complémentaire pour Google Agenda, vous pouvez fournir une page d'accueil. Vous pouvez utiliser la même page d'accueil pour plusieurs hôtes ou en concevoir une spécifique pour Google Agenda.
Votre module complémentaire peut également définir une interface qui s'affiche lorsque l'utilisateur a un événement Agenda ouvert.
Accéder à l'UI du module complémentaire
Selon la manière dont il est ouvert, un module complémentaire Google Workspace peut définir une interface de page d'accueil, une interface d'événement Google Agenda, une interface de sélection d'une pièce jointe ou les trois :
- Si un utilisateur clique sur l'icône du module complémentaire dans une vue de calendrier, le module complémentaire exécute la fonction
calendar.homepageTriggercorrespondante (le cas échéant). Cette fonction crée et renvoie une fiche de page d'accueil dans Agenda pour l'afficher. Si aucune fonctioncalendar.homepageTriggern'est définie, une fiche de page d'accueil générique s'affiche à la place. - Si l'utilisateur ouvre un événement Agenda, puis clique sur l'icône du module complémentaire, ou si le module complémentaire est ouvert lorsque l'utilisateur ouvre un événement, le module complémentaire exécute la fonction
eventOpenTriggercorrespondante (le cas échéant). Cette fonction crée l'interface de l'événement Agenda du module complémentaire et revient à Google Agenda pour l'afficher. - Si le module complémentaire définit une fonction
eventAttachmentTrigger, il apparaît en tant que fournisseur d'attachement lorsque l'utilisateur clique sur Ajouter une pièce jointe lors de la modification d'un événement Agenda. Lorsque le module complémentaire est sélectionné, la fonctioneventAttachmentTriggercrée l'interface de sélection des pièces jointes du module complémentaire et la renvoie dans Google Agenda pour affichage.
Création de l'interface du module complémentaire Agenda
Pour étendre Google Agenda à l'aide d'un module complémentaire Google Workspace, procédez comme suit:
- Décidez si vous souhaitez que votre module complémentaire dispose d'une page d'accueil spécifique à Agenda. Indiquez également si vous souhaitez fournir une interface personnalisée lorsque l'utilisateur modifie des événements d'agenda.
- Ajoutez les champs
addOns.commonetaddOns.calendarappropriés au fichier manifeste du projet de script du module complémentaire, y compris les champs d'application requis. - Si vous fournissez une page d'accueil spécifique à Agenda, implémentez la fonction
calendar.homepageTriggerpour créer cette interface. Vous pouvez également choisir d'utiliser l'interfacecommon.homepageTriggerpour plusieurs hôtes Google Workspace. - Si vous fournissez une interface d'événement Agenda, vous devez implémenter une fonction
calendar.eventOpenTriggerpour créer cette interface. Pour en savoir plus, consultez Étendre l'interface des événements d'Agenda. - Implémentez les fonctions de rappel associées, nécessaires pour répondre aux interactions de l'UI de l'utilisateur, telles que les clics sur les boutons.
Pages d'accueil d'Agenda
Google Agenda permet d'afficher les pages d'accueil des modules complémentaires Google Workspace.
Pour afficher la page d'accueil commune de votre module complémentaire dans Google Agenda, il vous suffit de vous assurer qu'un champ addOns.calendar figure dans le fichier manifeste du module complémentaire.
Vous pouvez également ajouter un calendar.homepageTrigger au fichier manifeste du module complémentaire pour fournir une page d'accueil spécifique à Agenda.
Dans les deux cas, vous devez fournir le nom d'une fonction de déclencheur de page d'accueil dans le projet de script de votre module complémentaire. Cette fonction est appelée automatiquement pour créer la page d'accueil de Google Agenda lorsque cela est nécessaire. Vous devez implémenter cette fonction pour créer et renvoyer un seul Card ou un tableau d'objets Card qui constituent la page d'accueil. La fonction de déclencheur de la page d'accueil reçoit un objet d'événement en tant que paramètre contenant des informations générales telles que la plate-forme du client. Vous pouvez utiliser les données de l'objet d'événement pour adapter la création de la page d'accueil.
Étendre l'interface des événements Agenda
Google Agenda s'appuie sur un déclencheur contextuel pour déterminer l'interface à afficher (le cas échéant) lorsque l'utilisateur modifie un événement d'agenda. Lorsque le déclencheur se déclenche, il exécute la fonction de déclencheur contextuel spécifiée par le champ calendar.eventOpenTrigger dans le fichier manifeste du module complémentaire.
Vous devez implémenter la fonction nommée dans le champ calendar.eventOpenTrigger. Cette fonction accepte un objet d'événement comme argument et doit renvoyer un seul objet Card ou un tableau d'objets Card pour qu'Agenda l'affiche lorsque l'utilisateur a ouvert l'événement.
Objets d'événement
Un objet d'événement est créé et transmis à la fonction de déclencheur contextuel calendar.eventOpenTrigger lorsqu'un utilisateur ouvre un événement Agenda. La fonction de déclencheur peut utiliser les informations de cet objet d'événement pour déterminer comment créer des cartes de module complémentaire ou contrôler le comportement du module complémentaire. Des objets d'événement sont également créés et transmis aux fonctions homepageTrigger lorsqu'un module complémentaire est ouvert pour la première fois et lorsque l'utilisateur clique ou sélectionne des widgets interactifs.
La structure complète des objets d'événement est décrite dans la section Objets d'événement. Lorsque Agenda est l'application hôte du module complémentaire, les objets d'événement d'événement d'interaction avec le widget et au déclencheur contextuel incluent le champ Objet d'événement Agenda qui contient les informations client spécifiques à Agenda.
Mise à jour des événements d'agenda
En plus du calendar.eventOpenTrigger contextuel qui se déclenche lorsqu'un utilisateur ouvre un événement Agenda pour le modifier, vous pouvez également définir un calendar.eventUpdateTrigger qui se déclenche lorsque l'utilisateur met à jour et enregistre un événement Agenda. Ce déclencheur ne se déclenche que si l'utilisateur apporte une ou plusieurs des modifications suivantes :
- Ajoute un ou plusieurs participants.
- Supprime un ou plusieurs participants.
- Ajoute ou passe à une autre solution de conférence.
Lorsque ce déclencheur se déclenche, il exécute la fonction de déclencheur spécifiée par le champ de fichier manifeste calendar.eventUpdateTrigger. La fonction est exécutée avant l'enregistrement des modifications apportées à l'événement d'agenda.
calendar.eventUpdateTrigger est généralement utilisé pour effectuer l'une ou plusieurs des opérations suivantes :
- Mettre à jour l'interface de l'événement Agenda du module complémentaire en réponse aux modifications apportées par l'utilisateur à l'événement Agenda.
- Synchroniser les données des événements Agenda avec un système tiers, tel qu'un système de conférence connecté à Google Agenda.
Si vous avez besoin que votre module complémentaire apporte des modifications aux données d'un événement Agenda (telles que sa liste de participants), vous devez définir le champ de fichier manifeste calendar.currentEventAccess du module complémentaire sur WRITE ou READ_WRITE. Le module complémentaire doit également disposer du champ d'application https://www.googleapis.com/auth/calendar.addons.current.event.write.
Ajouter des solutions de conférence
Les solutions de visioconférence représentent des options de visioconférence tierces que les utilisateurs peuvent joindre aux événements Google Agenda. La documentation Présentation des conférences tierces explique comment créer un module complémentaire qui ajoute de nouvelles solutions de conférence. Il n'est pas nécessaire de créer une UI pour ce type d'extension. Les solutions ajoutées apparaissent simplement comme des options dans le menu déroulant de l'UI de l'événement Google Agenda.