Play Games Services Publishing API की मदद से इमेज अपलोड करना

इस्तेमाल नहीं किया जाता: इस एपीआई का इस्तेमाल नहीं किया जाता और इसे हटाया जा रहा है. इसलिए, आपको इसका इस्तेमाल नहीं करना चाहिए. इस एपीआई का इस्तेमाल करने पर गड़बड़ियां होती हैं.

Play Games Services Publishing API की मदद से, किसी गेम रिसॉर्स के लिए इमेज अपलोड की जा सकती है.

फ़ाइल अपलोड करने के विकल्प

Play Games Services Publishing API की मदद से, कुछ तरह का बाइनरी डेटा या मीडिया अपलोड किया जा सकता है. अपलोड किए जा सकने वाले डेटा की खास बातों के बारे में, मीडिया अपलोड करने की सुविधा देने वाले किसी भी तरीके के रेफ़रंस पेज पर बताया गया है:

• अपलोड की जाने वाली फ़ाइल का ज़्यादा से ज़्यादा साइज़: इस तरीके से ज़्यादा से ज़्यादा इतना डेटा स्टोर किया जा सकता है.

• स्वीकार किए गए मीडिया MIME टाइप: इस तरीके का इस्तेमाल करके, किस तरह का बाइनरी डेटा सेव किया जा सकता है.

इनमें से किसी भी तरीके से, अपलोड करने के अनुरोध किए जा सकते हैं. uploadType अनुरोध पैरामीटर के साथ, इस्तेमाल किया जा रहा तरीका बताएं.

• आसानी से अपलोड करना: uploadType=media. छोटी फ़ाइलों को तेज़ी से ट्रांसफ़र करने के लिए. उदाहरण के लिए, 5 एमबी या इससे कम साइज़ की फ़ाइलें.

• कई हिस्सों में अपलोड करना: uploadType=multipart. छोटी फ़ाइलों और मेटाडेटा को तेज़ी से ट्रांसफ़र करने के लिए; यह फ़ाइल को उसके बारे में बताने वाले मेटाडेटा के साथ ट्रांसफ़र करता है. यह सब एक ही अनुरोध में होता है.

• फिर से शुरू किया जा सकने वाला अपलोड: uploadType=resumable. भरोसेमंद तरीके से डेटा ट्रांसफ़र करने के लिए, खास तौर पर बड़ी फ़ाइलों के लिए यह ज़रूरी है. इस तरीके में, सेशन शुरू करने के अनुरोध का इस्तेमाल किया जाता है. इसमें मेटाडेटा शामिल किया जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है. यह रणनीति ज़्यादातर ऐप्लिकेशन के लिए अच्छी है. ऐसा इसलिए, क्योंकि यह छोटी फ़ाइलों के लिए भी काम करती है. हालांकि, इसके लिए हर अपलोड पर एक अतिरिक्त एचटीटीपी अनुरोध करना पड़ता है.

मीडिया अपलोड करते समय, एक खास यूआरआई का इस्तेमाल किया जाता है. असल में, मीडिया अपलोड करने की सुविधा देने वाले तरीकों में दो यूआरआई एंडपॉइंट होते हैं:

• मीडिया के लिए /upload यूआरआई. अपलोड एंडपॉइंट का फ़ॉर्मैट, “/upload” प्रीफ़िक्स वाला स्टैंडर्ड रिसॉर्स यूआरआई होता है. मीडिया डेटा ट्रांसफ़र करते समय, इस यूआरआई का इस्तेमाल करें.

  उदाहरण: POST /upload/games/v1configuration/images/resourceId/imageType/imageType

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

  उदाहरण: POST /games/v1configuration/images/resourceId/imageType/imageType

आसानी से अपलोड करना

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

• अगर कनेक्शन काम नहीं करता है, तो पूरी फ़ाइल को फिर से अपलोड किया जा सकता है.

• भेजने के लिए कोई मेटाडेटा नहीं है. अगर आपको इस संसाधन के लिए मेटाडेटा को किसी अलग अनुरोध में भेजना है या कोई मेटाडेटा काम नहीं करता है या उपलब्ध नहीं है, तो ऐसा हो सकता है. सामान्य अपलोड का इस्तेमाल करने के लिए, /upload यूआरआई पर POST या PUT अनुरोध करें. साथ ही, क्वेरी पैरामीटर uploadType=media जोड़ें. उदाहरण के लिए:

POST https://www.googleapis.com/upload/games/v1configuration/images/resourceId/imageType/imageType?uploadType=media

सामान्य अपलोड अनुरोध करते समय इस्तेमाल किए जाने वाले एचटीटीपी हेडर में ये शामिल हैं:

• Content-Type. इसे अपलोड किए जा सकने वाले मीडिया डेटा टाइप में से किसी एक पर सेट करें. ये टाइप, Publishing API के रेफ़रंस में दिए गए हैं.

• Content-Length. इसे अपलोड किए जा रहे बाइट की संख्या पर सेट करें. अगर चंक किए गए ट्रांसफ़र एन्कोडिंग का इस्तेमाल किया जा रहा है, तो इसकी ज़रूरत नहीं है.

उदाहरण: सामान्य अपलोड

इस उदाहरण में, Play की गेम सेवाओं को पब्लिश करने वाले एपीआई के लिए, अपलोड करने के सामान्य अनुरोध का इस्तेमाल दिखाया गया है.

POST /upload/games/v1configuration/images/resourceId/imageType/imageType?uploadType=media HTTP/1.1
Host: www.googleapis.com
Content-Type: image/png
Content-Length: number_of_bytes_in_file
Authorization: Bearer your_auth_token

PNG data

अनुरोध पूरा होने पर, सर्वर एचटीटीपी 200 OK स्टेटस कोड के साथ-साथ कोई भी मेटाडेटा दिखाता है. उदाहरण के लिए:

HTTP/1.1 200
Content-Type: application/json

{
  "kind": "gamesConfiguration#imageConfiguration",
  "url": string,
  "resourceId": string,
  "imageType": string
}

मल्टीपार्ट अपलोड

अगर आपको अपलोड किए जाने वाले डेटा के साथ मेटाडेटा भी भेजना है, तो multipart/related का एक ही अनुरोध किया जा सकता है. अगर भेजा जा रहा डेटा इतना छोटा है कि कनेक्शन फ़ेल होने पर उसे फिर से पूरी तरह से अपलोड किया जा सकता है, तो यह विकल्प सबसे सही है.

मल्टीपार्ट अपलोड का इस्तेमाल करने के लिए, POST या PUT तरीके के /upload यूआरआई को अनुरोध करें और क्वेरी पैरामीटर uploadType=multipart जोड़ें. उदाहरण के लिए:

POST https://www.googleapis.com/upload/games/v1configuration/images/resourceId/imageType/imageType?uploadType=multipart

कई हिस्सों में अपलोड करने का अनुरोध करते समय, टॉप-लेवल के इन एचटीटीपी हेडर का इस्तेमाल किया जा सकता है:

-Content-Type. इसे multipart/related पर सेट करें. साथ ही, वह बाउंड्री स्ट्रिंग शामिल करें जिसका इस्तेमाल अनुरोध के हिस्सों की पहचान करने के लिए किया जा रहा है.

-Content-Length. इसे अनुरोध के मुख्य हिस्से में मौजूद बाइट की कुल संख्या पर सेट करें. अनुरोध का मीडिया हिस्सा, इस तरीके के लिए तय किए गए ज़्यादा से ज़्यादा फ़ाइल साइज़ से कम होना चाहिए.

अनुरोध के मुख्य हिस्से को multipart/related कॉन्टेंट टाइप RFC2387 के तौर पर फ़ॉर्मैट किया गया है. इसमें सिर्फ़ दो हिस्से शामिल हैं. इन हिस्सों की पहचान बाउंड्री स्ट्रिंग से की जाती है. साथ ही, आखिरी बाउंड्री स्ट्रिंग के बाद दो हाइफ़न होते हैं.

एक से ज़्यादा हिस्सों वाले अनुरोध के हर हिस्से के लिए, एक और Content-Type हेडर की ज़रूरत होती है:

• मेटाडेटा वाला हिस्सा: यह सबसे पहले होना चाहिए. साथ ही, Content-Type, स्वीकार किए गए मेटाडेटा फ़ॉर्मैट में से किसी एक से मेल खाना चाहिए.

• मीडिया पार्ट: यह दूसरा होना चाहिए. साथ ही, इसका कॉन्टेंट टाइप, तरीके के लिए स्वीकार किए गए मीडिया MIME टाइप में से किसी एक से मेल खाना चाहिए.

हर तरीके के लिए, स्वीकार किए जाने वाले मीडिया MIME टाइप और अपलोड की गई फ़ाइलों के साइज़ की सीमा की सूची देखने के लिए, Publishing API रेफ़रंस देखें.

ध्यान दें: अगर आपको सिर्फ़ मेटाडेटा बनाना या अपडेट करना है और उससे जुड़ा डेटा अपलोड नहीं करना है, तो स्टैंडर्ड रिसोर्स एंडपॉइंट को POST या PUT अनुरोध भेजें: https://www.googleapis.com/games/v1configuration/images/resourceId/imageType/imageType

उदाहरण: मल्टीपार्ट अपलोड

यहां दिए गए उदाहरण में, Play Games Services Publishing API के लिए, कई हिस्सों में अपलोड करने का अनुरोध दिखाया गया है.

POST /upload/games/v1configuration/images/resourceId/imageType/imageType?uploadType=multipart HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer your_auth_token
Content-Type: multipart/related; boundary=foo_bar_baz
Content-Length: number_of_bytes_in_entire_request_body

--foo_bar_baz
Content-Type: application/json; charset=UTF-8

{
  "kind": "gamesConfiguration#imageConfiguration",
  "url": string,
  "resourceId": string,
  "imageType": string
}

--foo_bar_baz
Content-Type: image/png

PNG data
--foo_bar_baz--

अनुरोध पूरा होने पर, सर्वर एचटीटीपी 200 OK स्टेटस कोड के साथ-साथ कोई भी मेटाडेटा दिखाता है:

HTTP/1.1 200
Content-Type: application/json

{
  "kind": "gamesConfiguration#imageConfiguration",
  "url": string,
  "resourceId": string,
  "imageType": string
}

फिर से अपलोड किया जा सकता है

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

फिर से शुरू किए जा सकने वाले अपलोड का इस्तेमाल करने के लिए, यह तरीका अपनाएं:

1. फिर से शुरू किया जा सकने वाला सेशन शुरू करें. अपलोड यूआरआई को शुरुआती अनुरोध भेजें. इसमें मेटाडेटा शामिल करें.

2. फिर से शुरू किए जा सकने वाले सेशन का यूआरआई सेव करें. शुरुआती अनुरोध के जवाब में मिले सेशन यूआरआई को सेव करें. इस सेशन में बाकी अनुरोधों के लिए, इसका इस्तेमाल किया जाएगा. फ़ाइल अपलोड करें.

3. मीडिया फ़ाइल को फिर से शुरू किए जा सकने वाले सेशन के यूआरआई पर भेजें.

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

ध्यान दें: अपलोड यूआरआई की समयसीमा एक हफ़्ते के बाद खत्म हो जाती है.

फिर से शुरू किया जा सकने वाला सेशन शुरू करना

फिर से शुरू किए जा सकने वाले अपलोड की प्रोसेस शुरू करने के लिए, POST या PUT तरीके के /upload यूआरआई को POST या PUT अनुरोध करें. साथ ही, क्वेरी पैरामीटर uploadType=resumable जोड़ें. उदाहरण के लिए:

POST https://www.googleapis.com/upload/games/v1configuration/images/resourceId/imageType/imageType?uploadType=resumable

इस शुरुआती अनुरोध के मुख्य भाग में, मेटाडेटा के अलावा कोई और डेटा नहीं होता या यह खाली होता है. आपको जिस फ़ाइल को अपलोड करना है उसका कॉन्टेंट, आने वाले अनुरोधों में ट्रांसफ़र करना होगा.

शुरुआती अनुरोध के साथ इन एचटीटीपी हेडर का इस्तेमाल करें:

• X-Upload-Content-Type. इसे अपलोड किए जाने वाले डेटा के मीडिया MIME टाइप पर सेट किया जाता है, ताकि इसे आने वाले अनुरोधों में ट्रांसफ़र किया जा सके.

• X-Upload-Content-Length. इसे अपलोड किए जाने वाले डेटा के बाइट की संख्या पर सेट किया जाता है. इस डेटा को आने वाले अनुरोधों में ट्रांसफ़र किया जाता है. अगर इस अनुरोध के समय लंबाई की जानकारी नहीं है, तो इस हेडर को हटाया जा सकता है.

• मेटाडेटा उपलब्ध कराने पर: Content-Type. मेटाडेटा के डेटा टाइप के हिसाब से सेट किया जाता है.

• Content-Length. इसे शुरुआती अनुरोध के मुख्य हिस्से में दिए गए बाइट की संख्या पर सेट किया जाता है. अगर chunked transfer encoding का इस्तेमाल किया जा रहा है, तो इसकी ज़रूरत नहीं है.

हर तरीके के लिए, स्वीकार किए गए मीडिया MIME टाइप और अपलोड की गई फ़ाइलों के साइज़ की सीमा की सूची देखने के लिए, Publishing API रेफ़रंस देखें.

उदाहरण: फिर से शुरू किए जा सकने वाले सेशन को शुरू करने का अनुरोध

यहां दिए गए उदाहरण में, Play Games Services Publishing API के लिए फिर से शुरू किए जा सकने वाले सेशन को शुरू करने का तरीका बताया गया है.

POST /upload/games/v1configuration/images/resourceId/imageType/imageType?uploadType=resumable HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer your_auth_token
Content-Length: 38
Content-Type: application/json; charset=UTF-8
X-Upload-Content-Type: image/png
X-Upload-Content-Length: 2000000

{
  "kind": "gamesConfiguration#imageConfiguration",
  "url": string,
  "resourceId": string,
  "imageType": string
}

ध्यान दें: मेटाडेटा के बिना, फिर से शुरू किए जा सकने वाले अपडेट के शुरुआती अनुरोध के लिए, अनुरोध का मुख्य हिस्सा खाली छोड़ दें. साथ ही, Content-Length हेडर को 0 पर सेट करें.

अगले सेक्शन में, जवाब को मैनेज करने का तरीका बताया गया है.

इस कुकी का इस्तेमाल, फिर से शुरू किए जा सकने वाले सेशन के यूआरआई को सेव करने के लिए किया जाता है

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

उदाहरण: सेशन को फिर से शुरू करने के लिए दिया गया जवाब

पहले चरण में किए गए अनुरोध का जवाब यहां दिया गया है:

HTTP/1.1 200 OK
Location: https://www.googleapis.com/upload/games/v1configuration/images/resourceId/imageType/imageType?uploadType=resumable&upload_id=xa298sd_sdlkj2
Content-Length: 0

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

सेशन यूआरआई को कॉपी करें और सेव करें, ताकि इसका इस्तेमाल बाद के अनुरोधों के लिए किया जा सके.

फ़ाइल अपलोड करना

फ़ाइल अपलोड करने के लिए, पिछले चरण में मिले अपलोड यूआरआई को PUT अनुरोध भेजें. अपलोड करने के अनुरोध का फ़ॉर्मैट यह है:

PUT session_uri

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

उदाहरण: फ़ाइल अपलोड करने के अनुरोध को फिर से शुरू किया जा सकता है

यहां मौजूदा उदाहरण के लिए, पूरी 20,00,000 बाइट की PNG फ़ाइल अपलोड करने का फिर से शुरू किया जा सकने वाला अनुरोध दिया गया है.

PUT https://www.googleapis.com/upload/games/v1configuration/images/resourceId/imageType/imageType?uploadType=resumable&upload_id=xa298sd_sdlkj2 HTTP/1.1
Content-Length: 2000000
Content-Type: image/png

bytes 0-1999999

अनुरोध पूरा होने पर, सर्वर HTTP 201 Created के साथ-साथ इस संसाधन से जुड़ा कोई भी मेटाडेटा भेजता है. अगर फिर से शुरू किए जा सकने वाले सेशन का शुरुआती अनुरोध, किसी मौजूदा संसाधन को अपडेट करने के लिए PUT था, तो अनुरोध पूरा होने पर मिलने वाला जवाब 200 OK होगा. साथ ही, इस संसाधन से जुड़ा कोई भी मेटाडेटा भी मिलेगा.

अगर अपलोड करने के अनुरोध में रुकावट आती है या आपको सर्वर से HTTP 503 Service Unavailable या कोई अन्य 5xx जवाब मिलता है, तो अपलोड करने की प्रोसेस फिर से शुरू करें में बताई गई प्रक्रिया का पालन करें.

फ़ाइल को छोटे-छोटे हिस्सों में अपलोड करें

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

अगर डेटा को हिस्सों में अपलोड किया जा रहा है, तो Content-Range हेडर भी ज़रूरी है. साथ ही, पूरी फ़ाइल अपलोड करने के लिए Content-Length हेडर भी ज़रूरी है:

• Content-Length. इसे चंक के साइज़ पर सेट करें या हो सकता है कि यह इससे कम हो. ऐसा आखिरी अनुरोध के मामले में हो सकता है.

• Content-Range. इससे यह पता चलता है कि अपलोड की जा रही फ़ाइल में कितने बाइट हैं. उदाहरण के लिए, Content-Range: bytes 0-524287/2000000 से पता चलता है कि 2,000,000 बाइट की फ़ाइल में, पहले 524,288 बाइट (256 x 1024 x 2) दिए जा रहे हैं.

ध्यान दें: अपलोड किए जाने वाले सभी चंक का साइज़ 256 केबी (256 x 1024 बाइट) का मल्टीपल होना चाहिए. हालांकि, अपलोड पूरा करने वाले आखिरी चंक के लिए यह ज़रूरी नहीं है. अगर चंकिंग का इस्तेमाल किया जाता है, तो अपलोड को बेहतर बनाने के लिए, चंक का साइज़ ज़्यादा से ज़्यादा रखना ज़रूरी है.

ज़्यादा जानकारी के लिए विस्तृत करें

अगर डेटा को हिस्सों में अपलोड किया जा रहा है, तो Content-Range हेडर भी ज़रूरी है. साथ ही, पूरी फ़ाइल अपलोड करने के लिए Content-Length हेडर भी ज़रूरी है:

• Content-Length. इसे चंक के साइज़ पर सेट करें या हो सकता है कि यह इससे कम हो. ऐसा आखिरी अनुरोध के मामले में हो सकता है.
• Content-Range: इससे यह पता चलता है कि अपलोड की जा रही फ़ाइल में कौनसे बाइट हैं.  उदाहरण के लिए, Content-Range: bytes 0-524287/2000000 से पता चलता है कि 2,000,000 बाइट की फ़ाइल में, पहले 524,288 बाइट (256 x 1024 x 2) दिए जा रहे हैं.

चंक के साइज़ से जुड़ी पाबंदी: अपलोड किए जाने वाले सभी चंक का साइज़ 256 केबी (256 x 1024 बाइट) का मल्टीपल होना चाहिए. हालांकि, अपलोड पूरा करने वाले आखिरी चंक पर यह पाबंदी लागू नहीं होती. अगर चंकिंग का इस्तेमाल किया जाता है, तो अपलोड को बेहतर बनाए रखने के लिए, चंक का साइज़ जितना हो सके उतना बड़ा रखें.

उदाहरण: फिर से शुरू किए जा सकने वाले, छोटे-छोटे हिस्सों में बंटी फ़ाइल को अपलोड करने का अनुरोध

पहले 5,24,288 बाइट भेजने वाला अनुरोध ऐसा दिख सकता है:

PUT {session_uri} HTTP/1.1
Host: www.googleapis.com
Content-Length: 524288
Content-Type: image/jpeg
Content-Range: bytes 0-524287/2000000

bytes 0-524288

अनुरोध पूरा होने पर, सर्वर 308 Resume Incomplete के साथ जवाब देता है. साथ ही, Range हेडर भी देता है. इससे पता चलता है कि अब तक कुल कितने बाइट सेव किए गए हैं:

HTTP/1.1 308 Resume Incomplete
Content-Length: 0
Range: bytes=0-524287

Range हेडर में दिखाई गई ऊपरी वैल्यू का इस्तेमाल करके, यह तय करें कि अगला हिस्सा कहां से शुरू करना है. जब तक पूरी फ़ाइल अपलोड नहीं हो जाती, तब तक फ़ाइल के हर हिस्से को PUT करते रहें.

अगर किसी चंक के PUT अनुरोध में रुकावट आती है या आपको सर्वर से एचटीटीपी 503 Service Unavailable या कोई अन्य 5xx रिस्पॉन्स मिलता है, तो अधूरे अपलोड को फिर से शुरू करें में बताई गई प्रोसेस को फ़ॉलो करें. हालांकि, फ़ाइल के बाकी हिस्से को अपलोड करने के बजाय, उस पॉइंट से चंक अपलोड करना जारी रखें.

अहम जानकारी:

• यह पक्का करें कि रिस्पॉन्स में Range हेडर का इस्तेमाल किया गया हो, ताकि यह तय किया जा सके कि अगला हिस्सा कहां से शुरू करना है. यह न मान लें कि सर्वर को पिछले अनुरोध में भेजे गए सभी बाइट मिल गए हैं.
• हर अपलोड यूआरआई की एक तय समयसीमा होती है. इस समयसीमा के खत्म होने के बाद, यूआरआई का इस्तेमाल नहीं किया जा सकता. अगर यूआरआई का इस्तेमाल नहीं किया जाता है, तो यह एक दिन के अंदर खत्म हो जाता है. इसलिए, अपलोड यूआरआई मिलते ही फिर से शुरू किए जा सकने वाले अपलोड की प्रोसेस शुरू कर दें. साथ ही, अपलोड में रुकावट आने के तुरंत बाद, उसे फिर से शुरू करें.
• अगर आपने अपलोड किए गए सेशन के ऐसे आईडी के साथ अनुरोध भेजा है जिसकी समयसीमा खत्म हो चुकी है, तो सर्वर 404 Not Found स्टेटस कोड दिखाता है. अपलोड सेशन में ऐसी गड़बड़ी होने पर जिसे ठीक नहीं किया जा सकता, सर्वर 410 Gone स्टेटस कोड दिखाता है. ऐसे मामलों में, आपको फिर से शुरू किए जा सकने वाले अपलोड की नई प्रोसेस शुरू करनी होगी. साथ ही, नया अपलोड यूआरआई पाना होगा. इसके बाद, नए एंडपॉइंट का इस्तेमाल करके, अपलोड की प्रोसेस शुरू से शुरू करनी होगी.

पूरी फ़ाइल अपलोड हो जाने पर, सर्वर इस संसाधन से जुड़े किसी भी मेटाडेटा के साथ HTTP 201 Created दिखाता है. अगर इस अनुरोध से नई इकाई बनाने के बजाय किसी मौजूदा इकाई को अपडेट किया जा रहा होता, तो अपलोड पूरा होने पर एचटीटीपी रिस्पॉन्स कोड 200 OK होता.

अपलोड होने की प्रक्रिया बीच में रुक जाने पर उसे फिर से शुरू करना

अगर अपलोड करने का अनुरोध, जवाब मिलने से पहले ही बंद हो जाता है या आपको सर्वर से HTTP 503 Service Unavailable जवाब मिलता है, तो आपको अपलोड करने की प्रोसेस फिर से शुरू करनी होगी. अपलोड करने की प्रोसेस में रुकावट आने पर, उसे फिर से शुरू करने के लिए यह तरीका अपनाएं:

1. अनुरोध की स्थिति. अपलोड के मौजूदा स्टेटस के बारे में जानने के लिए, अपलोड यूआरआई को खाली PUT अनुरोध भेजें. इस अनुरोध के लिए, एचटीटीपी हेडर में Content-Range हेडर शामिल होना चाहिए. इससे पता चलता है कि फ़ाइल में मौजूदा पोज़िशन के बारे में जानकारी नहीं है. उदाहरण के लिए, अगर आपकी फ़ाइल की कुल लंबाई 20,00,000 है, तो Content-Range को */2000000 पर सेट करें. अगर आपको फ़ाइल के पूरे साइज़ के बारे में नहीं पता है, तो Content-Range को */* पर सेट करें.

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

2. अपलोड किए गए बाइट की संख्या पाएं. स्टेटस क्वेरी से मिले जवाब को प्रोसेस करें. सर्वर, अपने जवाब में Range हेडर का इस्तेमाल करता है. इससे यह पता चलता है कि उसे अब तक कौनसे बाइट मिले हैं. उदाहरण के लिए, Range हेडर में 0-299999 का मतलब है कि फ़ाइल के पहले 3,00,000 बाइट मिल गए हैं.

3. बचा हुआ डेटा अपलोड करें. आखिर में, अब जब आपको पता चल गया है कि अनुरोध को कहां से फिर से शुरू करना है, तो बचा हुआ डेटा या मौजूदा हिस्सा भेजें. ध्यान दें कि आपको दोनों ही मामलों में, बचे हुए डेटा को अलग हिस्से के तौर पर मानना होगा. इसलिए, अपलोड फिर से शुरू करते समय आपको Content-Range हेडर भेजना होगा.

उदाहरण: अपलोड के दौरान आई रुकावट को ठीक करना

1. अपलोड की स्थिति का अनुरोध करें. इस अनुरोध में Content-Range हेडर का इस्तेमाल किया गया है. इससे पता चलता है कि 20,00,000 बाइट की फ़ाइल में मौजूदा पोज़िशन के बारे में जानकारी नहीं है.

   PUT {session_uri} HTTP/1.1
   Content-Length: 0
   Content-Range: bytes */2000000
   

2. जवाब से, अब तक अपलोड किए गए बाइट की संख्या निकालें. सर्वर का जवाब, Range हेडर का इस्तेमाल करके यह बताता है कि उसे अब तक फ़ाइल के पहले 43 बाइट मिल चुके हैं. अपलोड फिर से शुरू करने के लिए, Range हेडर की ऊपरी वैल्यू का इस्तेमाल करें.

   HTTP/1.1 308 Resume Incomplete
   Content-Length: 0
   Range: 0-42
   

   ध्यान दें: ऐसा हो सकता है कि अपलोड पूरा होने पर, स्टेटस 201बनाया गया या 200 OK के तौर पर दिखे. ऐसा तब हो सकता है, जब सभी बाइट अपलोड होने के बाद कनेक्शन टूट गया हो. हालांकि, ऐसा तब हुआ हो, जब क्लाइंट को सर्वर से जवाब नहीं मिला हो.

3. अपलोड करने की प्रोसेस को वहीं से फिर से शुरू करें जहां वह रुकी थी. यहां दिया गया अनुरोध, फ़ाइल के बाकी बाइट भेजकर अपलोड करने की प्रोसेस को फिर से शुरू करता है. यह बाइट 43 से शुरू होती है.

   PUT {session_uri} HTTP/1.1
   Content-Length: 1999957
   Content-Range: bytes 43-1999999/2000000
   
   bytes 43-1999999
   

गड़बड़ी ठीक करना

मीडिया अपलोड करते समय, गड़बड़ी ठीक करने से जुड़े कुछ सबसे सही तरीकों के बारे में जानना फ़ायदेमंद होता है.

• कनेक्शन में रुकावट या 5xx गड़बड़ियों की वजह से अपलोड नहीं हो पाने वाली फ़ाइलों को फिर से अपलोड करें या अपलोड करने की कोशिश करें. इनमें ये गड़बड़ियां शामिल हैं:

  • 500 Internal Server Error
  • 502 Bad Gateway
  • 503 Service Unavailable
  • 504 Gateway Timeout

• अगर अपलोड करने के अनुरोधों को फिर से शुरू करते समय या फिर से कोशिश करते समय, कोई 5xx सर्वर की गड़बड़ी दिखती है, तो एक्सपोनेंशियल बैकऑफ़ रणनीति का इस्तेमाल करें. अगर सर्वर पर बहुत ज़्यादा लोड है, तो ये गड़बड़ियां हो सकती हैं. एक्सपोनेंशियल बैकऑफ़ की मदद से, अनुरोधों की ज़्यादा संख्या या नेटवर्क ट्रैफ़िक ज़्यादा होने के दौरान, इस तरह की समस्याओं को कम किया जा सकता है.

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

• अपलोड फिर से शुरू करने की सुविधा का इस्तेमाल करते समय, 404 Not Found और 410 Gone गड़बड़ियों को ठीक करें. इसके लिए, पूरे अपलोड को शुरू से शुरू करें.

एक्स्पोनेंशियल बैकऑफ़

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

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

आसान एक्स्पोनेंशियल बैकऑफ़ को लागू करने का तरीका यहां दिया गया है:

1. एपीआई से अनुरोध करें.
2. आपको HTTP 503 जवाब मिलता है. इसका मतलब है कि आपको अनुरोध फिर से करना चाहिए.
3. एक सेकंड + random_number_milliseconds इंतज़ार करें और फिर से अनुरोध करें.
4. आपको HTTP 503 जवाब मिलता है. इसका मतलब है कि आपको अनुरोध फिर से करना चाहिए.
5. दो सेकंड + random_number_milliseconds इंतज़ार करने के बाद, अनुरोध को फिर से भेजें.
6. आपको HTTP 503 जवाब मिलता है. इसका मतलब है कि आपको अनुरोध फिर से करना चाहिए.
7. चार सेकंड + random_number_milliseconds इंतज़ार करने के बाद, अनुरोध को फिर से भेजें.
8. आपको HTTP 503 response मिलेगा. इससे पता चलेगा कि आपको अनुरोध फिर से करना चाहिए.
9. आठ सेकंड + random_number_milliseconds इंतज़ार करें और फिर से अनुरोध करें.
10. आपको HTTP 503 response मिलेगा. इससे पता चलेगा कि आपको अनुरोध फिर से करना चाहिए.
11. 16 सेकंड + random_number_milliseconds इंतज़ार करें और फिर से अनुरोध करें.
12. बंद करो। किसी गड़बड़ी की शिकायत करें या उसे लॉग करें.

ऊपर दी गई सूची में, random_number_milliseconds, 1000 से कम या उसके बराबर मिलीसेकंड की कोई रैंडम संख्या है. यह ज़रूरी है, क्योंकि कुछ समय के लिए रैंडम डिले करने से, लोड को ज़्यादा बराबर तरीके से डिस्ट्रिब्यूट करने में मदद मिलती है. साथ ही, सर्वर पर ज़्यादा लोड पड़ने की संभावना से बचा जा सकता है. हर बार इंतज़ार करने के बाद, random_number_milliseconds की वैल्यू को फिर से तय करना होगा.

ध्यान दें: इंतज़ार का समय हमेशा (2 ^ n) + random_number_milliseconds होता है. इसमें n, क्रम के हिसाब से बढ़ने वाला पूर्णांक होता है, जिसे शुरू में 0 के तौर पर तय किया जाता है. हर अनुरोध के लिए, पूर्णांक n में 1 की बढ़ोतरी की जाती है.

एल्गोरिदम को तब बंद करने के लिए सेट किया गया है, जब n की वैल्यू 5 हो. इस सीमा की वजह से, क्लाइंट बार-बार अनुरोध नहीं कर पाते. साथ ही, अनुरोध को "ठीक न की जा सकने वाली गड़बड़ी" के तौर पर मार्क करने से पहले, कुल 32 सेकंड की देरी होती है. अपलोड करने की कोशिशों की संख्या ज़्यादा होने से कोई समस्या नहीं होती. खास तौर पर, तब जब कोई फ़ाइल लंबे समय से अपलोड हो रही हो. हालांकि, यह पक्का करें कि अपलोड करने की कोशिशों के बीच का समय कम हो. जैसे, एक मिनट से कम.

एपीआई क्लाइंट लाइब्रेरी से जुड़ी गाइड

• .NET

• Java

• PHP

• Python

• Ruby