Użytkownicy mogą swobodnie aktualizować i usuwać swoje wydarzenia w Kalendarzu Google. Jeśli użytkownik zaktualizuje zdarzenie po utworzeniu konferencji, Twój dodatek może potrzebować aktualizacji danych konferencji. Jeśli Twój system do prowadzenia rozmów wideo firmy zewnętrznej zależy od śledzenia danych o wydarzeniach, nieaktualizowanie konferencji po zmianie wydarzenia może spowodować, że konferencja stanie się bezużyteczna i spowoduje niewygodę użytkowników.
Proces aktualizowania danych konferencji zgodnie ze zmianami w wydarzeniu w Kalendarzu Google nazywamy synchronizacją. Zmiany wydarzeń możesz zsynchronizować, tworząc w Apps Script instalowalny przełącznik, który będzie uruchamiany, gdy w danym kalendarzu nastąpią zmiany wydarzeń. Niestety ten reguła nie podaje, które wydarzenia się zmieniły, i nie możesz jej ograniczyć tylko do wydarzeń z Twoimi konferencjami. Zamiast tego musisz poprosić o listę wszystkich zmian wprowadzonych w kalendarzu od ostatniej synchronizacji, przefiltrować listę wydarzeń i wprowadzić odpowiednie aktualizacje.
Ogólna procedura synchronizacji:
- Gdy użytkownik po raz pierwszy tworzy konferencję, inicjowany jest proces synchronizacji.
- Gdy użytkownik utworzy, zaktualizuje lub usunie jedno z wydarzeń w Kalendarzu aktywator uruchomi funkcję wyzwalacza w projekcie dodatku.
- Funkcja aktywatora sprawdza zbiór zmian zdarzeń od ostatniego zsynchronizować i określić, czy trzeba będzie zaktualizować powiązaną usługę zewnętrzną konferencji.
- Wszelkie wymagane aktualizacje konferencji są wprowadzane przez wysyłanie żądań interfejsu API do zewnętrznych interfejsów API.
- Zapisywany jest nowy token synchronizacji, więc następne wykonanie aktywatora wymaga tylko sprawdzanie najnowszych zmian wprowadzonych w kalendarzu.
Zainicjuj synchronizację
Gdy dodatek utworzy konferencję w systemie innej firmy, powinien utworzyć wyzwalacz możliwy do zainstalowania która reaguje na zmiany wydarzeń w tym kalendarzu, jeśli reguła jeszcze nie istnieje.
Po utworzeniu aktywatora jego inicjalizacja powinna się zakończyć przez utworzenie token synchronizacji. Jest to realizowane przez bezpośrednie wykonanie funkcji wyzwalacza.
Tworzenie reguły w Kalendarzu
Aby można było przeprowadzić synchronizację, dodatek musi wykryć wydarzenie w Kalendarzu, które ma załączony plik
zmieniono konferencję. W tym celu należy utworzyć EventUpdated
aktywator możliwy do zainstalowania. Twój dodatek
wymaga tylko 1 wyzwalacza dla każdego kalendarza i można je utworzyć automatycznie.
Warto utworzyć regułę, gdy użytkownik rozpocznie pierwszą rozmowę wideo, ponieważ w tym momencie użytkownik zaczyna korzystać z dodatku. Po utworzeniu konferencji i sprawdzeniu, czy nie ma błędów, dodatek powinien sprawdzić, czy istnieje reguła dla tego użytkownika, a jeśli nie, utworzyć ją.
Wdrażanie funkcji aktywatora synchronizacji
Funkcje aktywatora są wykonywane, gdy Apps Script wykryje warunek, który powoduje uruchomienie aktywatora.
Wyzwalacze Kalendarza EventUpdated
uruchamia się, gdy użytkownik utworzy, zmieni lub usunie dowolne zdarzenie w określonym zakresie
kalendarz.
Musisz wdrożyć funkcję aktywatora, której używa Twój dodatek. Ta funkcja aktywatora powinien wykonać te czynności:
- Wykonaj zaawansowane wywołanie usługi Kalendarz
Calendar.Events.list()
za pomocą funkcjisyncToken
, aby pobrać listę wydarzeń, które uległy zmianie od ostatniej synchronizacji. Dzięki użyciu tokena synchronizacji możesz zmniejszyć liczbę zdarzeń, które musi analizować Twoje dodatki.Gdy funkcja aktywatora jest wykonywana bez prawidłowego tokena synchronizacji, przechodzi do pełnej synchronizacji. Pełne synchronizacje próbują pobrać wszystkie zdarzenia w określonym czasie w celu wygenerowania nowej, prawidłowej synchronizacji token.
- Każde zmodyfikowane zdarzenie jest sprawdzane pod kątem powiązania z konferencją zewnętrznego dostawcy.
- Jeśli wydarzenie obejmuje konferencję, sprawdza się, co się zmieniło. W zależności od zmiany może być konieczna modyfikacja powiązanej konferencji. Jeśli na przykład wydarzenie zostało usunięte, dodatek powinien prawdopodobnie usuniesz też konferencję.
- Wszelkie zmiany w konferencji są wprowadzane przez wywołania interfejsu API do systemu zewnętrznego.
- Po wprowadzeniu wszystkich niezbędnych zmian zapisz wartość
nextSyncToken
zwracaną przez metodęCalendar.Events.list()
. Ten token synchronizacji znajduje się na ostatniej stronie wyników zwróconych przez wywołanieCalendar.Events.list()
.
Aktualizowanie wydarzenia w Kalendarzu Google
Czasem może być potrzebne aktualizowanie wydarzenia w Kalendarzu Google podczas
synchronizację. Jeśli zdecydujesz się na to, zaktualizuj wydarzenie za pomocą odpowiedniego zapytania do usługi zaawansowanej Kalendarza Google. Pamiętaj, aby używać aktualizacji warunkowej z nagłówkiem If-Match
. Zapobiega to przypadkowemu zastąpieniu przez Twoje zmiany zmian wprowadzonych przez użytkownika w innym kliencie.
Przykład
W tym przykładzie pokazujemy, jak skonfigurować synchronizację wydarzeń w kalendarzu i powiązanych z nimi konferencji.
/** * 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. } }