एक साथ कई अनुरोध भेजें

एपीआई के इस वर्शन में, सिर्फ़ सदस्यता को ट्रांसफ़र करने में ही बैच अनुरोध का इस्तेमाल किया जाता है. इसके अलावा, एपीआई के बैच अनुरोध में, बैच Content-ID फ़ील्ड में अपने-आप जानकारी नहीं भरती.

इस दस्तावेज़ में बताया गया है कि आपके क्लाइंट को बनाए जाने वाले एचटीटीपी कनेक्शन कम करने के लिए, एपीआई कॉल को एक साथ किस तरह बैच करना है.

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

खास जानकारी

आपका क्लाइंट हर एचटीटीपी कनेक्शन के लिए, तय सीमा से ज़्यादा ओवरहेड बनाता है. Admin SDK API, एक साथ कई एपीआई कॉल भेजने की सुविधा देता है. इससे आपका क्लाइंट एक एचटीटीपी अनुरोध में कई एपीआई कॉल कर सकता है.

उन स्थितियों के उदाहरण जिनमें शायद आप एक साथ कई अनुरोध करने की सुविधा का इस्तेमाल करना चाहें:

  • आपने अभी-अभी एपीआई का इस्तेमाल शुरू किया है और आपके पास अपलोड करने के लिए बहुत सारा डेटा है.
  • किसी उपयोगकर्ता ने उस समय डेटा में बदलाव किए हैं जब आपका ऐप्लिकेशन ऑफ़लाइन था (इंटरनेट से डिसकनेक्ट था), इसलिए आपके ऐप्लिकेशन को ज़्यादा अपडेट भेजकर और उसे हटा कर सर्वर के साथ अपना स्थानीय डेटा सिंक करने की ज़रूरत है.

ऐसे मामलों में, हर कॉल को अलग-अलग भेजने के बजाय, उन्हें एक एचटीटीपी अनुरोध में ग्रुप किया जा सकता है. सभी अंदरूनी अनुरोध एक ही Google API को जाने चाहिए.

एक साथ कई अनुरोधों को ज़्यादा से ज़्यादा 1,000 कॉल किया जा सकता है. अगर आपको इससे ज़्यादा कॉल करने हैं, तो एक से ज़्यादा बैच रिक्वेस्ट का इस्तेमाल करें.

ध्यान दें: Admin SDK API का बैच सिस्टम, OData बैच प्रोसेसिंग सिस्टम वाले सिंटैक्स का इस्तेमाल करता है. हालांकि, दोनों के सिमेंटिक अलग-अलग होते हैं.

बैच की जानकारी

एक साथ भेजे जाने वाले अनुरोध में कई एपीआई कॉल शामिल होते हैं, जिन्हें एक एचटीटीपी अनुरोध में जोड़ा जाता है. इसे एपीआई डिस्कवरी दस्तावेज़ में बताए गए batchPath पर भेजा जा सकता है. डिफ़ॉल्ट पाथ /batch/api_name/api_version है. इस सेक्शन में बैच सिंटैक्स के बारे में पूरी जानकारी दी गई है. बाद में, इसका एक उदाहरण है.

ध्यान दें: एक साथ बैच किए गए n अनुरोधों के सेट को, इस्तेमाल करने की आपकी सीमा में n अनुरोधों के तौर पर गिना जाता है, न कि एक अनुरोध के तौर पर. प्रोसेस करने से पहले, एक साथ कई अनुरोध को अनुरोधों के सेट में अलग कर दिया जाता है.

बैच अनुरोध का फ़ॉर्मैट

बैच अनुरोध, एक स्टैंडर्ड एचटीटीपी अनुरोध होता है. इसमें multipart/mixed कॉन्टेंट टाइप का इस्तेमाल करके, कई एडमिन SDK टूल एपीआई कॉल शामिल होते हैं. उस मुख्य एचटीटीपी अनुरोध में, हर हिस्से में एक नेस्ट किया गया एचटीटीपी अनुरोध होता है.

हर हिस्सा अपने Content-Type: application/http एचटीटीपी हेडर से शुरू होता है. इसमें एक वैकल्पिक Content-ID हेडर भी हो सकता है. हालांकि, पार्ट हेडर सिर्फ़ हिस्से की शुरुआत को मार्क करने के लिए होते हैं; वे नेस्ट किए गए अनुरोध से अलग होते हैं. जब सर्वर बैच अनुरोध को अलग-अलग अनुरोधों में खोल देता है, तो पार्ट हेडर को अनदेखा कर दिया जाता है.

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

Content-Type जैसे Content- हेडर को छोड़कर, आउटर बैच अनुरोध के एचटीटीपी हेडर, बैच में हर अनुरोध पर लागू होते हैं. अगर किसी एचटीटीपी हेडर को आउटर अनुरोध और व्यक्तिगत कॉल, दोनों में सेट किया जाता है, तो अलग-अलग कॉल हेडर की वैल्यू, आउटर बैच अनुरोध के हेडर की वैल्यू को बदल देती है. किसी एक कॉल के हेडर सिर्फ़ उस कॉल पर लागू होते हैं.

उदाहरण के लिए, अगर किसी खास कॉल के लिए 'ऑथराइज़ेशन' हेडर दिया जाता है, तो वह हेडर सिर्फ़ उस कॉल पर लागू होता है. अगर बाहरी अनुरोध के लिए ऑथराइज़ेशन हेडर दिया जाता है, तो वह हेडर सभी अलग-अलग कॉल पर तब तक लागू होता है, जब तक वे उसे अपने ऑथराइज़ेशन हेडर से नहीं बदलते.

जब सर्वर को बैच किया गया अनुरोध मिलता है, तो वह हर हिस्से पर बाहरी अनुरोध के क्वेरी पैरामीटर और हेडर (जो भी ठीक हो) लागू करता है. इसके बाद, वह हर हिस्से को इस तरह से देखता है जैसे वह कोई अलग एचटीटीपी अनुरोध हो.

बैच में किए गए अनुरोध का जवाब

सर्वर से मिलने वाला रिस्पॉन्स, multipart/mixed कॉन्टेंट टाइप वाला एक स्टैंडर्ड एचटीटीपी रिस्पॉन्स होता है. हर हिस्सा, बैच में भेजे गए अनुरोध में से किसी एक अनुरोध का जवाब होता है. यह रिस्पॉन्स, अनुरोध की तरह ही होता है.

अनुरोध के हिस्सों की तरह, जवाब के हर हिस्से में पूरा एचटीटीपी रिस्पॉन्स होता है. इसमें स्टेटस कोड, हेडर, और मुख्य हिस्सा शामिल है. अनुरोध के हिस्सों की तरह, जवाब के हर हिस्से से पहले एक Content-Type हेडर होता है. यह हेडर, हिस्से की शुरुआत का निशान होता है.

अगर अनुरोध के किसी हिस्से में Content-ID हेडर है, तो रिस्पॉन्स के संबंधित हिस्से का हेडर मेल खाने वाला Content-ID होगा, जिसमें स्ट्रिंग response- से पहले आने वाली ओरिजनल वैल्यू होगी, जैसा कि यहां दिए गए उदाहरण में दिखाया गया है.

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

उदाहरण

नीचे दिए गए उदाहरण में, Admin SDK API की मदद से बैच बनाने की सुविधा के इस्तेमाल के बारे में बताया गया है.

बैच अनुरोध का उदाहरण


/*This example uses comments and variables for clarity.*/
/*These are not used in JSON. Do not include these comments or verbatim*/
/*variable strings in your batch request.*/
/*To batch multiple requests in one call, use the following*/
/*                                                         */
/*POST HTTP request, and use the following request body syntax.*/
/*                                                  */
/*POST https://www.googleapis.com/batch*/

--batch_foobar--

बैच में दिए गए जवाब का उदाहरण

यह पिछले सेक्शन में उदाहरण के तौर पर दिए गए अनुरोध का जवाब है.

HTTP/1.1 200
Content-Length: response_total_content_length
Content-Type: multipart/mixed; boundary=batch_foobarbaz

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item1:12930812@barnyard.example.com>

HTTP/1.1 200 OK
Content-Type application/json
Content-Length: response_part_1_content_length
ETag: "etag/pony"

{
  "kind": "farm#animal",
  "etag": "etag/pony",
  "selfLink": "/farm/v1/animals/pony",
  "animalName": "pony",
  "animalAge": 34,
  "peltColor": "white"
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item2:12930812@barnyard.example.com>

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: response_part_2_content_length
ETag: "etag/sheep"

{
  "kind": "farm#animal",
  "etag": "etag/sheep",
  "selfLink": "/farm/v1/animals/sheep",
  "animalName": "sheep",
  "animalAge": 5,
  "peltColor": "green"
}

--batch_foobarbaz
Content-Type: application/http
Content-ID: <response-item3:12930812@barnyard.example.com>

HTTP/1.1 304 Not Modified
ETag: "etag/animals"

--batch_foobarbaz--