Les modules complémentaires Google Workspace peuvent fournir des interfaces personnalisées lorsque l'utilisateur affiche ou modifie des agendas et des événements Agenda. Cela vous permet de fournir à l'utilisateur des informations supplémentaires pertinentes, d'automatiser des tâches et de connecter des systèmes tiers à Google Agenda.
Lorsque vous créez l'interface d'un 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 ouvert un événement Agenda.
Accéder à l'interface utilisateur du module complémentaire
Selon le mode d'ouverture, 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 de pièces jointes ou les trois:
- Si un utilisateur clique sur l'icône du module complémentaire dans une vue de l'agenda, le module complémentaire exécute la fonction
calendar.homepageTriggercorrespondante (le cas échéant). Cette fonction crée une fiche de page d'accueil et l'affiche dans Agenda. Si aucune fonctioncalendar.homepageTriggern'est définie, une fiche générique de la page d'accueil 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 des événements Agenda du module complémentaire et retourne dans Google Agenda pour affichage. - Si le module complémentaire définit une fonction
eventAttachmentTrigger, il apparaît en tant que fournisseur de pièces jointes lorsque l'utilisateur clique sur Ajouter une pièce jointe lors de la modification d'un événement d'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éterminez si vous souhaitez que votre module complémentaire ait 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 du script 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 la créer. 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.
Page d'accueil de Google 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, assurez-vous simplement qu'il existe un champ addOns.calendar dans le fichier manifeste du module.
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 la page d'accueil dans le projet de script du module complémentaire. Cette fonction est appelée automatiquement pour créer la page d'accueil de Google Agenda si nécessaire. Vous devez implémenter cette fonction pour créer et renvoyer un seul objet 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 é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 d'objet d'événement pour personnaliser la construction de la page d'accueil.
Extension de 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 est exécuté, il exécute la fonction de déclencheur contextuel spécifiée par le champ calendar.eventOpenTrigger du 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 en tant qu'argument et doit renvoyer un seul objet Card ou un tableau d'objets Card pour que Agenda puisse l'afficher lorsque l'événement est ouvert.
Objets "Événement"
Un objet événement est créé et transmis à la fonction de déclencheur contextuel calendar.eventOpenTrigger lorsqu'un utilisateur ouvre un événement d'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. Les 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 sur la page 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 d'agenda. Ce déclencheur ne se déclenche que si l'utilisateur effectue une ou plusieurs des modifications suivantes:
- Ajoute un ou plusieurs participants.
- Supprime un ou plusieurs participants.
- Ajoute une solution de conférence ou passe à une autre.
Lorsque ce déclencheur est exécuté, il exécute la fonction spécifiée dans le champ calendar.eventUpdateTrigger du fichier manifeste. 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 une ou plusieurs des opérations suivantes:
- Mettez à jour l'interface des événements d'agenda du module complémentaire en réponse aux modifications apportées par les utilisateurs à l'événement Agenda.
- Synchronisez les données d'événement d'Agenda avec un système tiers, tel qu'un système de conférence connecté à Google Agenda.
Si vous souhaitez que votre module complémentaire modifie les données d'un événement Agenda (par exemple, sa liste de participants), vous devez définir le champ 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.
Ajout de solutions de conférence
Les solutions de conférence représentent des options de conférence tierces que les utilisateurs peuvent joindre à des é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 interface utilisateur pour ce type d'extension. Les solutions ajoutées apparaissent simplement comme options dans le menu déroulant de l'interface utilisateur des événements Google Agenda.