Ir para o conteúdo

Integração Google Calendar

Uma integração Google Calendar pode ser adicionada à sua instalação do Drovio Server. Permite aos utilizadores planear reuniões Drovio diretamente a partir do Google Calendar: Drovio meeting, nas opções de videoconferência de um evento, cria a reunião, com as datas do evento, e insere nele o link para entrar. Guardar alterações ao evento mantém a reunião alinhada com as suas datas, o seu assunto, a sua descrição, os seus participantes e a sua recorrência; cancelar o evento, ou escolher outra opção de videoconferência, elimina a reunião. O Drovio não envia nenhum convite próprio: o convite do Google Calendar é o que os participantes recebem.

O suplemento autentica os utilizadores com a sua conta Google: na primeira vez, estes autenticam-se também uma única vez na sua instância do Drovio Server, para associar as duas contas. A sua conta Drovio tem de existir previamente.

A integração permite também aos utilizadores da aplicação Drovio planear uma reunião com o Google Calendar a partir do seu botão de calendário, com ou sem o suplemento: ver Planear a partir da aplicação Drovio.

Apenas HTTPS

O Google só chama o suplemento no seu servidor por HTTPS. O seu Drovio Server tem de estar acessível por HTTPS a partir da Internet.

Implantar o suplemento no seu Google Workspace

A ficha pública do Drovio no Google Workspace Marketplace serve apenas a cloud Drovio. O seu servidor recebe um suplemento próprio, que o seu Google Workspace publica de forma privada e que o administrador deste instala para todos: os utilizadores só têm depois de o ligar. A página Google Calendar do painel de administração guia-o ao longo do processo: abra Integrations e depois Configure no cartão Google Calendar.

Precisará de uma conta de administrador do Google Workspace, do Google Cloud CLI e de um projeto Google Cloud para o suplemento.

Criar o projeto Google Cloud

O projeto pode ser criado a partir da consola Google Cloud, do Google Cloud CLI ou do Terraform. Os três conduzem ao mesmo resultado: um projeto com as três APIs de que o suplemento precisa ativadas.

API Serviço Para quê
Google Workspace add-ons API gsuiteaddons.googleapis.com Implanta o suplemento
Google Calendar API calendar-json.googleapis.com Permite ao seu servidor ler os eventos que o suplemento acompanha
Google Workspace Marketplace SDK appsmarket-component.googleapis.com Publica a ficha a partir da qual os utilizadores instalam o suplemento

Na consola Google Cloud, crie um projeto na organização do seu Google Workspace. Depois, em APIs & Services e Library, encontre e ative as três APIs acima.

Escolha o ID do projeto, que tem de estar livre à escala do Google Cloud, e depois encontre o ID da organização do seu Google Workspace:

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

Crie o projeto, ative as suas APIs, e torne-o o projeto atual do Google Cloud CLI, sobre o qual trabalham os comandos dos passos seguintes:

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"

O mesmo projeto, para uma infraestrutura já descrita sob a forma de código, com o fornecedor google. Os ficheiros abaixo formam um único módulo raiz.

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
}

Depois torne-o o projeto atual do Google Cloud CLI, sobre o qual trabalham os comandos dos passos seguintes:

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

O Terraform fica-se pelo projeto: o Google não oferece nenhum recurso para o ecrã de consentimento OAuth, a implantação do suplemento ou a sua ficha, que os passos seguintes criam.

A proteção prevent_destroy conserva o projeto: a ficha está ligada ao seu número, e um projeto eliminado e recriado com o mesmo ID recebe outro, o que obriga a publicar uma nova ficha.

Configurar o ecrã de consentimento OAuth

O Google não oferece nenhum comando para isso: na consola Google Cloud, em APIs & Services e OAuth consent screen, configure-o com o público Internal, que reserva o suplemento aos utilizadores do seu Google Workspace.

Criar a implantação

Na secção Private deployment do painel de administração, transfira a implantação: esta descreve o suplemento e aponta para o seu servidor. Depois execute, com o projeto acima como projeto atual do 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

O primeiro comando apresenta a conta de serviço com a qual o Google chama o suplemento. Cole-a em Service account, depois guarde.

O Google Cloud CLI é o único meio de criar a implantação: a consola Google Cloud não tem nenhuma página para isso, nem o Terraform nenhum recurso.

Publicar a ficha privada

No projeto Google Cloud, configure o Google Workspace Marketplace SDK, ativado com o projeto acima:

Definição Valor
App visibility Private
Installation settings Admin Only Install
App integration Google Workspace add-on, HTTP or other deployments, depois selecione a implantação drovio
Store listing Preencha-a: nome, descrições, logótipos, links

Publique a ficha, depois instale a aplicação para o seu domínio a partir da Google Admin console. Cole o URL da ficha em Marketplace listing, depois guarde.

Configurar a integração

No painel de administração, abra Integrations e depois Configure no cartão Google Calendar.

Campo De onde vem
Status Enabled ou Disabled
Marketplace listing O URL da ficha privada que o seu Google Workspace publicou
Service account O email que gcloud workspace-add-ons get-authorization apresenta

A página apresenta também quantos utilizadores se autenticaram. Guardar produz efeito logo no pedido seguinte, sem reinício a efetuar. Passar o estado a Disabled recusa os pedidos vindos do Google, deixando a página acessível para configurar a integração.

Referência de configuração

Eis as chaves do elemento google_calendar de settings.conf, caso prefira editá-lo diretamente. Num cluster, o painel de administração não as pode guardar: cada servidor lê o seu próprio ficheiro de configuração, que tem de ser editado em cada um deles.

Chave Predefinição Significado
enabled false Ativa a integração
listing_url URL da ficha a partir da qual os utilizadores instalam o suplemento
service_account_email Conta de serviço da implantação, com a qual o Google chama o suplemento
meeting_scheduling true Propõe o Google Calendar no botão de calendário da aplicação Drovio, enquanto a integração estiver ativada

Utilizar o suplemento

Assim que o suplemento estiver instalado para o domínio, o Google Calendar apresenta o Drovio no painel lateral e nas opções de videoconferência dos eventos:

Onde O que faz
Drovio meeting, nas opções de videoconferência de um evento Cria a reunião Drovio do evento e insere no evento o seu link para entrar
O cartão Drovio, no painel lateral Associa a conta Google do utilizador à sua conta Drovio, apresenta a conta Drovio à qual o suplemento está ligado, e permite ao utilizador desligá-lo

As alterações a um evento chegam à sua reunião Drovio assim que o evento é guardado.

Associar a conta Drovio

Na primeira vez, o suplemento abre uma janela na sua instância do Drovio Server para associar a conta Google do utilizador à sua conta Drovio:

  • a um utilizador já autenticado no Drovio no seu navegador, é pedido que confirme a conta a associar, com Connect;
  • qualquer outro utilizador autentica-se primeiro, e depois confirma. A página de autenticação é a do seu servidor, ou um formulário da integração quando o seu servidor não tem nenhuma.

A associação mantém-se até que o utilizador a desligue, a partir do cartão Drovio do painel lateral. Tem de ser concluída no quarto de hora seguinte à abertura da janela.

Eventos nunca guardados

O suplemento cria a reunião Drovio logo que Drovio meeting é escolhido, ao passo que o Google nada diz de um evento fechado sem ter sido guardado. Um dia depois, da próxima vez que o utilizador abrir o cartão Drovio ou alterar o seu calendário, o suplemento verifica o evento junto do Google e elimina a reunião de um evento que nunca foi guardado, ou que foi guardado sem ela.

Planear a partir da aplicação Drovio

Enquanto a integração estiver ativada e meeting_scheduling estiver ligado, o botão de calendário da aplicação Drovio propõe o Google Calendar. O que se abre ao escolhê-lo depende do utilizador:

  • um utilizador que associou o suplemento obtém um novo evento do Google Calendar, onde escolhe Drovio meeting nas opções de videoconferência: o suplemento cria a reunião e mantém-na alinhada com o evento;
  • para qualquer outro utilizador, é criada uma reunião Drovio, e depois aberto um novo evento preenchido com o seu link para entrar, como local e na sua descrição. O assunto e a descrição são redigidos no idioma da conta Drovio do utilizador. A reunião começa no momento em que o utilizador escolhe o Google Calendar e dura uma hora, já que nada indica ao seu servidor quando o evento tem lugar; o seu link permite entrar nela a qualquer momento.

A aplicação apresenta o botão de calendário a partir da aplicação Drovio 3.7.1, com os meios de planeamento que as integrações do seu servidor oferecem: sem nenhum, o botão fica oculto; com um, abre-o diretamente; com vários, abre um menu. Ver Aplicação Drovio.