המשתמשים יכולים לעדכן או למחוק את האירועים שלהם ביומן Google. אם משתמש מעדכן אירוע אחרי שיצר כנס עבורו, יכול להיות שהתוסף יצטרך להגיב לשינוי על ידי עדכון נתוני הכנס. אם מערכת הווידאו של הצד השלישי מסתמכת על מעקב אחר נתוני האירוע, אי-עדכון הווידאו לאחר שינוי באירוע עלול לגרום לכך שלא תהיה אפשרות להשתמש בו, וכתוצאה מכך חוויית המשתמש תהיה גרועה.
התהליך שבו הנתונים של הכנס מתעדכנים עם השינויים באירוע ביומן Google נקרא סנכרון. כדי לסנכרן שינויים באירועים, אפשר ליצור ב-Apps Script טריגר שניתן להתקנה שמופעל בכל פעם שמתרחשים שינויים באירועים ביומן נתון. לצערנו, הטריגר לא מדווח על האירועים שהשתנו ואי אפשר להגביל אותו רק לאירועים עם כנסים שיצרתם. במקום זאת, צריך לבקש רשימה של כל השינויים שבוצעו ביומן מאז הסנכרון האחרון, לסנן את רשימת האירועים ולבצע את העדכונים בהתאם.
תהליך הסנכרון הכללי הוא ככה:
- בפעם הראשונה שמשתמש יוצר ועידה, תהליך הסנכרון מופעל.
- בכל פעם שהמשתמש יוצר, מעדכן או מוחק את אחד מהאירועים שלו ביומן, הטריגר מפעיל פונקציית טריגר בפרויקט התוסף.
- פונקציית הטריגר בודקת את קבוצת השינויים באירועים מאז הסנכרון האחרון, ומחליטה אם יש שינויים שדורשים עדכון של פגישה משויכת של צד שלישי.
- העדכונים הנדרשים מתבצעים באמצעות בקשות API של צד שלישי.
- אסימון סנכרון חדש נשמר, כך שבפעם הבאה שהטריגר יופעל, הוא יצטרך לבדוק רק את השינויים האחרונים ביומן.
איך מפעילים את הסנכרון
אחרי שהתוסף יוצר וערך פגישה במערכת של צד שלישי, הוא אמור ליצור טריגר שניתן להתקנה שתגובה לשינויים באירועים ביומן הזה, אם הטריגר הזה עדיין לא קיים.
אחרי יצירת הטריגר, תהליך האינטליקציה אמור להסתיים ביצירת אסימון הסנכרון הראשוני. כדי לעשות זאת, מריצים את פונקציית הטריגר ישירות.
יצירת טריגר ביומן
כדי לסנכרן, התוסף צריך לזהות מתי מתבצע שינוי באירוע ביומן עם שיחת ועידה מצורפת. כדי לעשות זאת, יוצרים EventUpdated
טריגר שניתן להתקנה. התוסף צריך רק טריגר אחד לכל יומן, וניתן ליצור אותם באופן פרוגרמטי.
זמן טוב ליצור טריגר הוא כשהמשתמש יוצר את הכינוס הראשון שלו, כי בשלב הזה הוא מתחיל להשתמש בתוסף. אחרי שיוצרים ועידה ומוודאים שאין שגיאה, התוסף צריך לבדוק אם הטריגר קיים עבור המשתמש הזה, ואם לא – ליצור אותו.
הטמעת פונקציית טריגר לסנכרון
פונקציות הטריגר מבוצעות כש-Apps Script מזהה תנאי שגורם להפעלה של טריגר.
EventUpdated
יומן Google מפעיל את ההפעלה כשהמשתמש יוצר, משנה או מוחק אירוע כלשהו ביומן מסוים.
צריך להטמיע את פונקציית הטריגר שבה משתמש התוסף. פונקציית הטריגר הזו צריכה לבצע את הפעולות הבאות:
- מריצים קריאה לשירות המתקדם
Calendar.Events.list()
של יומן Google באמצעותsyncToken
כדי לאחזר רשימה של אירועים שהשתנו מאז הסנכרון האחרון. שימוש באסימון סנכרון מאפשר לצמצם את מספר האירועים שהתוסף צריך לבדוק.כשפונקציית הטריגר פועלת ללא אסימון סנכרון תקף, היא מגובה בסנכרון מלא. בסנכרון מלא, המערכת פשוט מנסה לאחזר את כל האירועים בחלון זמן מוגדר כדי ליצור אסימון סנכרון חדש ותוקף.
- כל אירוע שעבר שינוי נבדק כדי לקבוע אם יש לו כנס משויך של צד שלישי.
- אם לאירוע יש כנס, המערכת בודקת מה השתנה. בהתאם לשינוי, יכול להיות שיהיה צורך לשנות את הכינוס המשויך. לדוגמה, אם אירוע נמחק, סביר להניח שהתוסף ימחק גם את שיחת הוועידה.
- כל שינוי נדרש בכנס מתבצע באמצעות קריאות API למערכת של הצד השלישי.
- אחרי שמבצעים את כל השינויים הנדרשים, שומרים את
nextSyncToken
שהוחזר באמצעות ה-methodCalendar.Events.list()
. אסימון הסנכרון הזה נמצא בדף האחרון של התוצאות שמוחזרת על ידי הקריאהCalendar.Events.list()
.
עדכון האירוע ביומן Google
במקרים מסוימים, כדאי לעדכן את האירוע ביומן Google במהלך הסנכרון. אם בוחרים לעשות זאת, צריך לעדכן את האירוע באמצעות הבקשה המתאימה לשירות המתקדם של יומן Google. מקפידים להשתמש בעדכון מותנה עם הכותרת If-Match
. כך השינויים לא יבטלו בטעות שינויים בו-זמנית שהמשתמש ביצע בחשבון לקוח אחר.
דוגמה
בדוגמה הבאה מוסבר איך מגדירים סנכרון של אירועים ביומן והכנסות המשויכות אליהם.
/** * 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. } }