סנכרון של השינויים בהגדרות שיחת הוועידה ביומן

המשתמשים יכולים לעדכן או למחוק את האירועים ביומן Google שלהם. אם משתמש מעדכן אירוע אחרי שהוא יצר עבורו ועידה, יכול להיות שתוסף Google Workspace יצטרך להגיב לשינוי הזה ולעדכן את נתוני הוועידה. אם מערכת שיחות הוועידה של הצד השלישי מסתמכת על מעקב אחרי נתוני אירועים, אי-עדכון של שיחת הוועידה בעקבות שינוי באירוע עלול לגרום לכך שלא יהיה אפשר להשתמש בשיחת הוועידה.

התהליך של עדכון נתוני הוועידה בהתאם לשינויים באירוע ביומן נקרא סנכרון. כדי לסנכרן שינויים באירועים, צריך ליצור טריגר שאפשר להתקין ב-Google Apps Script, שמופעל בכל פעם שמתבצעים שינויים באירועים ביומן נתון. הטריגר לא מדווח אילו אירועים השתנו, ואי אפשר להגביל אותו רק לאירועים עם ועידות שיצרתם. לשלוח בקשה לקבלת רשימה של כל השינויים שבוצעו ביומן מאז הסנכרון האחרון, לסנן את רשימת האירועים ולבצע עדכונים בהתאם.

תהליך הסנכרון הכללי הוא כזה:

  1. בפעם הראשונה שמשתמש יוצר שיחת ועידה, מתחיל תהליך הסנכרון.
  2. בכל פעם שמשתמש יוצר, מעדכן או מוחק אחד מהאירועים ביומן שלו, הטריגר מפעיל פונקציית טריגר בפרויקט התוסף.
  3. פונקציית הטריגר בודקת את קבוצת השינויים באירועים מאז הסנכרון האחרון, וקובעת אם יש שינויים שדורשים עדכון של ועידה משויכת של צד שלישי.
  4. העדכונים הנדרשים מתבצעים בוועידות באמצעות בקשות API של צד שלישי.
  5. אסימון סנכרון חדש נשמר, כך שההפעלה הבאה של הטריגר תבדוק רק את השינויים האחרונים ביומן.

התחלת הסנכרון

תהליך האתחול מוודא שהתוסף מוכן להגיב לשינויים ביומן. אחרי שהתוסף יוצר בהצלחה ועידה במערכת של צד שלישי, הוא צריך ליצור טריגר שניתן להתקין שמגיב לשינויים באירועים ביומן הזה, אם הטריגר עדיין לא קיים.

אחרי שיוצרים את הטריגר, האתחול אמור להסתיים ביצירת טוקן הסנכרון הראשוני. כדי לעשות את זה, מפעילים את פונקציית הטריגר ישירות.

יצירת טריגר ביומן

כדי לסנכרן, התוסף צריך לזהות מתי משתנה אירוע ביומן שיש לו שיחת ועידה מצורפת. כדי לעשות את זה, צריך ליצור EventUpdated טריגר שניתן להתקין. תוסף צריך רק טריגר אחד לכל יומן, והוא יכול ליצור אותם באופן אוטומטי.

מומלץ ליצור טריגר כשהמשתמש יוצר את הוועידה הראשונה שלו, כי בשלב הזה הוא מתחיל להשתמש בתוסף. אחרי יצירת ועידה ואימות שאין שגיאה, התוסף צריך לבדוק אם הטריגר קיים עבור המשתמש הזה, ואם לא, ליצור אותו.

כדי ליצור טריגרים, לתוסף צריכות להיות הרשאות https://www.googleapis.com/auth/calendar.readonly ו-https://www.googleapis.com/auth/script.scriptapp.

הטמעה של פונקציה להפעלת סנכרון

פונקציות של טריגר מופעלות כש-Apps Script מזהה תנאי שגורם להפעלת טריגר. EventUpdated טריגרים של יומן מופעלים כשמשתמש יוצר, משנה או מוחק אירוע כלשהו ביומן שצוין.

מטמיעים את פונקציית הטריגר שבה משתמשים בתוסף. פונקציית הטריגר הזו צריכה לבצע את הפעולות הבאות:

  1. מבצעים קריאה לשירות מתקדם של Calendar‏ Calendar.Events.list באמצעות syncToken כדי לאחזר רשימה של אירועים שהשתנו מאז הסנכרון האחרון. שימוש באסימון סנכרון מצמצם את מספר האירועים שצריך לבדוק בתוסף.

    כשפונקציית הטריגר מופעלת בלי טוקן סנכרון תקין, היא חוזרת לסנכרון מלא. בסנכרון מלא, המערכת מנסה לאחזר את כל האירועים בפרק זמן מוגדר כדי ליצור אסימון סנכרון חדש ותקין.

  2. כל אירוע שעבר שינוי נבדק כדי לקבוע אם הוא משויך לשיחת ועידה של צד שלישי.

  3. אם לאירוע יש ועידה, המערכת בודקת מה השתנה. בהתאם לשינוי, יכול להיות שיהיה צורך לשנות את הוועידה שמשויכת לשינוי. לדוגמה, אם אירוע נמחק, התוסף צריך למחוק את הוועידה.

  4. כדי לבצע שינויים בשיחה, צריך לבצע קריאות API למערכת של הצד השלישי.

  5. אחרי שמבצעים את כל השינויים הנדרשים, מאחסנים את הערך nextSyncToken שמוחזר על ידי השיטה Calendar.Events.list. אסימון הסנכרון הזה נמצא בדף האחרון של התוצאות שמוחזרות על ידי הקריאה Calendar.Events.list.

עדכון האירוע ביומן

במקרים מסוימים, יכול להיות שתרצו לעדכן את האירוע ביומן כשמבצעים סנכרון. אם בוחרים לעשות את זה, צריך לעדכן את האירוע באמצעות בקשה מתאימה של שירות מתקדם של יומן. חשוב להשתמש בעדכון מותנה עם כותרת 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.

  }
}