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

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

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

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

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

הפעלת הסנכרון

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

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

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

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

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

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

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

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

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

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

  2. כל אירוע ששונה נבדק כדי לקבוע אם משויך אליו שיחת ועידה של צד שלישי.
  3. אם באירוע יש שיחת ועידה, הוא נבדק כדי לראות מה השתנה. בהתאם לשינוי, ייתכן שתצטרכו לערוך שינוי בשיחת הוועידה. לדוגמה, אם אירוע נמחק, סביר להניח שגם התוסף יימחק את שיחת הוועידה.
  4. כדי לשנות את ההגדרות של שיחת הוועידה צריך לבצע קריאות ל-API במערכת של הצד השלישי.
  5. אחרי שמבצעים את כל השינויים הנדרשים, מאחסנים את הערך nextSyncToken שמוחזר באמצעות השיטה Calendar.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.

  }
}