Créer des interfaces Google Agenda

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

Google Workspace Les modules complémentaires peuvent fournir des interfaces personnalisées lorsque l'utilisateur consulte ou modifie des agendas et des événements d'agenda. Vous pouvez ainsi fournir à l'utilisateur des informations supplémentaires pertinentes, automatiser les tâches et connecter des systèmes tiers à Google Agenda.

Lorsque vous créez une interface 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 concevoir une page 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 d'agenda.

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

Selon son mode d'ouverture, un Google Workspace module complémentaire peut définir une interface de page d'accueil, une interface d'événement Agenda, une interface de sélection de pièces jointes ou les trois:

  • Si un utilisateur clique sur l'icône de module complémentaire dans une vue d'agenda, le module complémentaire exécute la fonction calendar.homepageTrigger correspondante (le cas échéant). Cette fonction génère et renvoie une fiche de page d'accueil dans Google Agenda. Si aucune fonction calendar.homepageTrigger n'est définie, une fiche générique s'affiche à la place.
  • Si l'utilisateur ouvre un événement d'agenda, puis clique sur l'icône du module complémentaire, ou que le module complémentaire est ouvert lorsqu'il ouvre un événement, le module complémentaire exécute la fonction eventOpenTrigger correspondante (le cas échéant). Cette fonction génère l'interface d'événement du module complémentaire et revient à Google Agenda pour l'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 fonction eventAttachmentTrigger crée l'interface de sélection des pièces jointes du module complémentaire et la renvoie à Google Agenda pour l'afficher.

Création de l'interface du module complémentaire Agenda

Vous pouvez ajouter un module complémentaireGoogle Workspace à Google Agenda en procédant comme suit:

  1. Déterminez si vous souhaitez que votre module complémentaire comporte une page d'accueil spécifique à Agenda. Décidez également si vous souhaitez fournir une interface personnalisée lorsque l'utilisateur modifie les événements d'agenda.
  2. Ajoutez les champs addOns.common et addOns.calendar appropriés au fichier manifeste du projet de script du module complémentaire, y compris les champs d'application requis.
  3. Si vous fournissez une page d'accueil spécifique à Agenda, implémentez la fonction calendar.homepageTrigger pour créer cette interface. Vous pouvez également choisir d'utiliser l'interface common.homepageTrigger pour plusieurs Google Workspace hôtes.
  4. Si vous fournissez une interface d'événement Agenda, vous devez implémenter une fonction calendar.eventOpenTrigger pour créer cette interface. Pour en savoir plus, consultez la section Extension de l'interface d'événement d'Agenda.
  5. Implémentez les fonctions de rappel associées nécessaires pour répondre aux interactions de l'interface utilisateur telles que les clics sur un bouton.

Page d'accueil de Google Agenda

Google Agenda permet d'afficher Google Workspace des pages d'accueil. Pour afficher la page d'accueil courante de votre module complémentaire dans Google Agenda, assurez-vous qu'il y a un champ addOns.calendar 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 indiquer le nom d'une fonction de déclenchement de la page d'accueil dans votre projet de script de module complémentaire. Cette fonction est automatiquement appelée pour créer la page d'accueil d'Agenda lorsqu'elle est nécessaire. Vous devez implémenter cette fonction pour créer et renvoyer un seul objet Card ou un tableau d'objets Card constituant la page d'accueil. La fonction du déclencheur de 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 d'objet d'événement pour personnaliser la construction de la page d'accueil.

Extension de l'interface des événements d'agenda

Google Agenda s'appuie sur un déclencheur contextuel pour déterminer l'interface (le cas échéant) à afficher lorsque l'utilisateur modifie un événement d'agenda. Lorsque le déclencheur est activé, il exécute la fonction de déclenchement 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 s'affiche tant que l'utilisateur a ouvert l'événement.

Objets d'événement

Un objet événement est créé et transmis à la fonction de déclenchement contextuel calendar.eventOpenTrigger lorsqu'un utilisateur ouvre un événement Agenda. La fonction du déclencheur peut utiliser les informations de cet objet d'événement pour déterminer comment créer des fiches complémentaires ou contrôler le comportement de ces modules. 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 Objets d'événement. Lorsque Agenda est l'application hôte hôte du module complémentaire, les objets d'événement de déclencheur contextuel et d'interaction widget incluent le champ Objet d'événement d'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 d'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 s'active que si l'utilisateur effectue une ou plusieurs des modifications suivantes:

  • Ajoute un ou plusieurs participants.
  • Supprime un ou plusieurs participants.
  • Ajoute ou change de solution de conférence.

Lorsque ce déclencheur est exécuté, il exécute la fonction de déclencheur spécifiée par le champ manifeste calendar.eventUpdateTrigger. La fonction est exécutée avant l'enregistrement de la modification d'événement Agenda.

L'outil calendar.eventUpdateTrigger permet généralement d'effectuer une ou plusieurs des actions suivantes:

  • En réponse aux modifications apportées par l'utilisateur à l'événement d'agenda, mettez à jour l'interface d'événement du module complémentaire.
  • Synchroniser les données d'événements 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 d'agenda (par exemple, la liste des participants), vous devez définir le champ manifeste calendar.currentEventAccess du module complémentaire sur WRITE ou READ_WRITE. Cela nécessite également que le module complémentaire dispose du champ d'application https://www.googleapis.com/auth/calendar.addons.current.event.write.

Ajouter des 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 permettant d'ajouter des 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.