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 videoconferenze di terze parti dipende dal monitoraggio dei dati sugli eventi, la mancata aggiornamento della conferenza in caso di modifica di un evento può renderla inutilizzabile e comportare una scarsa esperienza utente.
La procedura per mantenere aggiornati i dati della conferenza con le modifiche alle L'evento di Google Calendar si chiama sincronizzazione. Puoi sincronizzare le modifiche degli eventi sulla creazione di uno script di Google Apps attivatore installabile che si attiva ogni volta che in un determinato calendario cambiano gli eventi. Purtroppo, l'attivatore non segnalare quali eventi sono stati modificati e non puoi limitarlo ai soli eventi con che hai creato. Devi richiedere invece un elenco di tutte le modifiche apportate a un calendario dall'ultima sincronizzazione, filtra i all'elenco degli eventi e apporta le modifiche necessarie.
La procedura di sincronizzazione generale è la seguente:
- La prima volta che un utente crea una conferenza, il processo di sincronizzazione viene inizializzato.
- Ogni volta che l'utente crea, aggiorna o elimina uno dei suoi eventi di Calendar, l'attivatore esegue una funzione di attivazione nel progetto del componente aggiuntivo.
- La funzione trigger esamina l'insieme di modifiche degli eventi dall'ultima sincronizzare e determina se è necessario aggiornare una terza parte associata conferenza.
- Eventuali aggiornamenti necessari alle conferenze vengono apportati tramite aggiornamenti richieste API.
- Viene memorizzato un nuovo token di sincronizzazione che consente di eseguire solo la successiva esecuzione del trigger esaminare le modifiche più recenti al calendario.
Inizializzare la sincronizzazione
Dopo che il componente aggiuntivo ha creato una conferenza su un sistema di terze parti, dovrebbe creare un attivatore installabile che risponde modifiche dell'evento in questo calendario, se il trigger non esiste già.
Dopo aver creato l'attivatore, l'inizializzazione dovrebbe terminare con la creazione del token di sincronizzazione iniziale. Questo viene fatto eseguendo direttamente la funzione di attivazione.
Crea un trigger di Calendar
Per la sincronizzazione, il componente aggiuntivo deve rilevare quando viene modificato un evento di Calendar con una conferenza collegata. Ciò viene ottenuto creando un EventUpdated
trigger installabile. Il tuo componente aggiuntivo
richiede un solo trigger per ogni calendario e puoi crearli in modo programmatico.
Un buon momento per creare un attivatore è quando l'utente crea la sua prima conferenza, poiché in quel momento inizia a utilizzare il componente aggiuntivo. Dopo il giorno creazione di una conferenza e verificando che non ci siano errori, il componente aggiuntivo deve controllare se trigger esistente per questo utente; in caso contrario, non è stato creato.
Implementare una funzione di attivazione della sincronizzazione
Le funzioni di attivazione vengono eseguite quando Apps Script rileva una condizione che causa
un attivatore.
EventUpdated
attivatori di Calendar
si attivano quando un utente crea, modifica o elimina qualsiasi evento in un
calendario.
Devi implementare la funzione di attivazione utilizzata dal componente aggiuntivo. Questa funzione di trigger deve svolgere le seguenti operazioni:
- Esegui una chiamata
Calendar.Events.list()
al servizio avanzato di Calendar utilizzando unsyncToken
per recuperare un elenco di eventi che sono stati modificati dall'ultima sincronizzazione. L'utilizzo di un token di sincronizzazione riduce il numero di eventi del componente aggiuntivo 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 in un periodo di tempo prestabilito per generare un nuovo token di sincronizzazione valido.
- Ogni evento modificato viene esaminato per determinare se è associato conferenza di terze parti.
- 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 è stato eliminato un evento, il componente aggiuntivo dovrebbe probabilmente eliminare anche la conferenza.
- Eventuali modifiche necessarie alla conferenza vengono apportate inviando chiamate API al sistema di terze parti.
- Dopo aver apportato tutte le modifiche necessarie, memorizza il valore
nextSyncToken
restituito da il metodoCalendar.Events.list()
. Questo token di sincronizzazione si trova nell'ultimo pagina dei risultati restituiti dalla chiamataCalendar.Events.list()
.
Aggiornamento dell'evento di Google Calendar
In alcuni casi potresti voler aggiornare l'evento di Google Calendar durante l'esecuzione
una sincronizzazione. Se scegli di farlo, aggiorna l'evento con la richiesta appropriata per il servizio avanzato di Google Calendar. Assicurati di utilizzare
aggiornamento condizionale
con un'intestazione If-Match
. In questo modo, le modifiche apportate non sovrascrivono involontariamente quelle apportate dall'utente in un altro client.
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. } }