Playlists: list

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

कोटा पर असर: इस तरीके का इस्तेमाल करने पर एक यूनिट की कोटे की कीमत लागू होती है.

इस्तेमाल के सामान्य उदाहरण

अनुरोध

एचटीटीपी अनुरोध

GET https://www.googleapis.com/youtube/v3/playlists

पैरामीटर

इस टेबल में वे पैरामीटर दिए गए हैं जो इस क्वेरी पर काम करते हैं. सूची में शामिल सभी पैरामीटर, क्वेरी पैरामीटर हैं.

पैरामीटर
ज़रूरी पैरामीटर
part string
part पैरामीटर, एक या एक से ज़्यादा playlist संसाधन प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट के बारे में बताता है. इस सूची में एपीआई के रिस्पॉन्स शामिल होंगे.

अगर पैरामीटर किसी ऐसी प्रॉपर्टी की पहचान करता है जिसमें चाइल्ड प्रॉपर्टी शामिल हैं, तो जवाब में चाइल्ड प्रॉपर्टी शामिल हो जाएंगी. उदाहरण के लिए, playlist संसाधन में snippet प्रॉपर्टी में author, title, description, और timeCreated जैसी प्रॉपर्टी शामिल हैं. इसलिए, अगर part=snippet को सेट किया जाता है, तो एपीआई से मिले रिस्पॉन्स में वे सभी प्रॉपर्टी शामिल होंगी.

यहां दी गई सूची में part नाम हैं, जिन्हें पैरामीटर की वैल्यू में शामिल किया जा सकता है:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
फ़िल्टर (इनमें से कोई एक पैरामीटर बताएं)
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 का इस्तेमाल करें. साथ ही, एपीआई अनुरोध और रिस्पॉन्स देखें.