Sincronizando as alterações de conferência da agenda

Observação: essa funcionalidade foi criada especificamente para provedores de conferências e estava disponível originalmente como complementos de conferências do Google Agenda.

Os usuários podem atualizar ou excluir livremente os eventos do Google Agenda. Se um usuário atualizar um evento depois de criar uma conferência para ele, talvez seja necessário que seu complemento responda à mudança atualizando os dados da conferência. Se o sistema de videoconferência de terceiros depender do acompanhamento dos dados do evento, não atualizar a conferência em uma mudança de evento pode tornar a conferência inutilizável e resultar em uma experiência ruim para o usuário.

O processo de manter os dados da conferência atualizados com as mudanças no evento do Google Agenda é chamado de sincronização. Para sincronizar as mudanças de eventos, crie um gatilho instalável do Apps Script que é acionado sempre que os eventos mudam em uma determinada agenda. Infelizmente, o acionador não informa quais eventos foram alterados, e não é possível limitá-lo apenas aos eventos com conferências que você criou. Em vez disso, solicite uma lista de todas as mudanças feitas em um calendário desde a última sincronização, filtre a lista de eventos e faça as atualizações de acordo com isso.

O procedimento geral de sincronização é o seguinte:

1. Na primeira vez que um usuário cria uma conferência, o processo de sincronização é inicializado.
2. Sempre que o usuário cria, atualiza ou exclui um dos eventos da Agenda, o acionador executa uma função de acionamento no projeto do complemento.
3. A função de acionamento examina o conjunto de mudanças de eventos desde a última sincronização e determina se alguma delas exige a atualização de uma conferência associada de terceiros.
4. Todas as atualizações necessárias são feitas nas conferências com solicitações de API de terceiros.
5. Um novo token de sincronização é armazenado para que a próxima execução do gatilho só precise examinar as mudanças mais recentes no calendário.

Inicializar a sincronização

Depois que o complemento criar uma conferência em um sistema de terceiros, ele vai criar um acionador instalável que responde a mudanças de eventos na agenda, se o acionador ainda não existir.

Depois de criar o gatilho, a inicialização vai terminar criando o token de sincronização inicial. Isso é feito executando a função de gatilho diretamente.

Criar um gatilho de agenda

Para sincronizar, o complemento precisa detectar quando um evento do Google Agenda com uma videoconferência anexada é alterado. Isso é feito criando um EventUpdated gatilho instalável. Seu complemento só precisa de um gatilho para cada agenda e pode criá-los de forma programática.

Um bom momento para criar um gatilho é quando o usuário cria a primeira conferência, já que é nesse momento que ele começa a usar o complemento. Depois de criar uma conferência e verificar se não há erros, o complemento precisa verificar se o gatilho existe para esse usuário e, se não existir, criá-lo.

Observação: para criar acionadores, seu complemento precisa ser autorizado com os https://www.googleapis.com/auth/calendar.readonly e https://www.googleapis.com/auth/script.scriptapp escopos.

Implementar uma função de acionamento de sincronização

As funções de gatilho são executadas quando o Apps Script detecta uma condição que faz com que um gatilho seja disparado. Os acionadores da Agenda EventUpdated são ativados quando um usuário cria, modifica ou exclui um evento em uma agenda especificada.

Você precisa implementar a função de gatilho usada pelo complemento. Essa função de acionamento precisa fazer o seguinte:

1. Faça uma chamada do serviço avançado do Google Agenda Calendar.Events.list() usando um syncToken para extrair uma lista de eventos que mudaram desde a última sincronização. Ao usar um token de sincronização, você reduz o número de eventos que o complemento precisa examinar.

   Quando a função de acionamento é executada sem um token de sincronização válido, ela faz um backoff para uma sincronização completa. As sincronizações completas tentam recuperar todos os eventos em um período prescrito para gerar um novo token de sincronização válido.

   Atenção: às vezes, os tokens de sincronização são invalidados pelo servidor, resultando em um erro Sync token is no longer valid. Quando isso acontecer, seu código vai realizar uma sincronização completa e substituir todos os tokens de sincronização armazenados.
2. Cada evento modificado é analisado para determinar se ele tem uma videoconferência associada de terceiros.
3. Se um evento tiver uma conferência, ele será analisado para verificar o que foi alterado. Dependendo da mudança, pode ser necessário modificar a conferência associada. Por exemplo, se um evento for excluído, o complemento provavelmente também vai excluir a conferência.
4. As mudanças necessárias na conferência são feitas com chamadas de API para o sistema de terceiros.
5. Depois de fazer todas as mudanças necessárias, armazene o nextSyncToken retornado pelo método Calendar.Events.list(). Esse token de sincronização é encontrado na última página de resultados retornada pela chamada Calendar.Events.list().

Atualizar o evento do Google Agenda

Em alguns casos, talvez seja necessário atualizar o evento do Google Agenda ao realizar uma sincronização. Se você escolher fazer isso, atualize o evento com a solicitação apropriada do serviço avançado do Google Agenda. Use atualização condicional com um cabeçalho If-Match. Isso evita que suas mudanças substituam inadvertidamente mudanças simultâneas feitas pelo usuário em um cliente diferente.

Exemplo

O exemplo a seguir mostra como configurar a sincronização de eventos da agenda e das conferências associadas.

/**
 *  Initializes syncing of conference data by creating a sync trigger and
 *  sync token if either does not exist yet.
 *
 *  @param {String} calendarId The ID of the Google Calendar.
 */
function initializeSyncing(calendarId) {
  // Create a syncing trigger if it doesn't exist yet.
  createSyncTrigger(calendarId);

  // Perform an event sync to create the initial sync token.
  syncEvents({'calendarId': calendarId});
}

/**
 *  Creates a sync trigger if it does not exist yet.
 *
 *  @param {String} calendarId The ID of the Google Calendar.
 */
function createSyncTrigger(calendarId) {
  // Check to see if the trigger already exists; if does, return.
  var allTriggers = ScriptApp.getProjectTriggers();
  for (var i = 0; i < allTriggers.length; i++) {
    var trigger = allTriggers[i];
    if (trigger.getTriggerSourceId() == calendarId) {
      return;
    }
  }

  // Trigger does not exist, so create it. The trigger calls the
  // 'syncEvents()' trigger function when it fires.
  var trigger = ScriptApp.newTrigger('syncEvents')
      .forUserCalendar(calendarId)
      .onEventUpdated()
      .create();
}

/**
 *  Sync events for the given calendar; this is the syncing trigger
 *  function. If a sync token already exists, this retrieves all events
 *  that have been modified since the last sync, then checks each to see
 *  if an associated conference needs to be updated and makes any required
 *  changes. If the sync token does not exist or is invalid, this
 *  retrieves future events modified in the last 24 hours instead. In
 *  either case, a new sync token is created and stored.
 *
 *  @param {Object} e If called by a event updated trigger, this object
 *      contains the Google Calendar ID, authorization mode, and
 *      calling trigger ID. Only the calendar ID is actually used here,
 *      however.
 */
function syncEvents(e) {
  var calendarId = e.calendarId;
  var properties = PropertiesService.getUserProperties();
  var syncToken = properties.getProperty('syncToken');

  var options;
  if (syncToken) {
    // There's an existing sync token, so configure the following event
    // retrieval request to only get events that have been modified
    // since the last sync.
    options = {
      syncToken: syncToken
    };
  } else {
    // No sync token, so configure to do a 'full' sync instead. In this
    // example only recently updated events are retrieved in a full sync.
    // A larger time window can be examined during a full sync, but this
    // slows down the script execution. Consider the trade-offs while
    // designing your add-on.
    var now = new Date();
    var yesterday = new Date();
    yesterday.setDate(now.getDate() - 1);
    options = {
      timeMin: now.toISOString(),          // Events that start after now...
      updatedMin: yesterday.toISOString(), // ...and were modified recently
      maxResults: 50,   // Max. number of results per page of responses
      orderBy: 'updated'
    }
  }

  // Examine the list of updated events since last sync (or all events
  // modified after yesterday if the sync token is missing or invalid), and
  // update any associated conferences as required.
  var events;
  var pageToken;
  do {
    try {
      options.pageToken = pageToken;
      events = Calendar.Events.list(calendarId, options);
    } catch (err) {
      // Check to see if the sync token was invalidated by the server;
      // if so, perform a full sync instead.
      if (err.message ===
            "Sync token is no longer valid, a full sync is required.") {
        properties.deleteProperty('syncToken');
        syncEvents(e);
        return;
      } else {
        throw new Error(err.message);
      }
    }

    // Read through the list of returned events looking for conferences
    // to update.
    if (events.items && events.items.length > 0) {
      for (var i = 0; i < events.items.length; i++) {
         var calEvent = events.items[i];
         // Check to see if there is a record of this event has a
         // conference that needs updating.
         if (eventHasConference(calEvent)) {
           updateConference(calEvent, calEvent.conferenceData.conferenceId);
         }
      }
    }

    pageToken = events.nextPageToken;
  } while (pageToken);

  // Record the new sync token.
  if (events.nextSyncToken) {
    properties.setProperty('syncToken', events.nextSyncToken);
  }
}

/**
 *  Returns true if the specified event has an associated conference
 *  of the type managed by this add-on; retuns false otherwise.
 *
 *  @param {Object} calEvent The Google Calendar event object, as defined by
 *      the Calendar API.
 *  @return {boolean}
 */
function eventHasConference(calEvent) {
  var name = calEvent.conferenceData.conferenceSolution.name || null;

  // This version checks if the conference data solution name matches the
  // one of the solution names used by the add-on. Alternatively you could
  // check the solution's entry point URIs or other solution-specific
  // information.
  if (name) {
    if (name === "My Web Conference" ||
        name === "My Recorded Web Conference") {
      return true;
    }
  }
  return false;
}

/**
 *  Update a conference based on new Google Calendar event information.
 *  The exact implementation of this function is highly dependant on the
 *  details of the third-party conferencing system, so only a rough outline
 *  is shown here.
 *
 *  @param {Object} calEvent The Google Calendar event object, as defined by
 *      the Calendar API.
 *  @param {String} conferenceId The ID used to identify the conference on
 *      the third-party conferencing system.
 */
function updateConference(calEvent, conferenceId) {
  // Check edge case: the event was cancelled
  if (calEvent.status === 'cancelled' || eventHasConference(calEvent)) {
    // Use the third-party API to delete the conference too.


  } else {
    // Extract any necessary information from the event object, then
    // make the appropriate third-party API requests to update the
    // conference with that information.

  }
}