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

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 componente aggiuntivo potrebbe dover rispondere alla modifica aggiornando i dati della conferenza. Se il tuo sistema di conferenza di terze parti dipende dalla capacità di tenere traccia dei dati dell'evento, un mancato aggiornamento della conferenza dopo una modifica all'evento potrebbe renderla inutilizzabile e compromettere l'esperienza utente.

La procedura per mantenere aggiornati i dati della conferenza con le modifiche all'evento di Google Calendar è chiamata sincronizzazione. Puoi sincronizzare le modifiche degli eventi creando un attivatore installabile di Apps Script che si attiva ogni volta che gli eventi cambiano in un determinato calendario. Purtroppo il trigger non segnala quali eventi sono stati modificati e non puoi limitarlo ai soli eventi con conferenze create da te. Devi invece richiedere un elenco di tutte le modifiche apportate a un calendario dall'ultima sincronizzazione, filtrare l'elenco degli eventi e apportare aggiornamenti di conseguenza.

La procedura di sincronizzazione generale è 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 attivatore nel progetto del componente aggiuntivo.
  3. La funzione trigger esamina l'insieme di modifiche apportate agli eventi dall'ultima sincronizzazione e determina se è necessario aggiornare una conferenza di terze parti associata.
  4. Eventuali aggiornamenti necessari alle conferenze vengono effettuati tramite richieste API di terze parti.
  5. Un nuovo token di sincronizzazione viene archiviato in modo che l'esecuzione successiva del trigger debba esaminare solo le modifiche più recenti al calendario.

Inizializza sincronizzazione

Dopo aver creato correttamente una conferenza su un sistema di terze parti, il componente aggiuntivo dovrebbe creare un trigger installabile che risponda alle modifiche agli eventi in questo calendario, se l'attivatore non esiste già.

Dopo aver creato il trigger, l'inizializzazione dovrebbe terminare con la creazione del token di sincronizzazione iniziale. Per farlo, esegui direttamente la funzione trigger.

Crea un trigger di Calendar

Per la sincronizzazione, il componente aggiuntivo deve rilevare la modifica di un evento di Calendar a cui è allegata una conferenza. A questo scopo, puoi creare 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 prima conferenza, dato che a quel punto l'utente inizia a utilizzare il componente aggiuntivo. Dopo aver creato una conferenza e verificato che non siano presenti errori, il componente aggiuntivo deve controllare se il trigger esiste per questo utente e, in caso contrario, non averlo creato.

Implementare una funzione di trigger di sincronizzazione

Le funzioni di attivazione vengono eseguite quando Apps Script rileva una condizione che determina l'attivazione di un trigger. EventUpdated Calendar si attiva quando un utente crea, modifica o elimina qualsiasi evento in un calendario specificato.

Devi implementare la funzione di trigger utilizzata dal componente aggiuntivo. Questa funzione di trigger dovrebbe fare quanto segue:

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

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

  2. Ogni evento modificato viene esaminato per determinare se è associata a una conferenza di terze parti.
  3. Se un evento prevede una conferenza, viene esaminato per vedere che cosa è stato modificato. A seconda della modifica, potrebbe essere necessaria una modifica della conferenza associata. Ad esempio, se un evento è stato eliminato, il componente aggiuntivo probabilmente dovrebbe eliminare anche la conferenza.
  4. Eventuali modifiche necessarie alla conferenza vengono effettuate effettuando chiamate API al sistema di terze parti.
  5. Dopo aver apportato tutte le modifiche necessarie, archivia il valore 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 quando esegui una sincronizzazione. Se scegli di farlo, aggiorna l'evento con la richiesta di servizio avanzato di Google Calendar appropriata. Assicurati di utilizzare l'aggiornamento condizionale con un'intestazione If-Match. In questo modo si evita che le modifiche sovrascrivano inavvertitamente le modifiche contemporanee apportate dall'utente in un client diverso.

Esempio

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

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

  }
}