Synchronizuję zmiany dotyczące rozmowy wideo w kalendarzu

Użytkownicy mogą dowolnie aktualizować i usuwać wydarzenia w Kalendarzu Google. Jeśli użytkownik zaktualizuje zdarzenie po utworzeniu konferencji, Twój dodatek może potrzebować aktualizacji danych konferencji. 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ą. Możesz zsynchronizować zmiany w wydarzeniach, tworząc wyzwalacz z możliwością zainstalowania Apps Script, który uruchamia się, gdy wydarzenia zmieniają się w określonym kalendarzu. 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:

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 ze swoich wydarzeń w kalendarzu, wyzwalacz wykona funkcję wyzwalacza w Twoim projekcie dodatku.
3. Funkcja wyzwalacza sprawdza zestaw zmian zdarzeń od czasu ostatniej synchronizacji i określa, czy wymagają one zaktualizowania powiązanej konferencji zewnętrznej.
4. Wszelkie wymagane aktualizacje są wprowadzane za pomocą żądań do interfejsu API innych firm.
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 aktywatora inicjalizacja powinna się zakończyć przez utworzenie początkowego tokena synchronizacji. Odbywa się to bezpośrednio przez wykonywanie funkcji aktywatora.

Tworzenie reguły w Kalendarzu

Aby można było przeprowadzić synchronizację, dodatek musi wykryć, że wydarzenie w Kalendarzu, do którego jest załączona konferencja, zostanie zmienione. Aby to zrobić, utwórz EventUpdated instalowalny aktywator. Dodatek wymaga tylko 1 wyzwalacza na każdy kalendarz i może utworzyć go automatycznie.

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 aktywatora są wykonywane, gdy Apps Script wykryje warunek, który powoduje uruchomienie aktywatora. EventUpdatedWyzwalacze kalendarzauruchamiają się, gdy użytkownik utworzy, zmodyfikuje lub usunie dowolne wydarzenie w określonym kalendarzu.

Musisz zaimplementować funkcję aktywatora, której używa dodatek. Funkcja tego 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. Używając tokena synchronizacji, zmniejszasz liczbę zdarzeń, które musi sprawdzać dodatek.

   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 zdarzenie ma konferencję, sprawdzamy, 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 wartość nextSyncToken zwracaną przez metodę Calendar.Events.list(). Ten token synchronizacji znajduje się na ostatniej stronie wyników zwróconych przez wywołanie Calendar.Events.list().

Aktualizowanie wydarzenia w Kalendarzu Google

W niektórych przypadkach podczas synchronizacji możesz chcieć zaktualizować wydarzenie w Kalendarzu Google. Jeśli zdecydujesz się na to, zaktualizuj wydarzenie za pomocą odpowiedniego zapytania do usługi zaawansowanej Kalendarza Google. Pamiętaj, aby używać aktualizacji warunkowej z nagłówkiem If-Match. Zapobiega to przypadkowemu zastąpieniu przez Twoje zmiany 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.

  }
}