Synchronisation des modifications apportées à la conférence Agenda

Les utilisateurs peuvent librement modifier ou supprimer leurs événements Google Agenda. Si un utilisateur met à jour un événement après avoir créé une conférence pour celui-ci, votre module complémentaire devra peut-être répondre à la modification en mettant à jour les données de la conférence. Si votre système de conférence tiers dépend du suivi des données d'événement, si vous ne mettez pas à jour la conférence en cas de modification d'un événement, cela peut rendre la conférence inutilisable et nuire à l'expérience utilisateur.

Le processus de mise à jour des données de la conférence avec les modifications apportées à l'événement Google Agenda s'appelle la synchronisation. Vous pouvez synchroniser les modifications apportées aux événements en créant un déclencheur installable Apps Script, qui s'active chaque fois que des événements sont modifiés dans un agenda donné. Malheureusement, le déclencheur ne signale pas les événements qui ont été modifiés. Vous ne pouvez pas le limiter aux événements associés aux conférences que vous avez créées. À la place, vous devez demander la liste de toutes les modifications apportées à un agenda depuis la dernière synchronisation, filtrer la liste des événements et effectuer des mises à jour en conséquence.

La procédure générale de synchronisation est la suivante:

1. La première fois qu'un utilisateur crée une conférence, le processus de synchronisation est initialisé.
2. Chaque fois que l'utilisateur crée, met à jour ou supprime l'un de ses événements Agenda, le déclencheur exécute une fonction de déclencheur dans votre projet de module complémentaire.
3. La fonction de déclencheur examine l'ensemble des modifications d'événements depuis la dernière synchronisation et détermine si certaines nécessitent la mise à jour d'une conférence tierce associée.
4. Toutes les modifications requises sont apportées aux conférences via des requêtes API tierces.
5. Un nouveau jeton de synchronisation est stocké de sorte que la prochaine exécution du déclencheur n'ait besoin d'examiner que les modifications les plus récentes apportées à l'agenda.

Initialiser la synchronisation

Une fois que le module complémentaire a créé une conférence sur un système tiers, il doit créer un déclencheur installable qui répond aux modifications d'événements dans cet agenda, si le déclencheur n'existe pas déjà.

Une fois le déclencheur créé, l'initialisation doit se terminer en créant le jeton de synchronisation initial. Pour ce faire, exécutez directement la fonction déclencheur.

Créer un déclencheur Agenda

Pour que la synchronisation fonctionne, votre module complémentaire doit détecter si un événement Agenda auquel une conférence est associée est modifié. Pour ce faire, créez un déclencheur installable EventUpdated. Votre module complémentaire n'a besoin que d'un déclencheur pour chaque agenda et peut les créer par programmation.

Il est judicieux de créer un déclencheur lorsque l'utilisateur crée sa première conférence, car il commence à utiliser le module complémentaire. Après avoir créé une conférence et vérifié qu'il n'y a pas d'erreur, votre module complémentaire doit vérifier si le déclencheur existe pour cet utilisateur et s'il ne la crée pas.

Implémenter une fonction de déclencheur de synchronisation

Les fonctions de déclenchement sont exécutées lorsqu'Apps Script détecte une condition qui entraîne l'exécution d'un déclencheur. Les déclencheurs d'agenda EventUpdated se déclenchent lorsqu'un utilisateur crée, modifie ou supprime un événement dans un agenda spécifié.

Vous devez implémenter la fonction de déclencheur utilisée par votre module complémentaire. Cette fonction de déclencheur doit:

1. Effectuez un appel Calendar.Events.list() au service avancé d'Agenda à l'aide d'un syncToken pour récupérer la liste des événements qui ont été modifiés depuis la dernière synchronisation. L'utilisation d'un jeton de synchronisation vous permet de réduire le nombre d'événements que votre module complémentaire doit examiner.

   Lorsque la fonction de déclenchement s'exécute sans jeton de synchronisation valide, elle revient à une synchronisation complète. Les synchronisations complètes tentent simplement de récupérer tous les événements dans un délai prescrit afin de générer un nouveau jeton de synchronisation valide.

2. Chaque événement modifié est examiné pour déterminer s'il est associé à une conférence tierce.
3. Si un événement est associé à une conférence, il est examiné pour identifier ce qui a été modifié. En fonction de la modification, une modification de la conférence associée peut être nécessaire. Par exemple, si un événement a été supprimé, le module complémentaire devrait probablement supprimer également la conférence.
4. Toutes les modifications nécessaires à la conférence sont effectuées en effectuant des appels d'API au système tiers.
5. Après avoir effectué toutes les modifications nécessaires, stockez le nextSyncToken renvoyé par la méthode Calendar.Events.list(). Ce jeton de synchronisation se trouve sur la dernière page de résultats renvoyés par l'appel Calendar.Events.list().

Mise à jour de l'événement Google Agenda

Dans certains cas, vous pouvez mettre à jour l'événement Google Agenda lorsque vous effectuez une synchronisation. Si vous choisissez de le faire, mettez à jour l'événement à l'aide de la requête du service avancé Google Agenda appropriée. Veillez à utiliser la mise à jour conditionnelle avec un en-tête If-Match. Cela évite que vos modifications remplacent par inadvertance les modifications simultanées apportées par l'utilisateur dans un autre client.

Exemple

L'exemple suivant montre comment configurer la synchronisation des événements d'agenda et des conférences associées.

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

  }
}