Les modules complémentaires Google Workspace offrent interfaces lorsque l'utilisateur affiche ou modifie des agendas et des événements d'agenda. Cela vous permet de fournir à l'utilisateur des informations supplémentaires pertinentes, des tâches et connecter des systèmes tiers à Google Agenda.
Lorsque vous créez l'interface d'un module complémentaire pour Google Agenda, vous pouvez fournir page d'accueil. Vous pouvez utiliser la même page d'accueil pour plusieurs hôtes, ou créez-en une spécifique pour Google Agenda.
Votre module complémentaire peut également définir une interface qui s'affiche lorsque l'utilisateur a ouvrir un événement d'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 la vue de l'agenda, le module complémentaire s'exécute
la
calendar.homepageTriggercorrespondante (si présente). Cette fonction crée et renvoie une fiche de page d'accueil à Agenda pour les afficher. Si noncalendar.homepageTriggerest 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
le module complémentaire est ouvert lorsque l'utilisateur ouvre un événement, le module complémentaire
exécute le pipeline
eventOpenTrigger(si présente). Cette fonction permet de créer l'événement Agenda du module complémentaire interface et retourne à Google Agenda pour affichage. - Si le module complémentaire définit une fonction
eventAttachmentTrigger, le module complémentaire apparaît comme 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. Une fois le module complémentaire sélectionné, La fonctioneventAttachmentTriggercrée la pièce jointe du module complémentaire. interface de sélection et la renvoie à Google Agenda pour affichage.
Création de l'interface du module complémentaire Agenda
Vous pouvez ajouter une extension en procédant comme suit:
- Déterminez si votre module complémentaire doit être associé à une version d'Agenda page d'accueil. Indiquez également si vous souhaitez fournir une interface personnalisée lorsque l'utilisateur modifier des événements d'agenda.
- Ajoutez les composants
addOns.commonetaddOns.calendardans le fichier manifeste du projet du script complémentaire. y compris les champs d'application requis. - Si vous fournissez une URL spécifique à Agenda
page d'accueil,
implémenter
calendar.homepageTriggerpour créer cette interface. Vous pouvez également choisir d'utilisercommon.homepageTriggerpour plusieurs hôtes Google Workspace. - Si vous fournissez une interface d'événement d'agenda, vous devez mettre en œuvre une
calendar.eventOpenTriggerpour créer cette interface. Voir Extension de l'interface des événements d'Agenda pour en savoir plus. - Implémentez les fonctions de rappel associées pour répondre aux demandes de l'utilisateur Les interactions avec l'interface 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 habituelle de votre module complémentaire dans Google Agenda, assurez-vous simplement
est un(e) addOns.calendar
dans le fichier manifeste du module complémentaire.
Vous pouvez également ajouter
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éclencheur de la page d'accueil dans votre
le projet de script du module complémentaire. Cette fonction est automatiquement appelée pour créer
page d'accueil de Google Agenda si nécessaire. Vous devez implémenter cette fonction pour créer
et renvoie un seul
Card ou un tableau de
Card
les objets qui constituent
la page d'accueil. La fonction de déclencheur de la page d'accueil reçoit une
Objet événement
sous la forme d'un paramètre contenant des informations générales, telles que
Google Cloud. Vous pouvez utiliser les données de l'objet d'événement pour personnaliser la construction de
page d'accueil.
Extension de l'interface des événements Agenda
Google Agenda s'appuie sur un déclencheur contextuel pour déterminer quelle interface
(le cas échéant) à afficher 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
calendar.eventOpenTrigger
dans le fichier manifeste du module complémentaire.
Vous devez implémenter la fonction nommée dans
calendar.eventOpenTrigger
. Cette fonction accepte un objet événement en tant que
et doit renvoyer soit un seul
un objet Card ou un tableau de
des objets Card pour Agenda
lorsque l'événement est ouvert.
Objets "Événement"
Un objet événement est créé.
transmis à
calendar.eventOpenTrigger
un déclencheur contextuel lorsqu'un utilisateur ouvre
un événement d'agenda. La fonction de déclencheur peut utiliser les informations de cet événement
pour déterminer comment créer des fiches de modules complémentaires ou comment les contrôler
comportemental. Les objets "Événement" sont également créés et transmis
homepageTrigger
fonctionne 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 "Événement" : Si Agenda est l'application hôte du module complémentaire, le déclencheur contextuel Les objets d'événement d'interaction avec un widget incluent Objet événement d'agenda qui contient des informations sur le client spécifiques à Agenda.
Mise à jour des événements d'agenda
En plus de l'analyse contextuelle
calendar.eventOpenTrigger
qui se déclenche lorsqu'un utilisateur ouvre
d'un événement d'agenda pour le modifier, vous pouvez également définir
calendar.eventUpdateTrigger
qui se déclenche lorsque l'utilisateur effectue la mise à jour et l'enregistrement d'un événement d'agenda. Ce déclencheur uniquement
se déclenche 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 de déclenchement spécifiée par
calendar.eventUpdateTrigger
manifeste. La fonction est exécutée avant que la modification de l'événement d'agenda ne soit
enregistré.
calendar.eventUpdateTrigger
est généralement utilisé pour:
- Mettre à jour l'interface des événements d'agenda du module complémentaire en fonction des modifications apportées aux utilisateurs à l'événement d'agenda.
- Synchroniser les données d'événement d'Agenda avec un système tiers, par exemple une conférence qui est connecté à Google Agenda.
Si vous souhaitez que votre module complémentaire modifie les données d'un événement d'agenda (par exemple,
comme liste de participants), vous devez le configurer
calendar.currentEventAccess
le champ "manifest" sur WRITE ou READ_WRITE. Cette opération
nécessite que le module complémentaire dispose
https://www.googleapis.com/auth/calendar.addons.current.event.write
champ d'application.
Ajout de solutions de conférence
Solutions de conférence représentent des options de conférence tierces auxquelles les utilisateurs peuvent joindre des événements Google Agenda. La Présentation des conférences tierces vous explique comment créer un module complémentaire qui ajoute et de conférence. Il n'est pas nécessaire de créer une UI pour ce type de extension; les solutions ajoutées apparaissent simplement comme options dans le menu déroulant l'interface utilisateur des événements Google Agenda.