Synchronizuj zmiany w konferencji kalendarza

Użytkownicy mogą aktualizować i usuwać wydarzenia w Kalendarzu Google. Jeśli użytkownik zaktualizuje zdarzenie po utworzeniu dla niego konferencji, dodatek Google Workspace może wymagać odpowiedzi na tę zmianę przez zaktualizowanie danych konferencji. Jeśli system konferencyjny innej firmy zależy od śledzenia danych zdarzeń, brak aktualizacji konferencji w przypadku zmiany zdarzenia może spowodować, że konferencja stanie się bezużyteczna.

Proces aktualizowania danych konferencji w związku ze zmianami w wydarzeniu w Kalendarzu nazywamy synchronizacją. Synchronizuj zmiany wydarzeń, tworząc trigger instalowany w Google Apps Script, który uruchamia się za każdym razem, gdy w danym kalendarzu zmieniają się wydarzenia. Wywołanie nie raportuje, które zdarzenia uległy zmianie, i nie możesz ograniczyć go tylko do zdarzeń z konferencjami utworzonymi przez Ciebie. Poproś o listę wszystkich zmian wprowadzonych w kalendarzu od czasu ostatniej synchronizacji, przefiltruj listę wydarzeń i wprowadź odpowiednie zmiany.

Ogólna procedura synchronizacji wygląda tak:

  1. Gdy użytkownik utworzy pierwszą konferencję, rozpocznie się proces synchronizacji.
  2. Za każdym razem, gdy użytkownik utworzy, zaktualizuje lub usunie jedno ze swoich wydarzeń w Kalendarzu, wyzwalacz wykonuje funkcję wyzwalacza w projekcie dodatku.
  3. Funkcja wyzwalająca sprawdza zestaw zmian zdarzeń od czasu ostatniej synchronizacji i określa, czy któreś z nich wymagają zaktualizowania powiązanego połączenia konferencyjnego innej firmy.
  4. Wymagane aktualizacje są wprowadzane w konferencjach przez wysyłanie żądań do interfejsu API innej firmy.
  5. Zapisywany jest nowy token synchronizacji, dzięki czemu następne wykonanie aktywatora będzie sprawdzać tylko najnowsze zmiany w kalendarzu.

Inicjowanie synchronizacji

Proces inicjowania zapewnia, że dodatek jest gotowy do reagowania na zmiany w kalendarzu. Gdy dodatek utworzy konferencję w systemie zewnętrznym, powinien utworzyć instalowany wyzwalacz, który reaguje na zmiany wydarzeń w tym kalendarzu, jeśli wyzwalacz jeszcze nie istnieje.

Po utworzeniu wyzwalacza inicjowanie powinno się zakończyć utworzeniem tokena synchronizacji początkowej. Odbywa się to przez bezpośrednie wykonanie funkcji aktywującej.

Tworzenie aktywatora Kalendarza

Aby zsynchronizować dane, dodatek musi wykrywać zmiany w wydarzeniu w Kalendarzu, do którego dołączono rozmowę wideo. Możesz to zrobić, tworząc EventUpdated aktywator instalowany. Dodatek potrzebuje tylko 1 wyzwalacza na każdy kalendarz i może tworzyć je programowo.

Zalecany czas utworzenia wyzwalacza to moment, w którym użytkownik tworzy pierwszą konferencję, ponieważ wtedy zaczyna korzystać z dodatku. Po utworzeniu konferencji i sprawdzeniu, czy nie wystąpił żaden błąd, dodatek powinien sprawdzić, czy wyzwalacz istnieje dla tego użytkownika, a jeśli nie, utworzyć go.

Tworzenie wyzwalaczy wymaga, aby dodatek miał https://www.googleapis.com/auth/calendar.readonly i https://www.googleapis.com/auth/script.scriptapp zakresy.

Implementowanie funkcji wywołującej synchronizację

Funkcje aktywujące są wykonywane, gdy Apps Script wykryje warunek, który powoduje uruchomienie aktywatora. EventUpdated Triggery Kalendarza wyzwalają się, gdy użytkownik tworzy, modyfikuje lub usuwa dowolne wydarzenie w określonym kalendarzu.

Zaimplementuj funkcję reguły używaną przez dodatek. Ta funkcja wyzwalająca powinna wykonywać te czynności:

  1. Wykonaj wywołanie usługi zaawansowanej Kalendarza GoogleCalendar.Events.listza pomocą syncToken, aby pobrać listę zdarzeń, które uległy zmianiesyncToken od ostatniej synchronizacji. Użycie tokena synchronizacji zmniejsza liczbę zdarzeń, które musi sprawdzić dodatek.

    Gdy funkcja wyzwalająca zostanie wykonana bez prawidłowego tokena synchronizacji, nastąpi pełna synchronizacja. Pełne synchronizacje próbują pobrać wszystkie wydarzenia w określonym przedziale czasu, aby wygenerować nowy, prawidłowy token synchronizacji.

  2. Każde zmodyfikowane wydarzenie jest sprawdzane pod kątem powiązania z konferencją zewnętrzną.

  3. Jeśli wydarzenie ma konferencję, sprawdzamy, co się zmieniło. W zależności od zmiany może być konieczna modyfikacja powiązanego spotkania. Jeśli na przykład wydarzenie zostało usunięte, dodatek powinien usunąć konferencję.

  4. Wszelkie niezbędne zmiany w konferencji są wprowadzane przez wywoływanie interfejsu API systemu zewnętrznego.

  5. Po wprowadzeniu wszystkich niezbędnych zmian zapisz wartość nextSyncToken zwróconą 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

W niektórych przypadkach podczas synchronizacji możesz chcieć zaktualizować wydarzenie w Kalendarzu. Jeśli się na to zdecydujesz, zaktualizuj wydarzenie za pomocą odpowiedniego żądania zaawansowanej usługi Kalendarza. Pamiętaj, aby używać aktualizacji warunkowej z nagłówkiem If-Match. Zapobiega to zastąpieniu zmian wprowadzonych przez użytkownika w innym kliencie.

Przykład

W przykładzie poniżej pokazujemy, jak skonfigurować synchronizację wydarzeń w kalendarzu i powiązanych z nimi konferencji.

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

  }
}