Synchronizowanie zmian w konferencji z kalendarza

Kliknij, aby połączyć.

Użytkownicy mogą dowolnie aktualizować i usuwać swoje wydarzenia w Kalendarzu Google. Jeśli użytkownik zaktualizuje wydarzenie po utworzeniu konferencji, dodatek może wymagać odpowiedzi na tę zmianę przez zaktualizowanie danych rozmowy. Jeśli Twój system innej firmy do obsługi rozmów wideo zależy od śledzenia danych wydarzenia, niepowodzenie aktualizacji może spowodować, że konferencja będzie bezużyteczna i wygoda użytkowników.

Proces aktualizowania danych rozmowy wideo przez wprowadzanie zmian w wydarzeniu w Kalendarzu Google jest nazywany synchronizowaniem. Możesz zsynchronizować zmiany wydarzeń, tworząc instalacyjny aktywator Apps Script, który jest uruchamiany po każdej zmianie wydarzenia w określonym kalendarzu. Aktywator nie podaje, które wydarzenia się zmieniły, i nie można ograniczyć go do wydarzeń utworzonych przez Ciebie. Zamiast tego musisz poprosić o listę wszystkich zmian w kalendarzu wprowadzonych od ostatniej synchronizacji, przefiltrować go i wprowadzić odpowiednie zmiany.

Ogólna procedura synchronizacji wygląda tak:

  1. Gdy użytkownik po raz pierwszy utworzy konferencję, rozpocznie się proces synchronizacji.
  2. Gdy użytkownik utworzy, zaktualizuje lub usunie jedno ze swoich wydarzeń w Kalendarzu, reguła uruchomi funkcję aktywatora w projekcie dodatku.
  3. Funkcja aktywatora sprawdza zestaw zmian zdarzeń od ostatniej synchronizacji i określa, czy któreś z nich wymagają aktualizacji powiązanej rozmowy zewnętrznej.
  4. Wszelkie wymagane aktualizacje dotyczące rozmów wideo są wprowadzane, wysyłając żądania do interfejsu API innych firm.
  5. Nowy token synchronizacji jest przechowywany w taki sposób, aby wykonanie następnego aktywatora wymagało jedynie sprawdzenia najnowszych zmian w kalendarzu.

Inicjowanie synchronizacji

Gdy dodatek utworzy konferencję w systemie innej firmy, powinien utworzyć instalacyjny aktywator, który odpowiada na zmiany wydarzeń w tym kalendarzu, jeśli nie istnieje.

Po utworzeniu aktywatora należy zakończyć przez utworzenie początkowego tokena synchronizacji. Można to zrobić, uruchamiając bezpośrednio regułę.

Tworzenie aktywatora Kalendarza

Aby umożliwić synchronizację, dodatek musi wykrywać, kiedy wydarzenie w Kalendarzu z załączoną konferencją zostanie zmienione. W tym celu należy utworzyć instalacyjny aktywator EventUpdated. Twój dodatek potrzebuje tylko jednego aktywatora na każdy kalendarz i może go tworzyć automatycznie.

Dobrze jest utworzyć aktywator, gdy użytkownik utworzy swoją pierwszą konferencję, ponieważ użytkownik zaczyna używać dodatku. Gdy utworzysz konferencję i sprawdzisz, czy nie ma błędów, sprawdź, czy dodatek istnieje dla tego użytkownika, a jeśli tak, to go nie utwórz.

Wdrażanie funkcji synchronizacji

Funkcje aktywatorów są wykonywane, gdy Apps Script wykryje warunek, który powoduje uruchomienie reguły. EventUpdated Aktywatory Kalendarza uruchamiają się, gdy użytkownik tworzy, modyfikuje lub usuwa dowolne wydarzenie w określonym kalendarzu.

Musisz wdrożyć funkcję aktywowaną przez dodatek. Powinna ona wykonać te czynności:

  1. Wykonaj wywołanie Calendar.Events.list() usługi zaawansowanej Kalendarza, korzystając z syncToken, aby pobrać listę wydarzeń, które uległy zmianie od ostatniej synchronizacji. Użycie tokena synchronizacji pozwala zmniejszyć liczbę zdarzeń, które musi sprawdzać dodatek.

    Gdy funkcja aktywatora jest uruchamiana bez prawidłowego tokena synchronizacji, wraca do pełnej synchronizacji. Pełna synchronizacja powoduje próbę pobrania wszystkich zdarzeń w określonym czasie w celu wygenerowania nowego, prawidłowego tokena synchronizacji.

  2. Każde zmodyfikowane zdarzenie jest sprawdzane, aby określić, czy jest powiązane z konferencją zewnętrzną.
  3. Jeśli wydarzenie obejmuje konferencję, jest ona sprawdzana w celu sprawdzenia, co się zmieniło. W zależności od zmiany może być konieczna zmiana powiązanej rozmowy wideo. Na przykład jeśli wydarzenie zostało usunięte, dodatek powinien prawdopodobnie usunąć również konferencję.
  4. Wszelkie niezbędne zmiany w konferencji są dokonywane poprzez wywołania interfejsu API w systemie innej firmy.
  5. Po wprowadzeniu wszystkich niezbędnych zmian zapisz nextSyncToken zwrócone przez metodę Calendar.Events.list(). Ten token synchronizacji znajduje się na ostatniej stronie wyników zwróconej przez wywołanie Calendar.Events.list().

Aktualizowanie wydarzenia w Kalendarzu Google

W niektórych przypadkach może być konieczne zaktualizowanie wydarzenia w Kalendarzu Google podczas synchronizacji. Jeśli zdecydujesz się na wysłanie zgłoszenia, zaktualizuj informacje o wydarzeniu, wysyłając odpowiednie żądanie usługi zaawansowanej Kalendarza Google. Pamiętaj, aby użyć aktualizacji warunkowej z nagłówkiem If-Match. Zapobiega to przypadkowemu zastąpieniu równoczesnych zmian dokonanych przez użytkownika w innym kliencie.

Przykład

Poniższy przykład pokazuje, jak skonfigurować synchronizację wydarzeń w kalendarzu i powiązanych z nimi rozmów wideo.

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

  }
}