このページは Cloud Translation API によって翻訳されました。

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

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

概要

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

クライアントの状態をサーバーの状態と完全に同期するために、最初の完全同期が最初に 1 回実行されます。クライアントは、永続化する必要がある同期トークンを取得します。
増分同期が繰り返し実行され、前回の同期以降に行われたすべての変更でクライアントが更新されます。クライアントは毎回、サーバーから取得した以前の同期トークンを提供し、レスポンスから新しい同期トークンを保存します。

初期完全同期

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

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

増分同期

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

最後の増分同期リクエスト以降に多数のリソースが変更された場合、一覧表示の結果に syncToken ではなく pageToken が表示されることがあります。その場合は、増分同期で最初のページを取得する際に使用したものと同じリストクエリ（まったく同じ syncToken）を実行する必要があります。このクエリに pageToken を追加し、最後のページで別の syncToken が見つかるまで以降のすべてのリクエストでページ分けを行う必要があります。今後の同期リクエストにはこの syncToken を保存しておきます。

段階的な同期の同期が必要なケースに対するクエリの例を以下に示します。

元のクエリ

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

// Result contains the following

"nextPageToken":"CiAKGjBpNDd2Nmp2Zml2cXRwYjBpOXA",

次のページを取得しています

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

サーバーに完全同期が必要

トークンの有効期限や関連する ACL の変更など、さまざまな理由で、同期トークンがサーバーによって無効化される場合があります。このような場合、サーバーはレスポンスコード 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.");
  }SyncTokenSample.java

従来の同期

イベントコレクションの場合は、イベントリストリクエストで更新されたフィールドの値を保持し、modifiedSince フィールドを使用して更新されたイベントを取得することで、引き続き従来の方法で同期を行うことができます。このアプローチは、更新の欠落に関してエラーが発生しやすいため（クエリの制限を適用していない場合など）、推奨されなくなりました。また、イベントでのみ利用可能です。