Skip to content

Google Calendar integration

A Google Calendar integration can be added to your Drovio Server installation. It lets users schedule Drovio meetings right from Google Calendar: Drovio meeting in the video conferencing options of an event creates the meeting, with the dates of the event, and puts the link to join in it. Saving changes to the event keeps the meeting in line with its dates, subject, description, attendees and recurrence; cancelling the event, or choosing another video conferencing option, deletes the meeting. Drovio sends no invitation of its own: the Google Calendar invitation is the one the attendees receive.

The add-on signs its users in with their Google account: the first time, they also sign in to your Drovio Server instance once, to link both accounts. Their Drovio account has to exist already.

The integration also lets the users of the Drovio app schedule a meeting with Google Calendar from its calendar button, with or without the add-on: see Schedule from the Drovio app.

HTTPS only

Google calls the add-on on your server over HTTPS only. Your Drovio Server has to be reachable over HTTPS from the internet.

Deploy the add-on to your Google Workspace

The public listing of Drovio on the Google Workspace Marketplace serves the Drovio cloud only. Your server gets an add-on of its own, which your Google Workspace publishes privately and its administrator installs for everyone: the users then only connect it. The Google Calendar page of the administration panel walks you through it: open Integrations, then Configure on the Google Calendar card.

You will need a Google Workspace administrator account, the Google Cloud CLI and a Google Cloud project for the add-on.

Create the Google Cloud project

The project can be created from the Google Cloud console, the Google Cloud CLI, or Terraform. All three produce the same result: a project with the three APIs the add-on needs enabled.

API Service What for
Google Workspace add-ons API gsuiteaddons.googleapis.com Deploys the add-on
Google Calendar API calendar-json.googleapis.com Lets your server read the events the add-on follows
Google Workspace Marketplace SDK appsmarket-component.googleapis.com Publishes the listing users install the add-on from

In the Google Cloud console, create a project in the organization of your Google Workspace. Then, under APIs & Services and Library, find and enable the three APIs above.

Pick the ID of the project, which has to be free across Google Cloud, then find the ID of the organization of your Google Workspace:

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

Create the project, enable its APIs, and make it the current project of the Google Cloud CLI, which the commands of the next steps work on:

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"

The same project, for an infrastructure already described as code, with the google provider. The files below form one root module.

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
}

Then make it the current project of the Google Cloud CLI, which the commands of the next steps work on:

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

Terraform stops at the project: Google offers no resource for the OAuth consent screen, the deployment of the add-on or its listing, which the next steps create.

The prevent_destroy guard keeps the project: the listing is bound to its number, and a project deleted and created again under the same ID gets another one, which means publishing a new listing.

Google offers no command for it: in the Google Cloud console, under APIs & Services and OAuth consent screen, set it up with the Internal audience, which keeps the add-on to the users of your Google Workspace.

Create the deployment

In the Private deployment section of the administration panel, download the deployment: it describes the add-on and points at your server. Then run, with the project above as the current project of the 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

The first command prints the service account Google calls the add-on as. Paste it in Service account, then save.

The Google Cloud CLI is the only way to create the deployment: the Google Cloud console has no page for it, and Terraform no resource.

Publish the private listing

In the Google Cloud project, configure the Google Workspace Marketplace SDK, enabled with the project above:

Setting Value
App visibility Private
Installation settings Admin Only Install
App integration Google Workspace add-on, HTTP or other deployments, then select the deployment drovio
Store listing Fill it in: name, descriptions, logos, links

Publish the listing, then install the app for your domain from the Google Admin console. Paste the URL of the listing in Marketplace listing, then save.

Configure the integration

In the administration panel, open Integrations, then Configure on the Google Calendar card.

Field Where it comes from
Status Enabled or Disabled
Marketplace listing The URL of the private listing your Google Workspace published
Service account The email gcloud workspace-add-ons get-authorization prints

The page also shows how many users signed in. Saving takes effect on the next request, with no restart to perform. Turning the status to Disabled refuses the requests coming from Google, while leaving the page available to configure the integration.

Configuration reference

These are the keys of the google_calendar element of settings.conf, should you prefer to edit it directly. In a cluster, the administration panel cannot save them: each server reads its own settings file, which has to be edited on every one of them.

Key Default Meaning
enabled false Enable the integration
listing_url URL of the listing users install the add-on from
service_account_email Service account of the deployment, which Google calls the add-on as
meeting_scheduling true Offers Google Calendar in the calendar button of the Drovio app, while the integration is enabled

Use the add-on

Once the add-on is installed for the domain, Google Calendar shows Drovio in the side panel and in the video conferencing options of the events:

Where What it does
Drovio meeting, in the video conferencing options of an event Creates the Drovio meeting of the event and puts its link to join in the event
The Drovio card, in the side panel Links the Google account of the user to their Drovio account, shows the Drovio account the add-on is signed in to, and lets the user disconnect it

Changes to an event reach its Drovio meeting once the event is saved.

The first time, the add-on opens a window on your Drovio Server instance to link the Google account of the user to their Drovio account:

  • a user already signed in to Drovio in their browser is asked to confirm the account to link, with Connect;
  • any other user signs in first, then confirms. The sign-in page is the one of your server, or a form of the integration when your server has none.

The link holds until the user disconnects it, from the Drovio card of the side panel. It has to be completed within a quarter of an hour of opening the window.

Events never saved

The add-on creates the Drovio meeting as soon as Drovio meeting is chosen, while Google tells nothing of an event closed without being saved. A day later, the next time the user opens the Drovio card or changes their calendar, the add-on checks the event with Google and deletes the meeting of an event that was never saved, or that was saved without it.

Schedule from the Drovio app

While the integration is enabled and meeting_scheduling is on, the calendar button of the Drovio app offers Google Calendar. What choosing it opens depends on the user:

  • a user who linked the add-on gets a new event of Google Calendar, where they choose Drovio meeting in the video conferencing options: the add-on creates the meeting and keeps it in line with the event;
  • any other user gets a Drovio meeting created for them, then a new event filled in with its link to join, as its location and in its description. The subject and the description are written in the language of the Drovio account of the user. The meeting starts when the user chooses Google Calendar and lasts an hour, since nothing tells your server when the event takes place; its link joins it at any time.

The app shows the calendar button from Drovio app 3.7.1, with the means of scheduling the integrations of your server offer: none hides it, one opens it directly, several open a menu. See Drovio app.