Nutzer können ihre Google Kalender-Termine nach Belieben aktualisieren oder löschen. Wenn ein Nutzer einen Termin aktualisiert, nachdem Sie eine entsprechende Konferenz erstellt haben, muss Ihr Add-on möglicherweise die Konferenzdaten aktualisieren, um auf die Änderung zu reagieren. Wenn Ihr Drittanbieter-Konferenzsysteme hängt von der Verfolgung der Ereignisdaten ab. Wenn die Konferenz nicht zu einer Terminänderung aktualisiert wird, kann die Konferenz unbrauchbar und zu einer schlechten User Experience führen.
Der Prozess, bei dem die Konferenzdaten mit Änderungen an der Ein Google Kalender-Termin wird als Synchronisierung bezeichnet. Sie können Terminänderungen synchronisieren, indem Sie Erstellen eines Apps Script installierbarer Trigger, der ausgelöst wird wenn sich Termine in einem bestimmten Kalender ändern. Leider löst der Trigger nicht Berichte enthalten, welche Ereignisse sich geändert haben, und Sie können sie nicht auf Ereignisse beschränken, Konferenzen, die Sie erstellt haben. Stattdessen müssen Sie eine Liste mit seit der letzten Synchronisierung an einem Kalender vorgenommen haben, filtern Sie und nehmen Sie entsprechende 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 einen seiner Kalendertermine erstellt, aktualisiert oder löscht der Trigger eine Trigger-Funktion in Ihrem Add-on-Projekt ausführt.
- Die Triggerfunktion prüft die Ereignisänderungen seit der letzten werden synchronisiert und ermittelt, ob eine Aktualisierung Konferenz.
- Alle erforderlichen Aktualisierungen werden an den Konferenzen vorgenommen, indem API-Anfragen.
- Ein neues Synchronisierungstoken wird gespeichert, sodass die nächste Triggerausführung nur die letzten Änderungen am Kalender prüfen.
Synchronisierung initialisieren
Nachdem das Add-on erfolgreich eine Konferenz auf einem Drittanbietersystem erstellt hat, Es sollte ein installierbarer Trigger erstellt werden. die auf Ereignisänderungen in diesem Kalender, wenn der Trigger noch nicht vorhanden ist.
Nach dem Erstellen des Triggers sollte die Initialisierung abgeschlossen werden, indem die erste Synchronisierungstoken. Dazu wird die Triggerfunktion direkt ausgeführt.
Kalender-Trigger erstellen
Zur Synchronisierung muss das Add-on erkennen, wenn ein Kalendertermin mit einem angehängten
Konferenz wurde geändert. Dies wird erreicht, indem ein EventUpdated
erstellt wird.
installierbaren Trigger. Mein Add-on
benötigt nur einen Trigger für jeden Kalender und kann diese programmatisch erstellen.
Ein guter Zeitpunkt zum Erstellen eines Triggers ist, wenn der Nutzer seine erste Konferenz erstellt, da die Nutzenden das Add-on verwenden. Nachher Erstellen einer Konferenz und dass kein Fehler vorliegt, sollte das Add-on überprüfen, Trigger für diesen Nutzer vorhanden und wenn er nicht erstellt wird.
Synchronisierungstriggerfunktion implementieren
Trigger-Funktionen werden ausgeführt, wenn Apps Script eine Bedingung erkennt, die
einen Trigger, der ausgelöst werden soll.
EventUpdated
Kalender-Trigger
wird ausgelöst, wenn ein Nutzer ein Ereignis in einem angegebenen
Kalender.
Sie müssen die Triggerfunktion implementieren, die vom Add-on verwendet wird. Diese Triggerfunktion sollte Folgendes tun:
- Einen
Calendar.Events.list()
-Aufruf des erweiterten Google Kalender-Diensts mit einersyncToken
, um eine Liste der Ereignisse abzurufen, die sich seit dem letzten synchronisieren. Durch die Verwendung eines Synchronisierungstokens reduzieren Sie die Anzahl der Ereignisse, die das Add-on enthält die Sie untersuchen müssen.Wenn die Triggerfunktion ohne gültiges Synchronisierungstoken ausgeführt wird, vollständige Synchronisierung. Bei einer vollständigen Synchronisierung wird lediglich versucht, alle Termine abzurufen. innerhalb eines festgelegten Zeitfensters, um eine neue, gültige Synchronisierung Token.
- Jedes geänderte Ereignis wird untersucht, um festzustellen, ob ihm ein verknüpftes Drittanbieterkonferenz.
- Wenn ein Termin eine Konferenz enthält, wird geprüft, was geändert wurde. Je nach Änderung kann auch die zugehörige Konferenz geändert werden. notwendig sein. Wenn beispielsweise ein Ereignis gelöscht wurde, sollte das Add-on wahrscheinlich auch die Konferenz löschen.
- Erforderliche Änderungen an der Konferenz werden durch API-Aufrufe an die Drittanbieter-Systems.
- Nachdem Sie alle erforderlichen Änderungen vorgenommen haben, speichern Sie die
nextSyncToken
, die von die MethodeCalendar.Events.list()
. Dieses Synchronisierungstoken wurde auf der letzten Seite mit Ergebnissen, die vomCalendar.Events.list()
-Aufruf zurückgegeben wurden.
Google Kalender-Termin aktualisieren
In einigen Fällen kann es sinnvoll sein, den Google Kalender-Termin während der Durchführung
eine Synchronisierung. Aktualisieren Sie in diesem Fall den Termin mit den entsprechenden
Erweiterter Dienst von Google Kalender
Achten Sie darauf,
bedingte Aktualisierung
mit einem If-Match
-Header. So können Sie verhindern, dass Ihre Änderungen
Gleichzeitige Änderungen, die der Nutzer in einem anderen Client vorgenommen hat, werden überschrieben.
Beispiel
Das folgende Beispiel zeigt, wie du die Synchronisierung für Kalendertermine einrichten kannst und die damit verbundenen Konferenzen.
/** * 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. } }