मीडिया आइटम अपलोड करने की प्रोसेस दो चरणों में पूरी होती है:
- uploads endpoint का इस्तेमाल करके, अपनी मीडिया फ़ाइलों के बाइट को Google सर्वर पर अपलोड करें. यह एक अपलोड टोकन दिखाता है, जो अपलोड किए गए बाइट की पहचान करता है.
- उपयोगकर्ता के Google Photos खाते में मीडिया आइटम बनाने के लिए, अपलोड टोकन के साथ batchCreate कॉल का इस्तेमाल करें.
यहां किसी एक मीडिया आइटम को अपलोड करने की प्रोसेस के बारे में बताया गया है. अगर एक से ज़्यादा मीडिया आइटम अपलोड किए जा रहे हैं (किसी भी प्रोडक्शन ऐप्लिकेशन के लिए ऐसा हो सकता है), तो अपलोड की प्रोसेस को बेहतर बनाने के लिए, अपलोड करने के सबसे सही तरीके देखें.
शुरू करने से पहले
अनुमति के लिए ज़रूरी स्कोप
किसी उपयोगकर्ता की लाइब्रेरी या एल्बम में मीडिया आइटम अपलोड करने के लिए, photoslibrary.appendonly
दायरे की ज़रूरत होती है. स्कोप के बारे में ज़्यादा जानने के लिए,
अनुमति के स्कोप देखें.
स्वीकार किए जाने वाले फ़ाइल टाइप और साइज़
इस टेबल में बताए गए फ़ाइल टाइप अपलोड किए जा सकते हैं.
मीडिया टाइप | इस्तेमाल किए जा सकने वाले फ़ाइल टाइप | फ़ाइल का ज़्यादा से ज़्यादा साइज़ |
---|---|---|
फ़ोटो | AVIF, BMP, GIF, HEIC, ICO, JPG, PNG, TIFF, WEBP, और कुछ RAW फ़ाइलें. | 200 एमबी |
वीडियो | 3GP, 3G2, ASF, AVI, DIVX, M2T, M2TS, M4V, MKV, MMV, MOD, MOV, MP4, MPG, MTS, TOD, WMV. | 20 जीबी |
पहला चरण: बाइट अपलोड करना
अपलोड के अनुरोधों का इस्तेमाल करके, Google पर बाइट अपलोड करें. अपलोड करने का अनुरोध पूरा होने पर, आपको रॉ टेक्स्ट स्ट्रिंग के तौर पर अपलोड टोकन मिलता है. batchCreate
कॉल के साथ मीडिया आइटम बनाने के लिए, अपलोड किए गए इन टोकन का इस्तेमाल करें.
REST
POST अनुरोध हेडर में ये फ़ील्ड शामिल करें:
हेडर फ़ील्ड | |
---|---|
Content-type |
application/octet-stream पर सेट करें. |
X-Goog-Upload-Content-Type |
सुझाई गई. अपलोड किए जा रहे बाइट के MIME टाइप पर सेट करें.
आम तौर पर इस्तेमाल होने वाले एमआईएमई टाइप में image/jpeg ,
image/png , और image/gif शामिल हैं.
|
X-Goog-Upload-Protocol |
raw पर सेट करें. |
यहां पीओएसटी अनुरोध का हेडर दिया गया है:
POST https://photoslibrary.googleapis.com/v1/uploads Authorization: Bearer oauth2-token Content-type: application/octet-stream X-Goog-Upload-Content-Type: mime-type X-Goog-Upload-Protocol: raw
अनुरोध के मुख्य हिस्से में, फ़ाइल की बाइनरी शामिल करें:
media-binary-data
अगर यह पोस्ट अनुरोध पूरा होता है, तो अपलोड टोकन, जो
मूल टेक्स्ट स्ट्रिंग के रूप में होता है, रिस्पॉन्स के मुख्य हिस्से के तौर पर दिखाया जाता है. मीडिया आइटम बनाने के लिए, batchCreate
कॉल में इन टेक्स्ट स्ट्रिंग का इस्तेमाल करें.
upload-token
हमारा सुझाव है कि इमेज का साइज़ 50 एमबी से कम हो. 50 एमबी से बड़ी फ़ाइलों में परफ़ॉर्मेंस से जुड़ी समस्याएं आ सकती हैं.
Google Photos Library API, फिर से शुरू किए जा सकने वाले अपलोड के साथ काम करता है. फिर से शुरू किया जा सकने वाला अपलोड, आपको मीडिया फ़ाइल को कई सेक्शन में बांटने और एक बार में एक सेक्शन अपलोड करने की सुविधा देता है.
दूसरा चरण: मीडिया आइटम बनाना
अपनी मीडिया फ़ाइलों के बाइट अपलोड करने के बाद, अपलोड टोकन का इस्तेमाल करके उन्हें Google Photos में मीडिया आइटम के तौर पर बनाया जा सकता है. अपलोड टोकन, बनाए जाने के एक दिन बाद तक मान्य होता है. मीडिया आइटम हमेशा उपयोगकर्ता की लाइब्रेरी में जोड़ा जाता है. मीडिया आइटम, सिर्फ़ आपके ऐप्लिकेशन से बनाए गए एल्बम में जोड़े जा सकते हैं. ज़्यादा जानकारी के लिए, अनुमति के दायरे देखें.
नए मीडिया आइटम बनाने के लिए, newMediaItems
की सूची बताकर mediaItems.batchCreate
को कॉल करें. हर newMediaItem
में एक अपलोड टोकन होता है, जो simpleMediaItem
में बताया गया होता है. साथ ही, इसमें एक वैकल्पिक ब्यौरा होता है, जो उपयोगकर्ता को दिखाया जाता है.
ब्यौरे वाले फ़ील्ड में 1,000 से ज़्यादा वर्ण नहीं होने चाहिए. इसमें सिर्फ़ ऐसा टेक्स्ट होना चाहिए जो उपयोगकर्ताओं के काम का हो. उदाहरण के लिए, "पार्क में हमारी यात्रा" या "छुट्टियों का डिनर". फ़ाइल के नाम, प्रोग्राम के हिसाब से काम करने वाले टैग या अपने-आप जनरेट होने वाला टेक्स्ट जैसे मेटाडेटा शामिल न करें.
बेहतर परफ़ॉर्मेंस के लिए, एक कॉल में कई मीडिया आइटम शामिल करके, mediaItems.batchCreate
को किए जाने वाले कॉल की संख्या कम करें. किसी उपयोगकर्ता के लिए अगला अनुरोध करने से पहले, हमेशा पिछले अनुरोध के पूरा होने का इंतज़ार करें.
उपयोगकर्ता की लाइब्रेरी में एक मीडिया आइटम या कई मीडिया आइटम बनाए जा सकते हैं. इसके लिए, ब्यौरे और अपलोड टोकन की जानकारी दें:
REST
यहां पोस्ट अनुरोध का हेडर दिया गया है:
POST https://photoslibrary.googleapis.com/v1/mediaItems:batchCreate Content-type: application/json Authorization: Bearer oauth2-token
अनुरोध के मुख्य हिस्से में newMediaItems
की सूची होनी चाहिए.
{ "newMediaItems": [ { "description": "item-description", "simpleMediaItem": { "fileName": "filename", "uploadToken": "upload-token" } } , ... ] }
albumId
और albumPosition
का इस्तेमाल करके भी,
मीडिया आइटम को किसी खास जगह पर डाला जा सकता है.
REST
{ "albumId": "album-id", "newMediaItems": [ { "description": "item-description", "simpleMediaItem": { "fileName": "filename", "uploadToken": "upload-token" } } , ... ], "albumPosition": { "position": "after-media-item", "relativeMediaItemId": "media-item-id" } }
एल्बम में पोज़िशनिंग के बारे में ज़्यादा जानकारी के लिए, ज़्यादा जानकारी जोड़ना देखें.
आइटम बनाने के अनुरोध का जवाब
mediaItems.batchCreate
कॉल, उन सभी मीडिया आइटम के लिए नतीजा दिखाता है जिन्हें बनाने की कोशिश की गई थी. newMediaItemResults
की सूची से स्टेटस का पता चलता है. साथ ही, इसमें अनुरोध के लिए uploadToken
शामिल होता है. शून्य के अलावा किसी दूसरे स्टेटस कोड का मतलब है कि
गड़बड़ी हुई है.
REST
अगर सभी मीडिया आइटम बना दिए गए हैं, तो अनुरोध एचटीटीपी स्टेटस 200 OK
दिखाता है. अगर कुछ मीडिया आइटम नहीं बनाए जा सकते, तो अनुरोध, एचटीटीपी स्टेटस 207 MULTI-STATUS
दिखाता है. इससे पता चलता है कि कुछ आइटम बनाए गए हैं.
{ "newMediaItemResults": [ { "uploadToken": "upload-token", "status": { "message": "Success" }, "mediaItem": { "id": "media-item-id", "description": "item-description", "productUrl": "https://photos.google.com/photo/photo-path", "mimeType": "mime-type", "mediaMetadata": { "width": "media-width-in-px", "height": "media-height-in-px", "creationTime": "creation-time", "photo": {} }, "filename": "filename" } }, { "uploadToken": "upload-token", "status": { "code": 13, "message": "Internal error" } } ] }
अगर कोई आइटम जोड़ दिया जाता है, तो एक mediaItem
दिखाया जाता है. इसमें mediaItemId
, productUrl
, और mediaMetadata
शामिल होते हैं. ज़्यादा जानकारी के लिए, मीडिया आइटम ऐक्सेस करना देखें.
अगर मीडिया आइटम कोई वीडियो है, तो उसे पहले प्रोसेस करना होगा. mediaItem
के mediaMetadata
में एक status
होता है, जो वीडियो फ़ाइल की प्रोसेसिंग की स्थिति के बारे में बताता है. नई फ़ाइल अपलोड करने पर, उसे PROCESSING
के तौर पर मार्क किया जाता है. इसके बाद, उसे READY
के तौर पर मार्क किया जाता है, ताकि उसका इस्तेमाल किया जा सके. ज़्यादा जानकारी के लिए, मीडिया आइटम ऐक्सेस करना लेख पढ़ें.
अगर आपको इस कॉल के दौरान कोई गड़बड़ी मिलती है, तो सबसे सही तरीकों का पालन करें और फिर से अनुरोध करें. हो सकता है कि आप जोड़े गए डिवाइसों को ट्रैक करना चाहें, ताकि अगले अनुरोध के दौरान इमेज को सही जगह पर एल्बम में डाला जा सके. ज़्यादा जानकारी के लिए, एल्बम बनाना देखें.
नतीजे हमेशा उसी क्रम में दिखाए जाते हैं जिस क्रम में अपलोड टोकन सबमिट किए गए थे.
वीडियो अपलोड करने के सबसे सही तरीके
यहां दिए गए सबसे सही तरीके और संसाधनों से, अपलोड करने की प्रोसेस को बेहतर बनाने में मदद मिलती है:
- इन बातों को ध्यान में रखते हुए, फिर से कोशिश करने और गड़बड़ी ठीक करने के सबसे सही तरीके अपनाएं:
429
गड़बड़ियां तब हो सकती हैं, जब आपका कोटा खत्म हो गया हो या बहुत तेज़ी से बहुत ज़्यादा कॉल करने की वजह से, आपके लिए कॉल करने की दर सीमित कर दी गई हो. पक्का करें कि जब तक पिछला अनुरोध पूरा नहीं हो जाता, तब तक एक ही उपयोगकर्ता के लिएbatchCreate
को कॉल न करें.429
गड़बड़ियों को ठीक करने के बाद, फिर से कोशिश करने के लिए कम से कम30s
देरी की ज़रूरत होती है. अनुरोधों को फिर से करने की कोशिश करते समय, एक्सपोनेन्शियल बैकऑफ़ वाली रणनीति का इस्तेमाल करें.500
गड़बड़ियां तब होती हैं, जब सर्वर में कोई गड़बड़ी होती है. ऐसा हो सकता है कि वीडियो अपलोड करते समय, एक ही उपयोगकर्ता के लिए एक ही समय पर कई बार कॉल किए जा रहे हों. जैसे,batchCreate
. अपने अनुरोध की जानकारी देखें और एक साथbatchCreate
को कॉल न करें.
- नेटवर्क में आने वाली रुकावटों के मामले में, अपने अपलोड को और बेहतर बनाने के लिए, फिर से शुरू किए जा सकने वाले अपलोड फ़्लो का इस्तेमाल करें. इससे बैंडविथ का इस्तेमाल कम हो जाता है और कुछ हद तक पूरा हो चुका अपलोड फिर से शुरू हो जाता है. यह क्लाइंट के मोबाइल डिवाइस से अपलोड करते समय या बड़ी फ़ाइलें अपलोड करते समय ज़रूरी है.
साथ ही, अपलोड करने की प्रोसेस के हर चरण के लिए, इन सुझावों का पालन करें: बाइट अपलोड करना और फिर मीडिया आइटम बनाना.
बाइट अपलोड की जा रही हैं
- बाइट अपलोड (अपलोड टोकन पाने के लिए) साथ-साथ की जा सकती है.
- हर अपलोड कॉल के लिए,
X-Goog-Upload-Content-Type
हेडर में हमेशा सही MIME टाइप सेट करें.
मीडिया आइटम बनाना
किसी एक उपयोगकर्ता के लिए
batchCreate
के साथ-साथ कॉल न करें.- हर उपयोगकर्ता के लिए,
batchCreate
को एक के बाद एक कॉल करें (सीरियल में). - एक से ज़्यादा उपयोगकर्ताओं के लिए, हर उपयोगकर्ता के लिए एक के बाद एक
batchCreate
कॉल करें. साथ-साथ सिर्फ़ अलग-अलग उपयोगकर्ताओं के लिए कॉल करें.
- हर उपयोगकर्ता के लिए,
batchCreate
को किए जाने वाले हर कॉल में, ज़्यादा से ज़्यादाNewMediaItems
शामिल करें, ताकि आपको कम से कम कॉल करने पड़ें. ज़्यादा से ज़्यादा 50 आइटम शामिल किए जा सकते हैं.आपके उपयोगकर्ताओं ने जो ब्यौरा लिखा है उसे सेट करें. ब्यौरे वाले फ़ील्ड में, मेटाडेटा शामिल न करें. जैसे, फ़ाइल का नाम, प्रोग्रामैटिक टैग या अपने-आप जनरेट होने वाला अन्य टेक्स्ट.
सिलसिलेवार निर्देशों का उदाहरण
इस उदाहरण में, एक से ज़्यादा उपयोगकर्ताओं के लिए मीडिया आइटम अपलोड करने की प्रोसेस के बारे में बताने के लिए, pseudocode का इस्तेमाल किया गया है. इसका मकसद अपलोड की प्रोसेस के दोनों चरणों (रॉ बाइट अपलोड करना और मीडिया आइटम बनाना) के बारे में बताना है. साथ ही, बेहतर और कारगर अपलोड इंटिग्रेशन बनाने के सबसे सही तरीकों की जानकारी देना है.
पहला चरण: रॉ बाइट अपलोड करना
सबसे पहले, अपने सभी उपयोगकर्ताओं के मीडिया आइटम के रॉ बाइट अपलोड करने के लिए, एक सूची बनाएं. हर उपयोगकर्ता के लिए, दिखाए गए हर uploadToken
को ट्रैक करें. इन ज़रूरी बातों को याद रखें:
- एक साथ अपलोड की जाने वाली थ्रेड की संख्या, आपके ऑपरेटिंग सिस्टम पर निर्भर करती है.
- ज़रूरत के हिसाब से, अपलोड की सूची में वीडियो का क्रम बदलें. उदाहरण के लिए, हर उपयोगकर्ता के बाकी बचे अपलोड की संख्या, उपयोगकर्ता की कुल प्रोग्रेस या अन्य ज़रूरी शर्तों के आधार पर, अपलोड को प्राथमिकता दी जा सकती है.
स्यूडोकोड
CREATE uploadQueue FROM users, filesToUpload // Upload media bytes in parallel. START multiple THREADS WHILE uploadQueue is not empty POP uploadQueue UPLOAD file for user GET uploadToken CHECK and HANDLE errors STORE uploadToken for user in uploadTokensQueue END
दूसरा चरण: मीडिया आइटम बनाना
पहले चरण में, एक साथ कई उपयोगकर्ताओं से कई बाइट अपलोड किए जा सकते हैं. हालांकि, दूसरे चरण में, एक बार में हर उपयोगकर्ता के लिए सिर्फ़ एक कॉल किया जा सकता है.
स्यूडोकोड
// For each user, create media items once 50 upload tokens have been // saved, or no more uploads are left per user. WHEN uploadTokensQueue for user is >= 50 OR no more pending uploads for user // Calls can be made in parallel for different users, // but only make a single call per user at a time. START new thread for (this) user if there is no thread yet POP 50 uploadTokens from uploadTokensQueue for user CALL mediaItems.batchCreate with uploadTokens WAIT UNTIL batchCreate call has completed CHECK and HANDLE errors (retry as needed) DONE.
जब तक सभी अपलोड और मीडिया बनाने के अनुरोध पूरे नहीं हो जाते, तब तक इस प्रोसेस को जारी रखें.