カレンダー会議の変更を同期する

ユーザーは自分の Google カレンダーの予定を自由に更新、削除できます。ユーザーが会議の作成後にイベントを更新した場合は、アドオンで会議データを更新して変更に対応する必要があります。サードパーティの会議システムがイベントデータの追跡に依存している場合、イベントの変更に応じて会議を更新しないと、会議が使用できなくなり、ユーザー エクスペリエンスが低下する可能性があります。

Google カレンダーの予定に加えられた変更で会議データを最新の状態に保つプロセスを「同期」と呼びます。イベントの変更を同期するには、特定のカレンダーでイベントが変更されるたびに配信される Apps Script のインストール可能なトリガーを作成します。残念ながら、トリガーはどのイベントが変更されたかを報告しません。また、作成した会議を含むイベントのみに限定することはできません。代わりに、前回の同期以降にカレンダーに加えられたすべての変更のリストをリクエストし、イベントリストをフィルタして、それに応じて更新を行う必要があります。

一般的な同期手順は次のとおりです。

1. ユーザーが初めて会議を作成すると、同期プロセスは初期化されます。
2. ユーザーがカレンダーの予定を作成、更新、削除すると、アドオン プロジェクトでトリガー関数が実行されます。
3. トリガー関数は、前回の同期以降の一連のイベント変更を調べ、関連するサードパーティの会議を更新する必要があるかどうかを判断します。
4. 必要な更新はサードパーティの API リクエストを行って、会議に加えられます。
5. 次回のトリガー実行でカレンダーの最新の変更を調べるだけで済むように、新しい同期トークンが保存されます。

同期を初期化する

アドオンがサードパーティ システムで会議を正常に作成すると、このカレンダーのイベントの変更に応答するインストール可能なトリガーが作成されます（トリガーがまだ存在しない場合）。

トリガーの作成後、初期同期トークンを作成して初期化を終了します。これを行うには、トリガー関数を直接実行します。

カレンダーのトリガーを作成する

同期するには、会議が添付されているカレンダーの予定が変更されたことをアドオンで検出する必要があります。これを行うには、EventUpdated インストール可能なトリガーを作成します。アドオンに必要なトリガーはカレンダーごとに 1 つだけで、プログラムで作成できます。

トリガーを作成するのに適したタイミングは、ユーザーが最初の会議を作成するときです。この時点で、ユーザーはアドオンの使用を開始します。会議を作成してエラーがないことを確認した後、アドオンは、このユーザーにトリガーが存在するかどうか、トリガーを作成していないかどうかを確認します。

同期トリガー関数を実装する

トリガー関数は、Apps Script がトリガーを起動する条件を検出すると実行されます。EventUpdated カレンダー トリガーは、ユーザーが指定されたカレンダー内のイベントを作成、変更、または削除したときに配信されます。

アドオンで使用するトリガー関数を実装する必要があります。このトリガー関数は次のことを行います。

1. syncToken を使用してカレンダーの高度なサービスの Calendar.Events.list() 呼び出しを行い、前回の同期以降に変更された予定のリストを取得します。同期トークンを使用すると、アドオンで検査する必要があるイベントの数を減らすことができます。

   有効な同期トークンなしでトリガー関数が実行されると、完全同期に戻ります。完全同期では、新しい有効な同期トークンを生成するために、指定された期間内のすべてのイベントを取得するだけです。

2. 変更された各イベントを調べて、関連するサードパーティの会議があるかどうかを判断します。
3. イベントで会議が行われた場合は、変更内容の確認が行われます。変更によっては、関連する会議の変更が必要になる場合があります。たとえば、イベントが削除された場合、アドオンは会議も削除するはずです。
4. 会議の変更が必要な場合は、サードパーティのシステムに対して API 呼び出しを行います。
5. 必要な変更をすべて行ったら、Calendar.Events.list() メソッドによって返された nextSyncToken を保存します。この同期トークンは、Calendar.Events.list() 呼び出しによって返された結果の最後のページで確認できます。

Google カレンダーの予定を更新しています

場合によっては、同期を実行する際に Google カレンダーの予定を更新することをおすすめします。これを行う場合は、適切な Google カレンダーの高度なサービス リクエストを使って予定を更新します。If-Match ヘッダーを指定して条件付き更新を使用してください。これにより、別のクライアントでユーザーが行った変更を誤って上書きするのを防ぐことができます。

例

次の例は、カレンダーの予定とそれに関連する会議の同期を設定する方法を示しています。

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

  }
}