Sincronizzazione delle modifiche alla conferenza del calendario in corso...

Nota :questa funzionalità è stata creata appositamente per i fornitori di servizi di conferenza ed era originariamente disponibile come componenti aggiuntivi per le conferenze di Calendar.

Gli utenti possono aggiornare o eliminare liberamente i propri eventi di Google Calendar. Se un utente aggiorna un evento dopo aver creato una conferenza, il tuo componente aggiuntivo potrebbe dover rispondere alla modifica aggiornando i dati della conferenza. Se il tuo sistema di conferenze di terze parti dipende dal monitoraggio dei dati degli eventi, il mancato aggiornamento della conferenza in caso di modifica di un evento può rendere inutilizzabile la conferenza e comportare una scarsa esperienza utente.

Il processo di aggiornamento dei dati della conferenza in base alle modifiche apportate all'evento di Google Calendar è chiamato sincronizzazione. Puoi sincronizzare le modifiche agli eventi creando un trigger installabile di Apps Script che si attiva ogni volta che gli eventi cambiano in un determinato calendario. Purtroppo, il trigger non indica quali eventi sono stati modificati e non puoi limitarlo solo agli eventi con le conferenze che hai creato. Devi invece richiedere un elenco di tutte le modifiche apportate a un calendario dall'ultima sincronizzazione, filtrare l'elenco degli eventi e apportare gli aggiornamenti di conseguenza.

La procedura generale di sincronizzazione è la seguente:

1. La prima volta che un utente crea una conferenza, viene inizializzato il processo di sincronizzazione.
2. Ogni volta che l'utente crea, aggiorna o elimina uno dei suoi eventi di Calendar, il trigger esegue una funzione di trigger nel progetto del componente aggiuntivo.
3. La funzione di attivazione esamina l'insieme delle modifiche agli eventi dall'ultima sincronizzazione e determina se è necessario aggiornare una conferenza di terze parti associata.
4. Gli aggiornamenti richiesti vengono apportati alle conferenze effettuando richieste API di terze parti.
5. Viene memorizzato un nuovo token di sincronizzazione in modo che la successiva esecuzione del trigger debba esaminare solo le modifiche più recenti al calendario.

Inizializzare la sincronizzazione

Una volta che il componente aggiuntivo ha creato correttamente una conferenza su un sistema di terze parti, deve creare un trigger installabile che risponde alle modifiche agli eventi in questo calendario, se il trigger non esiste già.

Dopo aver creato il trigger, l'inizializzazione deve terminare con la creazione del token di sincronizzazione iniziale. Questa operazione viene eseguita eseguendo direttamente la funzione di attivazione.

Creare un trigger di Calendar

Per la sincronizzazione, il componente aggiuntivo deve rilevare quando viene modificato un evento di Calendar a cui è allegata una conferenza. A questo scopo, viene creato un EventUpdated trigger installabile. Il componente aggiuntivo ha bisogno di un solo trigger per ogni calendario e può crearli in modo programmatico.

Un buon momento per creare un trigger è quando l'utente crea la sua prima conferenza, poiché a quel punto inizia a utilizzare il componente aggiuntivo. Dopo aver creato una conferenza e verificato che non ci siano errori, il componente aggiuntivo deve controllare se il trigger esiste per questo utente e, in caso contrario, crearlo.

Nota: la creazione di trigger richiede che il componente aggiuntivo sia autorizzato con gli https://www.googleapis.com/auth/calendar.readonly e https://www.googleapis.com/auth/script.scriptapp ambiti.

Implementare una funzione di attivazione della sincronizzazione

Le funzioni di attivazione vengono eseguite quando Apps Script rileva una condizione che causa l'attivazione di un trigger. EventUpdated Trigger di Calendar si attivano quando un utente crea, modifica o elimina un evento in un calendario specifico.

Devi implementare la funzione di attivazione utilizzata dal componente aggiuntivo. Questa funzione di trigger deve eseguire le seguenti operazioni:

1. Effettua una chiamata al servizio avanzato di Calendar Calendar.Events.list() utilizzando un syncToken per recuperare un elenco di eventi modificati dall'ultima sincronizzazione. L'utilizzo di un token di sincronizzazione riduce il numero di eventi che il componente aggiuntivo deve esaminare.

   Quando la funzione di attivazione viene eseguita senza un token di sincronizzazione valido, viene eseguita una sincronizzazione completa. Le sincronizzazioni complete tentano semplicemente di recuperare tutti gli eventi entro un periodo di tempo prestabilito per generare un nuovo token di sincronizzazione valido.

   Attenzione: a volte i token di sincronizzazione vengono invalidati dal server, causando un errore Sync token is no longer valid. In questo caso, il codice deve eseguire una sincronizzazione completa e sostituire tutti i token di sincronizzazione archiviati.
2. Ogni evento modificato viene esaminato per determinare se ha una conferenza di terze parti associata.
3. Se un evento ha una conferenza, viene esaminato per vedere cosa è stato modificato. A seconda della modifica, potrebbe essere necessario modificare la conferenza associata. Ad esempio, se un evento è stato eliminato, il componente aggiuntivo dovrebbe probabilmente eliminare anche la conferenza.
4. Eventuali modifiche necessarie alla conferenza vengono apportate effettuando chiamate API al sistema di terze parti.
5. Dopo aver apportato tutte le modifiche necessarie, memorizza nextSyncToken restituito dal metodo Calendar.Events.list(). Questo token di sincronizzazione si trova nell'ultima pagina dei risultati restituiti dalla chiamata Calendar.Events.list().

Aggiornamento dell'evento di Google Calendar

In alcuni casi, potresti voler aggiornare l'evento di Google Calendar durante una sincronizzazione. Se scegli di farlo, aggiorna l'evento con la richiesta appropriata del servizio avanzato Google Calendar. Assicurati di utilizzare l'aggiornamento condizionale con un'intestazione If-Match. In questo modo, le modifiche non sovrascriveranno inavvertitamente quelle simultanee apportate dall'utente in un altro client.

Esempio

L'esempio seguente mostra come configurare la sincronizzazione per gli eventi di calendario e le relative conferenze.

/**
 *  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.

  }
}