- Impression
Connecteur Google Calendar
Intégration de Tulip avec Google Calendar
Introduction
L'API Google Calendar permet aux utilisateurs de créer, lire et modifier les événements de Google Calendar avec les bons accès à leurs comptes Google. Le but de ce connecteur est d'utiliser l'authentification OAuth et d'intégrer l'API Google Calendar V3 avec Tulip en utilisant des connecteurs HTTP et de fournir à nos clients un connecteur prêt à l'emploi qui peut être importé dans leur instance.
Objectif
Ce document met en évidence différentes fonctions de connecteur HTTP qui peuvent être construites en faisant des appels HTTP aux points d'extrémité de l'API Google Calendar V3 pour interagir avec Google Calendar et essayer diverses actions de lecture et d'écriture sur le calendrier qui pourraient être exploitées pour divers cas d'utilisation.
Document API
Pré-requis
- Créer un compte sur la console cloud de Google et configurer les informations d'identification OAuth 2.0. Vous trouverez plus d'informations dans la documentation API de Google.
- Activer l'API Google Agenda dans la console API de Google.
Détails de la connexion Tulip
Les informations suivantes doivent être configurées sur les connecteurs de Tulip.
- Exécuté sur : Cloud Connector Host
- Hôte: www.googleapis.com
- Port:443
- TLS : Oui
- Authentification du connecteur : OAuth2.0 (Admin/Operator)
- Voici les champs d'application à transmettre :
- https://www.googleapis.com/auth/calendar
- https://www.googleapis.com/auth/calendar.events
Fonctions du connecteur
Obtenir tous les calendriers
Objectif
Ce connecteur permet de récupérer tous les calendriers existant dans le calendrier Google d'un utilisateur.
Point d'arrivée
Appel HTTP GET au point de terminaison https://www.googleapis.com:443/calendar/v3/users/me/calendarList
Données requises
Aucune entrée requise
Sortie requise Extracteur
- Calendar Id : Identifiant unique du calendrier qui sera utilisé pour effectuer les autres tâches.
- Titre : Titre du calendrier
- Les paramètres supplémentaires renvoyés avec la réponse peuvent être inclus dans les paramètres de sortie.
Obtenir tous les événements
Objectif
Ce connecteur permet de récupérer tous les événements d'un calendrier spécifique.
Point de terminaison
Appel HTTP GET au point de terminaison -https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events
Données requises
Les paramètres URL à transmettre sont les suivants
- ID du calendrier - Id du calendrier/ transmettre "primary" comme valeur dans le paramètre ID du calendrier. En spécifiant "Primary", on obtient tous les événements du calendrier principal de l'utilisateur.
Extracteur de sortie requis
- Calendar Id : Identifiant unique du calendrier qui sera utilisé pour effectuer les autres tâches.
- ID de l'événement : Identifiant unique de l'événement qui sera utilisé pour extraire les détails d'un événement spécifique.
- Title (Titre) : Titre de l'événement
- Des paramètres supplémentaires renvoyés avec la réponse peuvent être inclus dans les paramètres de sortie.
Obtenir des événements par filtre
Objectif
Ce connecteur permet d'obtenir tous les événements qui se situent dans la plage de dates spécifiée dans les paramètres de la requête.
Point d'arrivée
Appel HTTP GET au point de terminaison -https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events?maxResults={MaxResults}&orderBy=updated&timeMax={MaxTime}&timeMin={MinTime}&singleEvents=true
Données requises
Les paramètres URL à transmettre sont les suivants
- ID du calendrier : ID du calendrier
- MaxResults : Nombre d'enregistrements à récupérer
- MinTime : Date de début des événements à récupérer
- MaxTime : Date de fin Heure des événements à extraire
Extracteur de sortie requis
- Calendar Id : Identifiant unique du calendrier qui sera utilisé pour effectuer les autres tâches.
- ID de l'événement : Identifiant unique de l'événement qui sera utilisé pour effectuer les autres tâches
- Title (Titre) : Titre de l'événement
- Les paramètres supplémentaires renvoyés avec la réponse peuvent être inclus dans les paramètres de sortie.
Créer un nouvel événement pour un utilisateur unique, un groupe ou plusieurs utilisateurs
Objectif
- Les utilisateurs peuvent fournir un titre d'événement, une description, une date de début et une date de fin en entrée et Tulip créera un nouvel événement avec le titre de l'événement fourni. La réponse de l'API sera les métadonnées et les diverses propriétés du fichier.
- Les informations extraites de l'API Google Calendar V3 peuvent ensuite être utilisées soit dans les applications Tulip, soit dans les tables Tulip, soit dans les variables Tulip qui seront acheminées vers d'autres fonctions du connecteur.
Point d'arrivée
Appel HTTP POST au point de terminaison https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events
Données requises
Les paramètres suivants sont envoyés dans le corps de la requête
- Calendar ID - ID du calendrier sélectionné
- Event Title - Titre de l'événement
- Start Date Time - Heure de début de l'événement
- Date de fin Heure - Date de fin de l'événement Heure
- Time Zone - Fuseau horaire de l'événement
- Participants - Participants à l'événement
- Lieu - Lieu de l'événement
- Description - Description de l'événement
Extracteur de sortie requis
- ID de l'événement : Identifiant unique de l'événement qui sera utilisé pour exécuter les autres tâches.
- Event Title (Titre de l'événement) : Titre de l'événement
- Organisateur : Nom de l'organisateur de l'événement
- Les paramètres supplémentaires renvoyés avec la réponse peuvent être inclus dans les paramètres de sortie.
Créer un nouvel événement récurrent pour un utilisateur unique, un groupe ou plusieurs utilisateurs
Objectif
- Les utilisateurs peuvent transmettre un titre d'événement, une description, une date de début, une date de fin, une date de fin de récurrence, un type de récurrence et d'autres paramètres en entrée et Tulip créera un nouvel événement avec le titre de l'événement fourni. La réponse de l'API sera les métadonnées et les diverses propriétés du fichier.
- Les informations extraites de l'API Google Calendar V3 peuvent ensuite être utilisées soit dans les applications Tulip, soit dans les tables Tulip, soit dans les variables Tulip qui seront acheminées vers d'autres fonctions du connecteur.
Point d'arrivée
Appel HTTP POST au point de terminaison https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events
Données requises
Les paramètres suivants sont envoyés dans le corps de la requête
- Calendar ID - ID du calendrier sélectionné
- Event Title - Titre de l'événement
- Start Date Time - Heure de début de l'événement
- Date de fin Heure - Date de fin de l'événement Heure
- Time Zone - Fuseau horaire de l'événement
- Participants - Participants à l'événement
- Description - Description de l'événement
- Lieu - Lieu de l'événement
- Règle de récurrence - La règle de récurrence contient tous les détails sur la manière et le moment où l'événement doit se reproduire. Vous trouverez ci-dessous la liste des quelques règles de récurrence ajoutées dans l'application (voir le document [RFC5545](https://tools.ietf.org/html/rfc5545
section-3.8.5) pour les règles de récurrence détaillées) :
Tous les jours pour occurrences :
RRULE:FREQ=DAILY;COUNT=
Ex : RRULE:FREQ=DAILY;COUNT=5
L'événement se produit pendant 5 jours à partir de la date de début de l'événement pour la même heure de début et de fin.
Tous les jours jusqu'à :
RRULE:FREQ=DAILY;UNTIL=
Ex: RRULE:FREQ=DAILY;UNTIL=20210924T000000Z
L'événement se produit quotidiennement jusqu'au "24 septembre 2021" à partir de la date de début de l'événement pour la même heure de début et de fin.
Hebdomadaire pour occurrences :
RRULE:FREQ=WEEKLY;COUNT=
Ex : RRULE:FREQ=WEEKLY;COUNT=3
L'événement se produit chaque semaine pendant 3 semaines, le même jour de la semaine que la date de début de l'événement, à la même heure de début et à la même heure de fin.
Hebdomadaire jusqu'à :
RRULE:FREQ=WEEKLY;UNTIL=
Ex: RRULE:FREQ=WEEKLY;UNTIL=20210924T000000Z
L'événement se produit Toutes les semaines jusqu'au "24 septembre 2021" pour le même jour de la semaine de la date de début de l'événement et pour la même heure de début et de fin.
Tous les mardis, tous les deux mois :(this)
RRULE:FREQ=MONTHLY;INTERVAL=;BYDAY=
Ex : RRULE:FREQ=MONTHLY;INTERVAL=2;BYDAY=TU
L'événement a lieu le mardi de chaque mois, à la même heure de début et de fin.
Extracteur de sortie requis
- Event Id : Identifiant unique de l'événement qui sera utilisé pour exécuter les autres tâches.
- Event Title (Titre de l'événement) : Titre de l'événement
- Organisateur : Nom de l'organisateur de l'événement
- Des paramètres supplémentaires renvoyés avec la réponse peuvent être inclus dans les paramètres de sortie.
Mise à jour des métadonnées d'un événement
Objectif
- Les utilisateurs peuvent transmettre un titre d'événement, une description, une date de début, une date de fin et d'autres paramètres en entrée et Tulip mettra à jour un événement existant avec les entrées fournies. La réponse de l'API sera les métadonnées et les diverses propriétés du fichier.
- Les informations extraites de l'API Google Calendar V3 peuvent ensuite être utilisées soit dans les applications Tulip, soit dans les tables Tulip, soit dans les variables Tulip qui seront acheminées vers d'autres fonctions du connecteur.
Point final
Appel HTTP PATCH au point de terminaison https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events/{EventID}?sendUpdates=all&fields=*
Données requises
Les paramètres suivants sont envoyés dans le corps de la requête
- Calendar ID - ID du calendrier sélectionné
- ID de l'événement - ID de l'événement sélectionné
- Event Title - Titre de l'événement
- Start Date Time - Heure de début de l'événement
- Date de fin Heure - Date de fin de l'événement Heure
- Time Zone - Fuseau horaire de l'événement
- Emplacement - Emplacement de l'événement
- Description - Description de l'événement
Extracteur de sortie requis
- ID de l'événement : Identifiant unique de l'événement qui sera utilisé pour exécuter les autres tâches
- Event Title (Titre de l'événement) : Titre de l'événement
- Description de l'événement : Titre de l'événement
- Des paramètres supplémentaires renvoyés avec la réponse peuvent être inclus dans les paramètres de sortie.
Mise à jour d'un événement récurrent
Objectif
- Les utilisateurs peuvent transmettre un titre d'événement, une description, une date de début, une date de fin, une règle de récurrence et d'autres paramètres en tant qu'entrée et Tulip mettra à jour un événement existant avec les entrées fournies. La réponse de l'API sera les métadonnées et les diverses propriétés du fichier.
- Les informations extraites de l'API Google Calendar V3 peuvent ensuite être utilisées soit dans les applications Tulip, soit dans les tables Tulip, soit dans les variables Tulip qui seront acheminées vers d'autres fonctions du connecteur.
Point final
Appel HTTP PATCH au point de terminaison https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events/{EventID}?sendUpdates=all&fields=*
Données requises
Les paramètres suivants sont envoyés dans le corps de la requête
- Calendar ID - ID du calendrier sélectionné
- ID de l'événement - ID de l'événement sélectionné
- Event Title - Titre de l'événement
- Start Date Time - Heure de début de l'événement
- Date de fin Heure - Date de fin de l'événement Heure
- Time Zone - Fuseau horaire de l'événement
- Emplacement - Emplacement de l'événement
- Description - Description de l'événement
- Règle de récurrence - La règle de récurrence contient tous les détails sur la manière et le moment où l'événement doit se reproduire. Pour plus de détails sur les règles de récurrence, voir la liste des quelques règles de récurrence ajoutées dans l'application mentionnée dans le document ci-dessus.)
Extracteur de sortie requis
- ID de l'événement : Identifiant unique de l'événement qui sera utilisé pour exécuter les autres tâches.
- Event Title (Titre de l'événement) : Titre de l'événement
- Description de l'événement : Titre de l'événement
- Les paramètres supplémentaires renvoyés avec la réponse peuvent être inclus dans les paramètres de sortie.
Supprimer un événement
Objectif : Les utilisateurs peuvent saisir l'ID du calendrier et l'ID de l'événement.
- Les utilisateurs peuvent passer l'ID du calendrier et l'ID de l'événement en entrée et Tulip supprimera l'événement dans le calendrier Google.
Point final
HTTP DELETE appel au point de terminaison -https://www.googleapis.com:443/calendar/v3/calendars/{CalendarID}/events/{EventID}
Données requises
Les paramètres suivants sont envoyés dans le corps de la requête
- ID du calendrier - ID du calendrier sélectionné
- ID de l'événement - ID de l'événement sélectionné