एपीआई अनुरोध के पैरामीटर से मेल खाने वाली प्लेलिस्ट का कलेक्शन दिखाता है. उदाहरण के लिए, आप पुष्टि किए गए उपयोगकर्ता की सभी प्लेलिस्ट को फिर से पा सकते हैं. आप चाहें, तो एक या ज़्यादा प्लेलिस्ट को उनके यूनीक आईडी से फिर से पा सकते हैं.
कोटा असर: इस तरीके को कॉल करने पर कोटा लागत एक इकाई हो जाती है.
इस्तेमाल के सामान्य उदाहरण
अनुरोध करें
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/playlists
पैरामीटर
इस टेबल में ऐसे पैरामीटर दिए गए हैं जो क्वेरी के साथ काम करते हैं. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string part पैरामीटर में एक या उससे ज़्यादा playlist संसाधन प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट होती है, जिसमें एपीआई से मिलने वाला जवाब शामिल होगा.अगर पैरामीटर ऐसी प्रॉपर्टी की पहचान करता है जिसमें चाइल्ड प्रॉपर्टी हैं, तो चाइल्ड प्रॉपर्टी, रिस्पॉन्स में शामिल हो जाएंगी. उदाहरण के लिए, playlist संसाधन की snippet प्रॉपर्टी में author , title , description , और timeCreated जैसी प्रॉपर्टी शामिल हैं. इसलिए, अगर आप part=snippet सेट करते हैं, तो एपीआई रिस्पॉन्स में वे सभी प्रॉपर्टी शामिल होंगी.नीचे दी गई सूची में part नाम शामिल हैं, जिन्हें आप पैरामीटर वैल्यू में शामिल कर सकते हैं:
|
|
फ़िल्टर (इनमें से किसी एक पैरामीटर के बारे में बताएं) | ||
channelId |
string यह वैल्यू बताती है कि एपीआई को सिर्फ़ खास चैनल की प्लेलिस्ट ही दिखानी चाहिए. |
|
id |
string id पैरामीटर में, एक जैसे संसाधनों के लिए YouTube प्लेलिस्ट आईडी की कॉमा-सेपरेटेड लिस्ट दी गई है. playlist संसाधन में, id प्रॉपर्टी से प्लेलिस्ट का YouTube प्लेलिस्ट आईडी पता चलता है. |
|
mine |
boolean इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. इस पैरामीटर की वैल्यू को true पर सेट करें, ताकि एपीआई को सिर्फ़ पुष्टि की गई उपयोगकर्ता के मालिकाना हक वाली प्लेलिस्ट दिखाने का निर्देश दिया जा सके. |
|
ज़रूरी पैरामीटर | ||
hl |
string hl पैरामीटर, एपीआई को निर्देश देता है कि स्थानीय भाषा के हिसाब से बनाए गए रिसॉर्स मेटाडेटा को उस ऐप्लिकेशन की भाषा के हिसाब से बनाया जाए जिस पर YouTube की वेबसाइट काम करती है. पैरामीटर वैल्यू, भाषा का कोड होना चाहिए. इसे i18nLanguages.list तरीके से मिली सूची में शामिल किया जाना चाहिए.अगर स्थानीय भाषा में उपलब्ध संसाधन की जानकारी उसी भाषा में उपलब्ध है, तो संसाधन के snippet.localized ऑब्जेक्ट में स्थानीय भाषा के अनुसार वैल्यू शामिल होंगी. हालांकि, अगर स्थानीय भाषा में जानकारी नहीं दी गई है, तो snippet.localized ऑब्जेक्ट में संसाधन की डिफ़ॉल्ट भाषा में संसाधन की जानकारी दी जाएगी. |
|
maxResults |
unsigned integer maxResults पैरामीटर से पता चलता है कि नतीजों की सूची में कितने आइटम दिखाए जाने चाहिए. 0 से 50 तक के मान स्वीकार किए जाते हैं. डिफ़ॉल्ट वैल्यू 5 है. |
|
onBehalfOfContentOwner |
string इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की पुष्टि के लिए, किसी YouTube कॉन्टेंट मैनेजमेंट सिस्टम के उपयोगकर्ता की पहचान की गई है. यह उपयोगकर्ता, पैरामीटर वैल्यू में तय किए गए कॉन्टेंट के मालिक की तरफ़ से काम करता है. यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जो कई अलग-अलग YouTube चैनलों के मालिक हैं और उन्हें प्रबंधित करते हैं. इसकी मदद से कॉन्टेंट के मालिक एक बार पुष्टि कर सकते हैं. साथ ही, अपने सभी वीडियो और चैनल के डेटा को ऐक्सेस कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने के क्रेडेंशियल नहीं देने होंगे. जिस कॉन्टेंट मैनेजमेंट सिस्टम खाते से उपयोगकर्ता की पुष्टि होती है उसे YouTube के कॉन्टेंट के मालिक से लिंक होना चाहिए. |
|
onBehalfOfContentOwnerChannel |
string इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwnerChannel पैरामीटर से उस चैनल के YouTube चैनल आईडी का पता चलता है जिसमें वीडियो जोड़ा जा रहा है. यह पैरामीटर तब ज़रूरी होता है, जब कोई अनुरोध onBehalfOfContentOwner पैरामीटर के लिए वैल्यू तय करता है. साथ ही, इसका इस्तेमाल सिर्फ़ उसी पैरामीटर के साथ किया जा सकता है. साथ ही, अनुरोध को ऐसे कॉन्टेंट मैनेजमेंट सिस्टम से लिंक किया जाना चाहिए जो कॉन्टेंट के मालिक से जुड़ा हो और onBehalfOfContentOwner पैरामीटर के बारे में बताता हो. आखिर में, onBehalfOfContentOwnerChannel पैरामीटर की वैल्यू के बारे में बताने वाला चैनल, उस कॉन्टेंट के मालिक से जुड़ा होना चाहिए जिसका onBehalfOfContentOwner पैरामीटर तय करता है.यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जिनके पास अलग-अलग YouTube चैनलों का मालिकाना हक है और उन्हें मैनेज करने का अधिकार है. इसकी मदद से कॉन्टेंट के मालिक एक बार में पुष्टि कर सकते हैं. साथ ही, पैरामीटर की वैल्यू में बताए गए चैनल की तरफ़ से कार्रवाई कर सकते हैं. इसके लिए, हर अलग चैनल के लिए पुष्टि करने के क्रेडेंशियल देने की ज़रूरत नहीं होती. |
|
pageToken |
string pageToken पैरामीटर, नतीजों के सेट में मौजूद उस खास पेज की पहचान करता है जिसे दिखाना है. एपीआई रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी उन दूसरे पेजों की पहचान करती है जिन्हें वापस लाया जा सकता है. |
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर अनुरोध कामयाब रहता है, तो इस रिस्पॉन्स के साथ रिस्पॉन्स का फ़ॉर्मैट नीचे दिया गया है:
{ "kind": "youtube#playlistListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlist Resource ] }
प्रॉपर्टी
इस टेबल में उन प्रॉपर्टी के बारे में बताया गया है जो इस रिसॉर्स में मौजूद हैं:
प्रॉपर्टी | |
---|---|
kind |
string इससे यह पता चलता है कि एपीआई संसाधन किस तरह का है. वैल्यू youtube#playlistListResponse होगी. |
etag |
etag इस संसाधन का ऐट. |
nextPageToken |
string यह टोकन, pageToken सेट की वैल्यू के तौर पर इस्तेमाल किया जा सकता है. इससे नतीजों के सेट में, अगला पेज फिर से मिल जाता है. |
prevPageToken |
string यह टोकन, pageToken सेट की वैल्यू के तौर पर इस्तेमाल किया जा सकता है. इससे नतीजों के सेट में, पिछले पेज को वापस लाया जा सकता है. |
pageInfo |
object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग जानकारी इकट्ठा करता है. |
pageInfo.totalResults |
integer नतीजों के सेट में कुल नतीजे. |
pageInfo.resultsPerPage |
integer एपीआई रिस्पॉन्स में शामिल किए गए नतीजों की संख्या. |
items[] |
list अनुरोध की शर्तों से मेल खाने वाली प्लेलिस्ट की सूची. |
गड़बड़ियां
इस टेबल में उन गड़बड़ी के मैसेज के बारे में बताया गया है जो इस तरीके से कॉल करने पर एपीआई मिल सकता है. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी का मैसेज दस्तावेज़ देखें.
गड़बड़ी का टाइप | गड़बड़ी की जानकारी | ब्यौरा |
---|---|---|
forbidden (403) |
channelClosed |
channelId पैरामीटर में बताया गया चैनल बंद कर दिया गया है. |
forbidden (403) |
channelSuspended |
channelId पैरामीटर में बताया गया चैनल निलंबित कर दिया गया है. |
forbidden (403) |
playlistForbidden |
अनुरोध की id प्लेलिस्ट में जिस प्लेलिस्ट की पहचान की गई है वह अनुरोध के साथ काम नहीं करती या अनुरोध सही तरीके से मंज़ूर नहीं किया गया है. |
notFound (404) |
channelNotFound |
channelId पैरामीटर में बताया गया चैनल नहीं मिला. |
notFound (404) |
playlistNotFound |
अनुरोध की, id पैरामीटर से पहचान की गई प्लेलिस्ट नहीं मिली. |
invalidValue (400) |
playlistOperationUnsupported |
इस एपीआई की सूची में यह प्लेलिस्ट काम नहीं करती. उदाहरण के लिए, बाद में अपनी स्मार्टवॉच की सूची नहीं बनाई जा सकती. |
इसे आज़माएं!
इस एपीआई को कॉल करने और एपीआई का अनुरोध और जवाब देखने के लिए, APIs Explorer का इस्तेमाल करें.