Synchronizowanie zmian w konferencji z kalendarza

Użytkownicy mogą dowolnie aktualizować i usuwać swoje wydarzenia w Kalendarzu Google. Jeśli użytkownik zaktualizuje wydarzenie po utworzeniu konferencji, może być konieczne zaktualizowanie danych rozmowy wideo przez dodatek. Jeśli system innej firmy do zarządzania konferencją wymaga śledzenia danych zdarzenia, nieudana aktualizacja rozmowy po zmianie wydarzenia może sprawić, że będzie ona bezużyteczna i zmniejszy to komfort użytkowników.

Proces aktualizowania danych rozmowy wideo przez zmiany w wydarzeniu w Kalendarzu Google nazywa się synchronizacją. Możesz synchronizować zmiany wydarzeń przez utworzenie wyzwalacza instalowanego w Apps Script, który uruchamia się, gdy wydarzenia w danym kalendarzu zmieniają się. Niestety, reguła nie pokazuje, które zdarzenia zostały zmienione, i nie można ograniczyć jej tylko do zdarzeń z utworzonymi przez siebie rozmowami wideo. Musisz natomiast pobrać listę wszystkich zmian wprowadzonych w kalendarzu od ostatniej synchronizacji, przefiltrować listę zdarzeń i odpowiednio zaktualizować kalendarz.

Ogólna procedura synchronizacji wygląda tak:

1. Gdy użytkownik utworzy konferencję po raz pierwszy, inicjowany jest proces synchronizacji.
2. Za każdym razem, gdy użytkownik utworzy, zaktualizuje lub usunie jedno z wydarzeń w Kalendarzu, aktywator uruchamia funkcję aktywatora w projekcie dodatku.
3. Funkcja aktywatora sprawdza zestaw zmian zdarzeń od czasu ostatniej synchronizacji i określa, czy któreś z nich wymagają zaktualizowania powiązanej konferencji zewnętrznej.
4. Wszystkie wymagane aktualizacje konferencji są wprowadzane przez wysyłanie żądań do interfejsu API innych firm.
5. Zapisujemy nowy token synchronizacji, więc następne wykonanie aktywatora wymaga tylko sprawdzenia najnowszych zmian w kalendarzu.

Zainicjuj synchronizację

Gdy dodatek utworzy konferencję w systemie innej firmy, powinien utworzyć możliwy do zainstalowania aktywator, który odpowiada na zmiany zdarzeń w tym kalendarzu, jeśli ten aktywator jeszcze nie istnieje.

Po utworzeniu aktywatora inicjowanie powinno zakończyć się przez utworzenie początkowego tokena synchronizacji. W tym celu uruchamia się bezpośrednio funkcję aktywatora.

Tworzenie aktywatora Kalendarza

Aby można było przeprowadzić synchronizację, dodatek musi wykryć, kiedy wydarzenie w Kalendarzu, do którego jest dołączona konferencja, zostanie zmienione. Jest to możliwe dzięki utworzeniu reguły możliwej do zainstalowania EventUpdated. Dodatek potrzebuje tylko jednego aktywatora dla każdego kalendarza. Można go tworzyć automatycznie.

Warto utworzyć aktywator, gdy użytkownik utworzy swoją pierwszą konferencję, ponieważ w tym momencie zaczyna korzystać z dodatku. Po utworzeniu rozmowy wideo i potwierdzeniu, że nie ma błędów, dodatek powinien sprawdzić, czy istnieje wyzwalacz dla tego użytkownika, a jeśli nie, to go utworzy.

Uwaga: tworzenie aktywatorów wymaga autoryzacji dodatku za pomocą zakresów https://www.googleapis.com/auth/calendar.readonly i https://www.googleapis.com/auth/script.scriptapp.

Implementowanie funkcji aktywatora synchronizacji

Funkcje aktywujące są wykonywane, gdy Apps Script wykryje warunek powodujący uruchomienie reguły. EventUpdated Wyzwalacze kalendarza są uruchamiane, gdy użytkownik utworzy, zmieni lub usunie dowolne wydarzenie w określonym kalendarzu.

Musisz zaimplementować funkcję aktywującą, której używa dodatek. Ta funkcja aktywatora powinna wykonywać te działania:

1. Wykonaj wywołanie Calendar.Events.list() usługi zaawansowanej Kalendarza przy użyciu syncToken, aby pobrać listę wydarzeń, które zostały zmienione od ostatniej synchronizacji. Używając tokena synchronizacji, zmniejszasz liczbę zdarzeń, które musi przeanalizować dodatek.

   Gdy funkcja aktywująca zostanie wykonana bez prawidłowego tokena synchronizacji, wraca do pełnej synchronizacji. W ramach pełnej synchronizacji podejmowane są próby pobrania wszystkich zdarzeń w określonym przedziale czasu w celu wygenerowania nowego, prawidłowego tokena synchronizacji.

   Uwaga: czasami tokeny synchronizacji są unieważniane przez serwer, co powoduje wystąpienie błędu Sync token is no longer valid. W takim przypadku Twój kod powinien przeprowadzić pełną synchronizację i zastąpić wszystkie zapisane tokeny synchronizacji.
2. Każde zmodyfikowane wydarzenie jest sprawdzane w celu określenia, czy ma związek z konferencją z firmą zewnętrzną.
3. Jeśli wydarzenie obejmuje konferencję, jest sprawdzane, co zostało zmienione. W zależności od zmiany konieczna może być modyfikacja powiązanej konferencji. Na przykład po usunięciu wydarzenia dodatek prawdopodobnie powinien usunąć konferencję.
4. Wszelkie niezbędne zmiany w konferencji wprowadza się przez wywołania interfejsu API w systemie innej firmy.
5. Po wprowadzeniu wszystkich niezbędnych zmian zapisz wartość nextSyncToken zwracaną przez metodę Calendar.Events.list(). Ten token synchronizacji znajduje się na ostatniej stronie wyników zwracanych przez wywołanie Calendar.Events.list().

Aktualizowanie wydarzenia w Kalendarzu Google

Czasami podczas synchronizacji może być konieczne zaktualizowanie wydarzenia w Kalendarzu Google. Jeśli chcesz to zrobić, zaktualizuj wydarzenie za pomocą odpowiedniego żądania zaawansowanej usługi Kalendarza Google. Pamiętaj, aby użyć aktualizacji warunkowej z nagłówkiem If-Match. Zapobiega to przypadkowemu zastąpieniu przez użytkownika zmian wprowadzonych 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.

  }
}