مزامنة تغييرات مؤتمر التقويم

يمكن للمستخدمين تعديل أحداثهم في "تقويم Google" أو حذفها. إذا عدّل مستخدم حدثًا بعد إنشاء اجتماع له، قد تحتاج إضافة Google Workspace إلى الاستجابة للتغيير من خلال تعديل بيانات الاجتماع. إذا كان نظام مكالمات الفيديو التابع لجهة خارجية يعتمد على تتبُّع بيانات الأحداث، قد يؤدي عدم تعديل الاجتماع عند تغيير أحد الأحداث إلى عدم إمكانية استخدام الاجتماع.

تُعرف عملية إبقاء بيانات الاجتماع محدّثة بالتغييرات التي تطرأ على حدث "تقويم Google" باسم المزامنة. مزامنة التغييرات في الأحداث من خلال إنشاء مشغّل قابل للتثبيت في برمجة تطبيقات Google يتم تنشيطه كلما تغيّرت الأحداث في تقويم معيّن لا يوضّح المشغّل الأحداث التي تم تغييرها، ولا يمكنك قصرها على الأحداث التي تتضمّن مؤتمرات أنشأتها فقط. اطلب قائمة بجميع التغييرات التي تم إجراؤها على تقويم منذ آخر عملية مزامنة، وفلتر قائمة الأحداث، وأجرِ التعديلات وفقًا لذلك.

في ما يلي إجراء المزامنة العام:

  1. في المرة الأولى التي ينشئ فيها المستخدم اجتماعًا، يتم بدء عملية المزامنة.
  2. عندما ينشئ المستخدم حدثًا في "تقويم Google" أو يعدّله أو يحذفه، يشغّل المشغّل دالة مشغّل في مشروع الإضافة.
  3. تفحص وظيفة المشغّل مجموعة تغييرات الأحداث منذ آخر مزامنة، وتحدّد ما إذا كان أي منها يتطلب تعديل اجتماع مرتبط تابع لجهة خارجية.
  4. يتم إجراء التعديلات المطلوبة على المؤتمرات من خلال تقديم طلبات إلى واجهة برمجة التطبيقات التابعة لجهة خارجية.
  5. يتم تخزين رمز مميز جديد للمزامنة، وبالتالي لن يتم فحص سوى أحدث التغييرات التي تم إجراؤها على التقويم عند تنفيذ المشغّل في المرة التالية.

بدء المزامنة

تضمن عملية التهيئة أنّ الإضافة جاهزة للرد على التغييرات في التقويم. بعد أن ينشئ الإضافة اجتماعًا بنجاح على نظام تابع لجهة خارجية، يجب أن تنشئ مشغّلاً قابلاً للتثبيت يستجيب لتغييرات الأحداث في هذا التقويم، إذا لم يكن المشغّل متوفّرًا من قبل.

بعد إنشاء المشغّل، يجب أن تنتهي عملية التهيئة بإنشاء الرمز المميز للمزامنة الأولية. ويتم ذلك من خلال تنفيذ دالة المشغّل مباشرةً.

إنشاء مشغّل "تقويم"

للمزامنة، يجب أن ترصد الإضافة متى تم تغيير حدث في "تقويم Google" يتضمّن اجتماع فيديو مرفقًا. ويتم ذلك من خلال إنشاء EventUpdated عبارة تشغيل قابلة للتثبيت. لا يحتاج تطبيقك الإضافي سوى مشغّل واحد لكل تقويم، ويمكنه إنشاء المشغّلات آليًا.

الوقت المقترَح لإنشاء مشغّل هو عندما ينشئ المستخدم أول مؤتمر له، لأنّه في هذه المرحلة يبدأ المستخدم في استخدام الإضافة. بعد إنشاء اجتماع والتأكّد من عدم حدوث أي خطأ، يجب أن يتحقّق التطبيق الإضافي مما إذا كان المشغّل متوفّرًا لهذا المستخدم، وإذا لم يكن متوفّرًا، يجب إنشاؤه.

يتطلّب إنشاء المشغّلات أن يكون لدى الإضافة https://www.googleapis.com/auth/calendar.readonly وhttps://www.googleapis.com/auth/script.scriptapp نطاقات.

تنفيذ وظيفة مشغّل المزامنة

يتم تنفيذ الدوال المشغِّلة عندما يرصد برمجة تطبيقات شرطًا يؤدي إلى تشغيل مشغِّل. يتم تشغيل EventUpdated مشغّلات التقويم عندما ينشئ المستخدم حدثًا أو يعدّله أو يحذفه في تقويم محدّد.

نفِّذ دالة التشغيل التي تستخدمها الإضافة. يجب أن تنفّذ دالة التشغيل هذه ما يلي:

  1. إجراء طلب إلى خدمة Calendar المتقدّمة Calendar.Events.list باستخدام syncToken لاسترداد قائمة بالأحداث التي تم تغييرها منذ آخر مزامنة باستخدام رمز مميّز للمزامنة، يمكنك تقليل عدد الأحداث التي يجب أن يفحصها تطبيقك الإضافي.

    عندما يتم تنفيذ وظيفة المشغّل بدون رمز مميّز صالح للمزامنة، يتم الرجوع إلى مزامنة كاملة. تحاول عمليات المزامنة الكاملة استرداد جميع الأحداث خلال فترة زمنية محددة من أجل إنشاء رمز مميز جديد وصالح للمزامنة.

  2. يتم فحص كل حدث معدَّل لتحديد ما إذا كان مرتبطًا بمكالمة فيديو تابعة لجهة خارجية.

  3. إذا كان الحدث يتضمّن مؤتمرًا، يتم فحصه لمعرفة التغييرات التي تم إجراؤها. واستنادًا إلى التغيير، قد يكون من الضروري تعديل المؤتمر المرتبط. على سبيل المثال، إذا تم حذف حدث، يجب أن تحذف الإضافة الاجتماع.

  4. يتم إجراء أي تغييرات مطلوبة على المؤتمر من خلال إرسال طلبات إلى واجهة برمجة التطبيقات الخاصة بالنظام التابع للجهة الخارجية.

  5. بعد إجراء جميع التغييرات اللازمة، خزِّن قيمة nextSyncToken التي تم إرجاعها من خلال الطريقة Calendar.Events.list. يمكن العثور على رمز المزامنة هذا في الصفحة الأخيرة من النتائج التي تعرضها عملية استدعاء Calendar.Events.list.

تعديل حدث التقويم

في بعض الحالات، قد تحتاج إلى تعديل حدث التقويم عند إجراء عملية مزامنة. إذا اخترت إجراء ذلك، عدِّل الحدث باستخدام طلب خدمة "تقويم 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.

  }
}