リソースを効率的に同期する

このガイドでは、カレンダーデータの増分同期を実装する方法について説明します。この方法を使用すると、帯域幅を節約しながら、すべてのカレンダー コレクションのデータを同期できます。

目次

概要

増分同期は次の 2 つのステージで構成されます。

  1. 最初の完全同期: クライアントの状態をサーバーの状態と完全に同期するために、最初に 1 回実行されます。クライアントは、保持する必要がある同期トークンを取得します。

  2. 増分同期: 前回の同期以降に行われたすべての 変更でクライアントを更新するために、繰り返し実行されます。毎回、クライアントはサーバーから取得した前回の同期トークンを提供し、レスポンスから新しい同期トークンを保存します。

最初の完全同期

最初の完全同期は、同期するコレクションのすべてのリソースに対する元のリクエストです。リソースの特定のサブセットのみを同期する場合は、リクエスト パラメータを使用してリスト リクエストを制限できます。

リスト オペレーションのレスポンスには、同期トークンを表す nextSyncToken という名前のフィールドが含まれています。nextSyncToken の値を保存する必要があります。結果セットが大きすぎてレスポンスが ページ分割されている場合、nextSyncToken フィールドは最後のページにのみ存在します。

増分同期

増分同期を使用すると、前回の同期リクエスト以降に変更されたすべてのリソースを取得できます。これを行うには、syncToken フィールドに最新の同期トークンを指定してリスト リクエストを実行します。 結果には常に削除されたエントリが含まれるため、クライアントはストレージから削除できます。

前回の増分同期リクエスト以降に多数のリソースが変更された場合、リスト結果に syncToken ではなく pageToken が表示されることがあります。このような場合は、増分同期で最初のページを取得するために使用したリストクエリ（同じ syncToken を使用）を実行し、pageToken を追加して、最後のページに別の syncToken が見つかるまで後続のリクエストをページ分割します。この syncToken を次の同期リクエスト用に保存します。

次の例は、増分ページ分割同期を示しています。

元のクエリ

GET /calendars/primary/events?maxResults=10&singleEvents=true&syncToken=CPDAlvWDx70CEPDAlvWDx

結果には次のものが含まれます。

{
  "nextPageToken": "CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA"
}

次のページを取得する

GET /calendars/primary/events?maxResults=10&singleEvents=true&syncToken=CPDAlvWDx70CEPDAlvWDx&pageToken=CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA

サーバーで必要な完全同期

サーバーは、トークンの有効期限切れや関連する ACL の変更により、同期トークンを無効にすることがあります。このような場合、サーバーは HTTP ステータス コード 410 で増分リクエストに応答します。この場合は、クライアント ストレージをクリアして、新しい完全同期を実行します。

サンプルコード

次のサンプルでは、同期トークンを Java クライアント ライブラリで使用する方法を示します。run() メソッドが最初に呼び出されると、完全同期が実行され、同期トークンが保存されます。以降の実行では、保存された同期トークンが読み込まれ、増分同期が実行されます。

  private static void run() throws IOException {
    // Construct the {@link Calendar.Events.List} request, but don't execute it yet.
    Calendar.Events.List request = client.events().list("primary");

    // Load the sync token stored from the last execution, if any.
    String syncToken = syncSettingsDataStore.get(SYNC_TOKEN_KEY);
    if (syncToken == null) {
      System.out.println("Performing full sync.");

      // Set the filters you want to use during the full sync. Sync tokens aren't compatible with
      // most filters, but you may want to limit your full sync to only a certain date range.
      // In this example we are only syncing events up to a year old.
      Date oneYearAgo = Utils.getRelativeDate(java.util.Calendar.YEAR, -1);
      request.setTimeMin(new DateTime(oneYearAgo, TimeZone.getTimeZone("UTC")));
    } else {
      System.out.println("Performing incremental sync.");
      request.setSyncToken(syncToken);
    }

    // Retrieve the events, one page at a time.
    String pageToken = null;
    Events events = null;
    do {
      request.setPageToken(pageToken);

      try {
        events = request.execute();
      } catch (GoogleJsonResponseException e) {
        if (e.getStatusCode() == 410) {
          // A 410 status code, "Gone", indicates that the sync token is invalid.
          System.out.println("Invalid sync token, clearing event store and re-syncing.");
          syncSettingsDataStore.delete(SYNC_TOKEN_KEY);
          eventDataStore.clear();
          run();
        } else {
          throw e;
        }
      }

      List<Event> items = events.getItems();
      if (items.size() == 0) {
        System.out.println("No new events to sync.");
      } else {
        for (Event event : items) {
          syncEvent(event);
        }
      }

      pageToken = events.getNextPageToken();
    } while (pageToken != null);

    // Store the sync token from the last request to be used during the next execution.
    syncSettingsDataStore.set(SYNC_TOKEN_KEY, events.getNextSyncToken());

    System.out.println("Sync complete.");
  }

従来の同期

イベント コレクションの場合、イベント リスト リクエストから updated フィールドの値を保存し、 updatedMin フィールドを使用して更新されたイベントを取得することで、従来の同期を実行できます。この方法は、エラーが発生しやすく（クエリの制限が適用されないなど）、イベントでのみ使用できるため、現在では推奨されていません。