Synchronizuję zmiany dotyczące rozmowy wideo w kalendarzu

Użytkownicy mogą dowolnie aktualizować i usuwać wydarzenia w Kalendarzu Google. Jeśli użytkownik zaktualizuje wydarzenie po utworzeniu dla niego konferencji, może być konieczne zaktualizowanie danych rozmowy przez dodatek. Jeśli Twój system do prowadzenia rozmów wideo firmy zewnętrznej zależy od śledzenia danych o wydarzeniach, nieaktualizowanie konferencji po zmianie wydarzenia może spowodować, że konferencja stanie się bezużyteczna i spowoduje niewygodę użytkowników.

Proces aktualizowania danych konferencji zgodnie ze zmianami w wydarzeniu w Kalendarzu Google nazywamy synchronizacją. Zmiany wydarzeń możesz zsynchronizować, tworząc w Apps Script instalowalny przełącznik, który będzie uruchamiany, gdy w danym kalendarzu nastąpią zmiany wydarzeń. Niestety ten reguła nie podaje, które zdarzenia się zmieniły, i nie możesz jej ograniczyć tylko do zdarzeń z Twoimi konferencjami. Zamiast tego musisz poprosić o listę wszystkich zmian wprowadzonych w kalendarzu od ostatniej synchronizacji, przefiltrować listę wydarzeń i wprowadzić odpowiednie aktualizacje.

Ogólna procedura synchronizacji wygląda tak:

  1. Gdy użytkownik po raz pierwszy utworzy konferencję, inicjowany jest proces synchronizacji.
  2. Za każdym razem, gdy użytkownik utworzy, zaktualizuje lub usunie jedno z wydarzeń w Kalendarzu, aktywator uruchamia funkcję wyzwalacza w projekcie dodatku.
  3. Funkcja aktywatora sprawdza zbiór zmian w zdarzeniach od czasu ostatniej synchronizacji i określa, czy trzeba zaktualizować powiązaną konferencję zewnętrzną.
  4. Wszelkie wymagane aktualizacje konferencji są wprowadzane przez wysyłanie żądań do interfejsu API firmy zewnętrznej.
  5. Nowy token synchronizacji jest przechowywany, aby następne uruchomienie reguły mogło uwzględnić tylko najnowsze zmiany w kalendarzu.

Inicjowanie synchronizacji

Gdy dodatek utworzy konferencję w systemie zewnętrznym, powinien utworzyć instalowalną regułę, która będzie reagować na zmiany wydarzeń w tym kalendarzu, jeśli taka reguła jeszcze nie istnieje.

Po utworzeniu reguły inicjalizacja powinna się zakończyć utworzeniem początkowego tokena synchronizacji. Można to zrobić, wykonując bezpośrednio funkcję wyzwalacza.

Tworzenie aktywatora Kalendarza

Aby można było przeprowadzić synchronizację, dodatek musi wykryć, że wydarzenie w Kalendarzu, do którego jest załączona konferencja, zostanie zmienione. W tym celu należy utworzyć aktywator możliwy do zainstalowania EventUpdated. Twoje rozszerzenie potrzebuje tylko jednego wyzwalacza na każdy kalendarz i może tworzyć je programowo.

Dobrym momentem na utworzenie reguły jest ten, w którym użytkownik tworzy pierwszą konferencję, ponieważ w tym momencie zaczyna korzystać z dodatku. Po utworzeniu rozmowy wideo i sprawdzeniu, czy nie ma błędów, dodatek powinien sprawdzić, czy reguła istnieje dla tego użytkownika, a jeśli nie została utworzona.

Implementacja funkcji wyzwalacza synchronizacji

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

Musisz wdrożyć funkcję aktywatora, której używa Twój dodatek. Ta funkcja aktywatora powinna:

  1. Wykonaj wywołanie usługi zaawansowanej Calendar.Events.list() w Kalendarzu za pomocą parametru syncToken, aby pobrać listę wydarzeń, które uległy zmianie od czasu ostatniej synchronizacji. Dzięki użyciu tokena synchronizacji możesz zmniejszyć liczbę zdarzeń, które musi analizować Twoje dodatki.

    Gdy funkcja aktywatora jest wykonywana bez prawidłowego tokena synchronizacji, następuje wycofywanie pełnej synchronizacji. Pełne synchronizacje próbują pobrać wszystkie zdarzenia w określonym przedziale czasu, aby wygenerować nowy, prawidłowy token synchronizacji.

  2. Każde zmodyfikowane wydarzenie jest sprawdzane w celu określenia, czy jest z nim powiązane konferencja innej firmy.
  3. Jeśli wydarzenie obejmuje konferencję, sprawdza się, co się zmieniło. W zależności od zmiany może być konieczna modyfikacja powiązanej konferencji. Jeśli na przykład wydarzenie zostało usunięte, dodatek powinien prawdopodobnie usunąć też konferencję.
  4. Wszelkie zmiany w konferencji są wprowadzane przez wywołania interfejsu API do systemu zewnętrznego.
  5. Po wprowadzeniu wszystkich niezbędnych zmian zapisz nextSyncToken zwrócony przez metodę Calendar.Events.list(). Można go znaleźć na ostatniej stronie wyników zwracanych przez wywołanie Calendar.Events.list().

Aktualizowanie wydarzenia w Kalendarzu Google

Czasem może być konieczne zaktualizowanie wydarzenia Kalendarza Google podczas synchronizacji. Jeśli chcesz to zrobić, zaktualizuj wydarzenie za pomocą odpowiedniego żądania usługi zaawansowanej Kalendarza Google. Pamiętaj, aby używać aktualizacji warunkowych z nagłówkiem If-Match. Zapobiega to przypadkowemu nadużywaniu przez Ciebie równocześnie zmian wprowadzonych przez użytkownika w innym kliencie.

Przykład

Przykład poniżej 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.

  }
}