Nutzer können ihre Google Kalender-Termine nach Belieben aktualisieren oder löschen. Wenn ein Nutzer einen Termin aktualisiert, nachdem er eine Konferenz erstellt hat, muss Ihr Add-on möglicherweise auf die Änderung reagieren und dazu die Konferenzdaten aktualisieren. Wenn Ihr Drittanbietersystem auf die Nachverfolgung von Ereignisdaten angewiesen ist und die Konferenz nicht bei einer Terminänderung aktualisiert wird, kann sie unbrauchbar werden und die Nutzerfreundlichkeit beeinträchtigen.
Das Verfahren, bei dem die Konferenzdaten mit Änderungen am Google Kalender-Termin aktualisiert werden, wird als Synchronisierung bezeichnet. Sie können Ereignisänderungen synchronisieren, indem Sie einen installierbaren Trigger für Apps Script erstellen, der ausgelöst wird, wenn sich Termine in einem bestimmten Kalender ändern. Leider meldet der Trigger nicht, welche Ereignisse sich geändert haben, und Sie können ihn nicht auf Ereignisse mit von Ihnen erstellten Konferenzen beschränken. Stattdessen müssen Sie eine Liste aller Änderungen anfordern, die seit der letzten Synchronisierung an einem Kalender vorgenommen wurden. Filtern Sie dann die Ereignisliste und nehmen Sie die entsprechenden Aktualisierungen vor.
Das allgemeine Verfahren für die Synchronisierung lautet wie folgt:
- Wenn ein Nutzer zum ersten Mal eine Konferenz erstellt, wird der Synchronisierungsprozess initialisiert.
- Immer wenn der Nutzer ein Kalenderereignis erstellt, aktualisiert oder löscht, führt der Trigger eine Trigger-Funktion in Ihrem Add-on-Projekt aus.
- Die Triggerfunktion prüft den Satz von Ereignisänderungen seit der letzten Synchronisierung und bestimmt, ob eine zugehörige Drittanbieterkonferenz aktualisiert werden muss.
- Alle erforderlichen Aktualisierungen an den Konferenzen werden durch API-Anfragen von Drittanbietern vorgenommen.
- Ein neues Synchronisierungstoken wird gespeichert, sodass bei der nächsten Ausführung des Triggers nur die letzten Änderungen am Kalender überprüft werden müssen.
Synchronisierung initialisieren
Nachdem mit dem Add-on eine Konferenz auf dem System eines Drittanbieters erstellt wurde, sollte ein installierbarer Trigger erstellt werden, der auf Ereignisänderungen in diesem Kalender reagiert, sofern der Trigger noch nicht vorhanden ist.
Nach dem Erstellen des Triggers sollte die Initialisierung durch Erstellen des ersten Synchronisierungstokens abgeschlossen sein. Dazu wird die Triggerfunktion direkt ausgeführt.
Kalender-Trigger erstellen
Zum Synchronisieren muss das Add-on erkennen, wenn ein Kalendertermin mit einer angehängten Konferenz geändert wird. Dazu wird ein installierbarer EventUpdated-Trigger erstellt. Das Add-on benötigt nur einen Trigger für jeden Kalender und kann programmatisch erstellt werden.
Ein guter Zeitpunkt zum Erstellen eines Triggers ist, wenn der Nutzer seine erste Konferenz erstellt, da er ab diesem Zeitpunkt das Add-on verwendet. Nachdem Sie eine Konferenz erstellt und sich vergewissert haben, dass kein Fehler vorliegt, sollte Ihr Add-on prüfen, ob der Trigger für diesen Nutzer vorhanden ist, und falls er nicht erstellt wurde.
Synchronisierungstriggerfunktion implementieren
Triggerfunktionen werden ausgeführt, wenn Apps Script eine Bedingung erkennt, durch die ein Trigger ausgelöst wird.
EventUpdated Kalender-Trigger werden ausgelöst, wenn ein Nutzer einen Termin in einem bestimmten Kalender erstellt, ändert oder löscht.
Sie müssen die Triggerfunktion implementieren, die vom Add-on verwendet wird. Diese Triggerfunktion sollte Folgendes tun:
- Führen Sie einen
Calendar.Events.list()-Aufruf des erweiterten Google Kalender-Diensts mitsyncTokenaus, um eine Liste von Terminen abzurufen, die sich seit der letzten Synchronisierung geändert haben. Durch die Verwendung eines Synchronisierungstokens reduzieren Sie die Anzahl der Ereignisse, die Ihr Add-on untersuchen muss.Wenn die Triggerfunktion ohne gültiges Synchronisierungstoken ausgeführt wird, erfolgt eine Rückkehr zu einer vollständigen Synchronisierung. Bei einer vollständigen Synchronisierung wird lediglich versucht, alle Ereignisse innerhalb eines vorgeschriebenen Zeitfensters abzurufen, um ein neues, gültiges Synchronisierungstoken zu generieren.
- Jedes geänderte Ereignis wird überprüft, um festzustellen, ob ihm eine Konferenz mit einem Drittanbieter zugeordnet ist.
- Wenn ein Termin eine Konferenz enthält, wird geprüft, was geändert wurde. Je nach Änderung kann die zugehörige Konferenz geändert werden. Wenn beispielsweise ein Ereignis gelöscht wurde, sollte das Add-on wahrscheinlich auch die Konferenz löschen.
- Alle erforderlichen Änderungen an der Konferenz werden durch API-Aufrufe an das Drittanbietersystem vorgenommen.
- Nachdem Sie alle erforderlichen Änderungen vorgenommen haben, speichern Sie die von der Methode
Calendar.Events.list()zurückgegebenenextSyncToken. Dieses Synchronisierungstoken befindet sich auf der letzten Ergebnisseite, die vomCalendar.Events.list()-Aufruf zurückgegeben wird.
Google Kalender-Termin aktualisieren
In einigen Fällen möchten Sie möglicherweise den Google Kalender-Termin während der Synchronisierung aktualisieren. Wenn Sie sich dafür entscheiden, aktualisieren Sie den Termin mit der entsprechenden Anfrage für den erweiterten Dienst von Google Kalender. Verwenden Sie die bedingte Aktualisierung in Verbindung mit einem If-Match-Header. Dadurch wird verhindert, dass Ihre Änderungen versehentlich gleichzeitige Änderungen überschreiben, die vom Nutzer in einem anderen Client vorgenommen wurden.
Beispiel
Das folgende Beispiel zeigt, wie Sie die Synchronisierung für Kalendertermine und die zugehörigen Konferenzen einrichten können.
/**
* 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.
}
}