नीचे दिए गए उदाहरणों में बताया गया है कि YouTube Data API (v3) में, एपीआई के कुछ जवाबों को वापस कैसे पाया जा सकता है.
ध्यान दें: एपीआई के शुरुआती निर्देश वाली गाइड में, कुछ अनुरोधों और जवाबों के बारे में ज़्यादा जानकारी दी गई है.
v3 API, कुछ संसाधनों को वापस पाने की अनुमति देता है. असल में, ये ऐप्लिकेशन ऐप्लिकेशन को गैर-ज़रूरी डेटा को ट्रांसफ़र करने, पार्स करने, और सेव करने से बचाते हैं. इससे, यह भी पक्का होता है कि एपीआई, नेटवर्क, सीपीयू, और मेमोरी से जुड़े संसाधनों का बेहतर तरीके से इस्तेमाल करे.
एपीआई, दो अनुरोध पैरामीटर part
और fields
के साथ काम करता है. इनकी मदद से, उन संसाधन प्रॉपर्टी की पहचान की जा सकती है जिन्हें एपीआई रिस्पॉन्स में शामिल किया जाना चाहिए. part
पैरामीटर उन प्रॉपर्टी की भी पहचान करता है जिन्हें रिसॉर्स अनुरोध को अपडेट या अपडेट करने वाले एपीआई अनुरोधों से सेट किया जाना चाहिए.
ध्यान दें कि अगर अपडेट के अनुरोध में ऐसी संसाधन प्रॉपर्टी के लिए मान नहीं दिया गया है जिसमें पहले से कोई मान था, तो इन शर्तों के सही होने पर मौजूदा मान मिटा दिया जाएगा:
-
प्रॉपर्टी की वैल्यू को अनुरोध के ज़रिए बदला जा सकता है. उदाहरण के लिए,
video
रिसॉर्स को अपडेट करते समय,snippet.description
प्रॉपर्टी की वैल्यू अपडेट की जा सकती है. हालांकि,snippet.thumbnails
ऑब्जेक्ट की वैल्यू को अपडेट नहीं किया जा सकता. -
अनुरोध की
part
पैरामीटर वैल्यू, उस रिसॉर्स वाले हिस्से की पहचान करती है जिसमें प्रॉपर्टी है.
उदाहरण
उदाहरण के लिए, मान लें कि आपको नीचे दिखाए गए video
रिसॉर्स को अपडेट करना है. (ध्यान दें कि नीचे दिखाई गई सभी प्रॉपर्टी को एपीआई के ज़रिए अपडेट किया जा सकता है. साथ ही, ऐसी संसाधन प्रॉपर्टी को भी शामिल नहीं किया गया है जो उदाहरण के लिए काम की नहीं हैं.)
{ "snippet": { "title": "Old video title", "description": "Old video description", "tags": ["keyword1","keyword2","keyword3"], "categoryId: 22 }, "status": { "privacyStatus": "private", "publishAt": "2014-09-01T12:00:00.0Z", "license": "youtube", "embeddable": True, "publicStatsViewable": True } }
आप videos.update
तरीके को कॉल करते हैं और part
पैरामीटर वैल्यू को snippet
पर सेट करते हैं. एपीआई अनुरोध के मुख्य हिस्से में ये संसाधन शामिल हैं:
{ "snippet": { "title": "New video title", "tags": ["keyword1","keyword2","keyword3"], "categoryId: 22 } }
यह अनुरोध वीडियो के शीर्षक को अपडेट कर देता है, इसका ब्यौरा मिटा देता है, और इसके टैग या श्रेणी आईडी में बदलाव नहीं करता. वीडियो का ब्यौरा मिटा दिया गया है, क्योंकि अनुरोध में snippet.description
प्रॉपर्टी के लिए मान नहीं दिया गया है.
status
ऑब्जेक्ट की प्रॉपर्टी पर कोई असर नहीं पड़ता. इसकी वजह यह है कि part
पैरामीटर की वैल्यू में, status
को अनुरोध के अपडेट किए जाने वाले हिस्से में शामिल नहीं किया गया था. असल में, अगर एपीआई अनुरोध के मुख्य हिस्से में status
ऑब्जेक्ट शामिल है, तो एपीआई, अनुरोध के लेख में अचानक का हिस्सा शामिल होने की वजह से 400 (Bad Request)
जवाब देगा.