高效同步资源

本指南介绍了如何实现日历数据的“增量同步”。使用此方法，您可以在同步所有日历集合的数据的同时节省带宽。

概览

增量同步包括两个阶段：

系统会在最开始的时候执行一次初始完全同步，以便将客户端的状态与服务器的状态完全同步。客户端将获取一个需要保留的同步令牌。
增量同步会反复执行，并使用自上次同步以来发生的所有更改来更新客户端。每次，客户端都会提供从服务器获取的上一个同步令牌，并存储从响应中获取的新同步令牌。

首次完全同步

初始完全同步是对您要同步的集合的所有资源的原始请求。如果您只想同步特定的资源子集，则可以选择使用请求参数来限制列表请求。

在对列出操作的响应中，您会看到一个名为 nextSyncToken 的字段，表示一个同步令牌。您需要存储 nextSyncToken 的值。如果结果集太大且响应分页，则 nextSyncToken 字段仅出现在最后一页上。

增量同步

通过增量同步，您可以检索自上次同步请求以来修改的所有资源。为此，您需要使用 syncToken 字段中指定的最新同步令牌执行列出请求。请注意，结果将始终包含已删除的条目，以便客户端有机会从存储空间中移除这些条目。

如果自上次增量同步请求以来大量资源发生了更改，您可能会在列表结果中看到 pageToken，而不是 syncToken。在这些情况下，您需要执行与检索增量同步中第一页时使用的完全相同的列表查询（具有完全相同的 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

可用于增量同步的一组查询参数受到限制。每个列表请求都应使用同一组查询参数，包括初始请求。如需了解针对各个集合的不同限制，请参阅与 list 请求相关的文档。包含不允许的限制的列表查询的响应代码为 400。

服务器要求完全同步

有时，服务器会由于各种原因（包括令牌过期或相关 ACL 更改）使同步令牌失效。在这种情况下，服务器将使用响应代码 410 响应增量请求。这会触发对客户端存储区的完全擦除并执行新的完全同步。

示例代码

以下示例代码段展示了如何通过 Java 客户端库使用同步令牌。首次调用运行方法时，它将执行完全同步并存储同步令牌。以后每次执行时，它都会加载已保存的同步令牌并执行增量同步。

  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 字段检索更新后的事件。我们不再推荐使用此方法，因为它更容易被遗漏更新（例如，如果未强制执行查询限制）。此外，它只适用于活动。