Aller au contenu

Intégration Google Calendar

Une intégration Google Calendar peut être ajoutée à votre installation de Drovio Server. Elle permet aux utilisateurs de planifier des réunions Drovio directement depuis Google Calendar : Drovio meeting, dans les options de visioconférence d'un événement, crée la réunion aux dates de l'événement et place le lien pour rejoindre dans l'événement. L'enregistrement des modifications de l'événement tient la réunion à jour de ses dates, de son sujet, de sa description, de ses participants et de sa récurrence ; annuler l'événement, ou choisir une autre option de visioconférence, supprime la réunion. Drovio n'envoie aucune invitation de son côté : l'invitation Google Calendar est celle que reçoivent les participants.

Le module complémentaire connecte ses utilisateurs avec leur compte Google : la première fois, ils se connectent aussi une fois à votre instance Drovio Server, pour relier les deux comptes. Leur compte Drovio doit déjà exister.

L'intégration permet aussi aux utilisateurs de l'application Drovio de planifier une réunion avec Google Calendar depuis son bouton de calendrier, avec ou sans le module complémentaire : voir Planifier depuis l'application Drovio.

HTTPS uniquement

Google n'appelle le module complémentaire sur votre serveur qu'en HTTPS. Votre Drovio Server doit être joignable en HTTPS depuis Internet.

Déployer le module complémentaire dans votre Google Workspace

La fiche publique de Drovio sur le Google Workspace Marketplace ne sert que le cloud Drovio. Votre serveur reçoit son propre module complémentaire, que votre Google Workspace publie en privé et que son administrateur installe pour tous : les utilisateurs n'ont plus qu'à le connecter. La page Google Calendar du panneau d'administration vous guide pas à pas : ouvrez Integrations, puis Configure sur la carte Google Calendar.

Vous aurez besoin d'un compte administrateur Google Workspace, de la Google Cloud CLI et d'un projet Google Cloud pour le module complémentaire.

Créer le projet Google Cloud

Le projet peut être créé depuis la console Google Cloud, la Google Cloud CLI ou Terraform. Les trois aboutissent au même résultat : un projet où sont activées les trois API dont le module complémentaire a besoin.

API Service À quoi elle sert
Google Workspace add-ons API gsuiteaddons.googleapis.com Déploie le module complémentaire
Google Calendar API calendar-json.googleapis.com Permet à votre serveur de lire les événements que suit le module complémentaire
Google Workspace Marketplace SDK appsmarket-component.googleapis.com Publie la fiche depuis laquelle les utilisateurs installent le module complémentaire

Dans la console Google Cloud, créez un projet dans l'organisation de votre Google Workspace. Puis, sous APIs & Services et Library, cherchez et activez les trois API ci-dessus.

Choisissez l'ID du projet, qui doit être libre à l'échelle de Google Cloud, puis trouvez l'ID de l'organisation de votre Google Workspace :

PROJECT=drovio-calendar
gcloud organizations list
ORGANIZATION=<the ID the command prints>

Créez le projet, activez ses API, et faites-en le projet courant de la Google Cloud CLI, sur lequel travaillent les commandes des étapes suivantes :

gcloud projects create "$PROJECT" --name="Drovio Calendar" --organization="$ORGANIZATION"

gcloud services enable --project="$PROJECT" \
  gsuiteaddons.googleapis.com \
  calendar-json.googleapis.com \
  appsmarket-component.googleapis.com

gcloud config set project "$PROJECT"

Le même projet, pour une infrastructure déjà décrite sous forme de code, avec le fournisseur google. Les fichiers ci-dessous forment un seul module racine.

terraform {
  required_version = ">= 1.5.0, < 2.0.0"

  required_providers {
    google = {
      source  = "hashicorp/google"
      version = ">= 5.0"
    }
  }
}
variable "project_id" {
  description = "ID of the project of the add-on, free across Google Cloud"
  type        = string
  default     = "drovio-calendar"
}

variable "org_id" {
  description = "ID of the organization of the Google Workspace, which gcloud organizations list prints"
  type        = string
}
# The listing of the add-on is bound to the number of this project
resource "google_project" "calendar" {
  name       = "Drovio Calendar"
  project_id = var.project_id
  org_id     = var.org_id

  lifecycle {
    prevent_destroy = true
  }
}

resource "google_project_service" "calendar" {
  project = google_project.calendar.project_id
  for_each = toset([
    "appsmarket-component.googleapis.com",
    "calendar-json.googleapis.com",
    "gsuiteaddons.googleapis.com",
  ])
  service = each.key

  disable_dependent_services = true
}
output "project_id" {
  description = "ID of the project, the current project of the Google Cloud CLI for the next steps"
  value       = google_project.calendar.project_id
}

Faites-en ensuite le projet courant de la Google Cloud CLI, sur lequel travaillent les commandes des étapes suivantes :

gcloud config set project "$(terraform output -raw project_id)"

Terraform s'arrête au projet : Google ne propose aucune ressource pour l'écran de consentement OAuth, le déploiement du module complémentaire ou sa fiche, que créent les étapes suivantes.

La garde prevent_destroy préserve le projet : la fiche est liée à son numéro, et un projet supprimé puis recréé sous le même ID en reçoit un autre, ce qui impose de publier une nouvelle fiche.

Configurer l'écran de consentement OAuth

Google ne propose aucune commande pour cela : dans la console Google Cloud, sous APIs & Services et OAuth consent screen, configurez-le avec l'audience Internal, qui réserve le module complémentaire aux utilisateurs de votre Google Workspace.

Créer le déploiement

Dans la section Private deployment du panneau d'administration, téléchargez le déploiement : il décrit le module complémentaire et pointe vers votre serveur. Lancez ensuite, avec le projet ci-dessus comme projet courant de la Google Cloud CLI :

gcloud workspace-add-ons get-authorization
gcloud workspace-add-ons deployments create drovio --deployment-file=drovio-google-calendar-deployment.json
gcloud workspace-add-ons deployments install drovio

La première commande affiche le compte de service sous lequel Google appelle le module complémentaire. Collez-le dans Service account, puis enregistrez.

La Google Cloud CLI est le seul moyen de créer le déploiement : la console Google Cloud n'a aucune page pour cela, et Terraform aucune ressource.

Publier la fiche privée

Dans le projet Google Cloud, configurez le Google Workspace Marketplace SDK, activé avec le projet ci-dessus :

Paramètre Valeur
App visibility Private
Installation settings Admin Only Install
App integration Google Workspace add-on, HTTP or other deployments, puis sélectionnez le déploiement drovio
Store listing À remplir : nom, descriptions, logos, liens

Publiez la fiche, puis installez l'application pour votre domaine depuis la console d'administration Google. Collez l'URL de la fiche dans Marketplace listing, puis enregistrez.

Configurer l'intégration

Dans le panneau d'administration, ouvrez Integrations, puis Configure sur la carte Google Calendar.

Champ D'où il vient
Status Enabled ou Disabled
Marketplace listing L'URL de la fiche privée que votre Google Workspace a publiée
Service account L'adresse email qu'affiche gcloud workspace-add-ons get-authorization

La page indique aussi combien d'utilisateurs se sont connectés. L'enregistrement prend effet dès la requête suivante, sans redémarrage. Passer le statut à Disabled refuse les requêtes venant de Google, tout en laissant la page accessible pour configurer l'intégration.

Référence de configuration

Voici les clés de l'élément google_calendar de settings.conf, si vous préférez l'éditer directement. En cluster, le panneau d'administration ne peut pas les enregistrer : chaque serveur lit son propre fichier de configuration, qu'il faut éditer sur chacun d'eux.

Clé Défaut Signification
enabled false Active l'intégration
listing_url URL de la fiche depuis laquelle les utilisateurs installent le module complémentaire
service_account_email Compte de service du déploiement, sous lequel Google appelle le module complémentaire
meeting_scheduling true Propose Google Calendar dans le bouton de calendrier de l'application Drovio, tant que l'intégration est activée

Utiliser le module complémentaire

Une fois le module complémentaire installé pour le domaine, Google Calendar affiche Drovio dans le panneau latéral et dans les options de visioconférence des événements :

Où Ce qu'il fait
Drovio meeting, dans les options de visioconférence d'un événement Crée la réunion Drovio de l'événement et place son lien pour rejoindre dans l'événement
La carte Drovio, dans le panneau latéral Relie le compte Google de l'utilisateur à son compte Drovio, affiche le compte Drovio auquel le module complémentaire est connecté, et permet à l'utilisateur de le déconnecter

Les modifications d'un événement parviennent à sa réunion Drovio une fois l'événement enregistré.

Relier le compte Drovio

La première fois, le module complémentaire ouvre une fenêtre sur votre instance Drovio Server pour relier le compte Google de l'utilisateur à son compte Drovio :

  • un utilisateur déjà connecté à Drovio dans son navigateur est invité à confirmer le compte à relier, avec Connect ;
  • tout autre utilisateur se connecte d'abord, puis confirme. La page de connexion est celle de votre serveur, ou un formulaire de l'intégration lorsque votre serveur n'en a pas.

Le lien tient jusqu'à ce que l'utilisateur le déconnecte, depuis la carte Drovio du panneau latéral. Il doit être établi dans le quart d'heure qui suit l'ouverture de la fenêtre.

Événements jamais enregistrés

Le module complémentaire crée la réunion Drovio dès que Drovio meeting est choisi, alors que Google ne dit rien d'un événement fermé sans avoir été enregistré. Un jour plus tard, la prochaine fois que l'utilisateur ouvre la carte Drovio ou modifie son calendrier, le module complémentaire vérifie l'événement auprès de Google et supprime la réunion d'un événement qui n'a jamais été enregistré, ou qui l'a été sans elle.

Planifier depuis l'application Drovio

Tant que l'intégration est activée et que meeting_scheduling est actif, le bouton de calendrier de l'application Drovio propose Google Calendar. Ce qu'ouvre ce choix dépend de l'utilisateur :

  • un utilisateur qui a relié le module complémentaire obtient un nouvel événement de Google Calendar, où il choisit Drovio meeting dans les options de visioconférence : le module complémentaire crée la réunion et la tient en accord avec l'événement ;
  • tout autre utilisateur obtient une réunion Drovio créée pour lui, puis un nouvel événement rempli avec son lien pour rejoindre, comme lieu et dans sa description. Le sujet et la description sont rédigés dans la langue du compte Drovio de l'utilisateur. La réunion commence au moment où l'utilisateur choisit Google Calendar et dure une heure, puisque rien n'indique à votre serveur quand l'événement a lieu ; son lien permet de la rejoindre à tout moment.

L'application affiche le bouton de calendrier à partir de l'application Drovio 3.7.1, avec les moyens de planification qu'offrent les intégrations de votre serveur : aucun le masque, un seul l'ouvre directement, plusieurs ouvrent un menu. Voir Application Drovio.