संसाधनों को बेहतर तरीके से सिंक करें

इस गाइड में, कैलेंडर डेटा के "बढ़ते हुए सिंक्रनाइज़ेशन" को लागू करने का तरीका बताया गया है. इस तरीके का इस्तेमाल करके, बैंडविथ को सेव करते समय सभी कैलेंडर कलेक्शन का डेटा सिंक रखा जा सकता है.

विषय सूची

खास जानकारी

इंक्रीमेंटल सिंक्रनाइज़ेशन में दो चरण होते हैं:

  1. क्लाइंट की स्थिति को सर्वर की स्थिति से पूरी तरह सिंक करने के लिए, शुरुआत में एक बार शुरुआती पूरा सिंक किया जाता है. क्लाइंट को एक सिंक टोकन मिलेगा, जिसे उसे बनाए रखना होगा.

  2. इंक्रीमेंटल सिंक बार-बार किया जाता है और पिछले सिंक के बाद से अब तक हुए सभी बदलावों के साथ क्लाइंट को अपडेट करता है. हर बार क्लाइंट, सर्वर से मिला पिछला सिंक टोकन उपलब्ध कराता है और रिस्पॉन्स से मिला नया सिंक टोकन सेव करता है.

शुरुआत में फ़ुल सिंक

शुरुआती पूरा सिंक, उस कलेक्शन के सभी रिसॉर्स के लिए किया गया मूल अनुरोध होता है जिसे आपको सिंक करना है. अगर आपको रिसॉर्स के किसी खास सबसेट को ही सिंक करना है, तो विकल्प के तौर पर अनुरोध पैरामीटर का इस्तेमाल करके, सूची के अनुरोध को सीमित किया जा सकता है.

सूची में की गई कार्रवाई के जवाब में, आपको nextSyncToken नाम का एक फ़ील्ड दिखेगा. यह सिंक टोकन को दिखाता है. आपको nextSyncToken की वैल्यू सेव करनी होगी. अगर नतीजे का सेट बहुत बड़ा है और रिस्पॉन्स पेज पर नंबर मिलता है, तो nextSyncToken फ़ील्ड सिर्फ़ आखिरी पेज पर मौजूद होता है.

इंक्रीमेंटल सिंक

इंक्रीमेंटल सिंक की मदद से, उन सभी संसाधनों को वापस लाया जा सकता है जिनमें आखिरी बार सिंक करने के अनुरोध के बाद बदलाव किया गया था. ऐसा करने के लिए, आपको syncToken फ़ील्ड में बताए गए सबसे हाल के सिंक टोकन की मदद से, सूची का अनुरोध करना होगा. ध्यान रखें कि नतीजे में मिटाई गई एंट्री हमेशा शामिल होंगी, ताकि क्लाइंट को उन्हें स्टोरेज से हटाने का मौका मिले.

ऐसे मामलों में, जहां पिछले इंक्रीमेंटल सिंक अनुरोध के बाद से, बड़ी संख्या में संसाधनों में बदलाव हुए हैं, आपको सूची के नतीजे में 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

सर्वर के लिए पूरा सिंक करना ज़रूरी है

कभी-कभी सर्वर, सिंक टोकन को अमान्य कर देता है. इसकी कई वजहें हो सकती हैं. जैसे, टोकन की समयसीमा खत्म होना या उससे जुड़े एसीएल में बदलाव करना. ऐसे मामलों में, सर्वर, रिस्पॉन्स कोड 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.");
  }

लेगसी सिंक्रनाइज़ेशन

इवेंट कलेक्शन के लिए, अब भी लेगसी तरीके से सिंक किया जा सकता है. ऐसा करने के लिए, इवेंट सूची के अनुरोध में अपडेट किए गए फ़ील्ड की वैल्यू को सेव किया जा सकता है और अपडेट किए गए इवेंट वापस पाने के लिए, modifiedSince फ़ील्ड का इस्तेमाल किया जा सकता है. अब इस तरीके का सुझाव नहीं दिया जाता, क्योंकि छूटे हुए अपडेट के मामले में गड़बड़ी होने की आशंका ज़्यादा होती है (उदाहरण के लिए, अगर क्वेरी की पाबंदियां लागू नहीं की जाती हैं). इसके अलावा, यह सिर्फ़ इवेंट के लिए उपलब्ध है.