Takvim konferansı değişikliklerini senkronize et

Kullanıcılar Google Takvim etkinliklerini güncelleyebilir veya silebilir. Bir kullanıcı, konferans oluşturduktan sonra etkinliği güncellerse Google Workspace eklentinizin, konferans verilerini güncelleyerek bu değişikliğe yanıt vermesi gerekebilir. Üçüncü taraf konferans sisteminiz etkinlik verilerinin izlenmesine bağlıysa etkinlik değişikliğiyle ilgili konferansı güncellememeniz konferansın kullanılamaz hale gelmesine neden olabilir.

Konferans verilerinin, Takvim etkinliğinde yapılan değişikliklerle güncel tutulması işlemine senkronizasyon adı verilir. Belirli bir takvimde etkinlikler her değiştiğinde tetiklenen bir Google Apps Komut Dosyası yüklenebilir tetikleyici oluşturarak etkinlik değişikliklerini senkronize edin. Tetikleyici, hangi etkinliklerin değiştiğini bildirmez ve yalnızca sizin oluşturduğunuz konferans etkinlikleriyle sınırlanamaz. Son senkronizasyondan bu yana takvimde yapılan tüm değişikliklerin listesini isteyin, etkinlik listesini filtreleyin ve buna göre güncellemeler yapın.

Genel senkronizasyon prosedürü aşağıdaki gibidir:

  1. Kullanıcı ilk kez konferans oluşturduğunda senkronizasyon işlemi başlatılır.
  2. Kullanıcı, Takvim etkinliklerinden birini her oluşturduğunda, güncellediğinde veya sildiğinde tetikleyici, eklenti projenizde bir tetikleyici işlevi yürütür.
  3. Tetikleyici işlevi, son senkronizasyondan bu yana etkinlik değişiklikleri kümesini inceler ve ilişkili bir üçüncü taraf konferansının güncellenmesini gerektiren değişiklikler olup olmadığını belirler.
  4. Üçüncü taraf API istekleri gönderilerek konferanslarda gerekli güncellemeler yapılır.
  5. Yeni bir senkronizasyon jetonu depolanır. Böylece bir sonraki tetikleyici yürütme işlemi yalnızca takvimdeki en son değişiklikleri inceler.

Senkronizasyonu başlatma

Başlatma işlemi, eklentinizin takvim değişikliklerine yanıt vermeye hazır olmasını sağlar. Eklenti, üçüncü taraf sisteminde başarıyla konferans oluşturduktan sonra, tetikleyici henüz mevcut değilse bu takvimdeki etkinlik değişikliklerine yanıt veren bir yüklenebilir tetikleyici oluşturmalıdır.

Tetikleyici oluşturulduktan sonra, ilk senkronizasyon jetonu oluşturularak başlatma işlemi tamamlanmalıdır. Bu işlem, tetikleyici işlevi doğrudan yürütülerek yapılır.

Takvim tetikleyicisi oluşturma

Senkronize etmek için eklentinizin, ekli konferans içeren bir Takvim etkinliğinin değiştirildiğini algılaması gerekir. Bu işlem, EventUpdated yüklenebilir tetikleyici oluşturularak gerçekleştirilir. Eklentinizin her takvim için yalnızca bir tetikleyiciye ihtiyacı vardır ve bunları programatik olarak oluşturabilir.

Tetikleyici oluşturmak için önerilen zaman, kullanıcının ilk konferansını oluşturduğu zamandır. Çünkü kullanıcı bu noktada eklentiyi kullanmaya başlar. Konferans oluşturduktan ve hata olmadığını doğruladıktan sonra eklentiniz, bu kullanıcı için tetikleyicinin mevcut olup olmadığını kontrol etmeli ve mevcut değilse oluşturmalıdır.

Tetikleyici oluşturmak için eklentinin https://www.googleapis.com/auth/calendar.readonly ve https://www.googleapis.com/auth/script.scriptapp kapsamlarına sahip olması gerekir.

Senkronizasyon tetikleme işlevi uygulama

Tetikleyici işlevleri, Apps Komut Dosyası bir tetikleyicinin etkinleşmesine neden olan bir koşul algıladığında yürütülür. EventUpdated Takvim tetikleyicileri, kullanıcılar belirtilen bir takvimde etkinlik oluşturduğunda, değiştirdiğinde veya sildiğinde tetiklenir.

Eklentinizin kullandığı tetikleyici işlevini uygulayın. Bu tetikleyici işlev aşağıdakileri yapmalıdır:

  1. Son senkronizasyondan bu yana değişen etkinliklerin listesini almak için Calendar.Events.list syncToken kullanarak bir Takvim gelişmiş hizmeti çağrısı yapın. Senkronizasyon jetonu kullanarak eklentinizin incelemesi gereken etkinlik sayısını azaltırsınız.

    Tetikleyici işlevi geçerli bir senkronizasyon jetonu olmadan yürütüldüğünde tam senkronizasyona geri döner. Tam senkronizasyonlar, yeni ve geçerli bir senkronizasyon jetonu oluşturmak için belirli bir zaman aralığındaki tüm etkinlikleri almaya çalışır.

  2. Her değiştirilen etkinlik, ilişkili bir üçüncü taraf konferansı olup olmadığını belirlemek için incelenir.

  3. Bir etkinlikte konferans varsa neyin değiştiği incelenir. Değişikliğe bağlı olarak, ilişkili konferansta değişiklik yapılması gerekebilir. Örneğin, bir etkinlik silindiyse eklenti konferansı silmelidir.

  4. Konferansta yapılması gereken değişiklikler, üçüncü taraf sisteme API çağrıları yapılarak gerçekleştirilir.

  5. Gerekli tüm değişiklikleri yaptıktan sonra Calendar.Events.list yöntemi tarafından döndürülen nextSyncToken değerini saklayın. Bu senkronizasyon jetonu, Calendar.Events.list çağrısı tarafından döndürülen sonuçların son sayfasında bulunur.

Takvim etkinliğini güncelleme

Bazı durumlarda senkronizasyon yaparken takvim etkinliğini güncellemek isteyebilirsiniz. Bu işlemi yapmayı seçerseniz etkinliği uygun Takvim gelişmiş hizmeti isteğiyle güncelleyin. If-Match üstbilgisiyle koşullu güncelleme kullandığınızdan emin olun. Bu sayede, değişikliklerinizin kullanıcının farklı bir istemcide yaptığı eşzamanlı değişikliklerin üzerine yazılması önlenir.

Örnek

Aşağıdaki örnekte, takvim etkinlikleri ve bunlarla ilişkili konferanslar için senkronizasyonu nasıl ayarlayabileceğiniz gösterilmektedir.

/**
 *  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.

  }
}