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
The id पैरामीटर, उन संसाधनों के लिए YouTube प्लेलिस्ट आईडी की कॉमा लगाकर अलग की गई लिस्ट तय करता है जिन्हें वापस पाया जा रहा है. playlist संसाधन में, id प्रॉपर्टी, प्लेलिस्ट का YouTube प्लेलिस्ट आईडी तय करती है.
mine boolean
यह पैरामीटर, सिर्फ़ अनुमति वाले अनुरोध में इस्तेमाल किया जा सकता है. एपीआई को सिर्फ़ पुष्टि किए गए उपयोगकर्ता की प्लेलिस्ट दिखाने के लिए, इस पैरामीटर की वैल्यू true पर सेट करें.
वैकल्पिक पैरामीटर
hl string
The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. पैरामीटर वैल्यू, i18nLanguages.list तरीके से दिखाई गई सूची में शामिल कोई भाषा कोड होना चाहिए.

अगर स्थानीय जगह के मुताबिक संसाधन की जानकारी उपलब्ध है, तो संसाधन के snippet.localized ऑब्जेक्ट में स्थानीय जगह के मुताबिक वैल्यू शामिल होंगी. हालांकि, अगर स्थानीय भाषा में जानकारी उपलब्ध नहीं है, तो snippet.localized ऑब्जेक्ट में संसाधन की डिफ़ॉल्ट भाषा में जानकारी शामिल होगी.
maxResults unsigned integer
maxResults पैरामीटर, नतीजों के सेट में वापस दिखाई जाने वाली ज़्यादा से ज़्यादा आइटम की संख्या तय करता है. स्वीकार्य वैल्यू 0 से 50 तक हैं. डिफ़ॉल्ट वैल्यू 5 है.
onBehalfOfContentOwner string
इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर, सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है.

onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की अनुमति देने वाले क्रेडेंशियल, YouTube सीएमएस के किसी ऐसे उपयोगकर्ता की पहचान करते हैं जो पैरामीटर वैल्यू में तय किए गए कॉन्टेंट के मालिक की ओर से काम कर रहा है. यह पैरामीटर, YouTube के उन कॉन्टेंट पार्टनर के लिए है जो YouTube के कई अलग-अलग चैनलों के मालिक हैं और उन्हें मैनेज करते हैं. इससे, कॉन्टेंट के मालिक एक बार पुष्टि करके, अपने सभी वीडियो और चैनल के डेटा का ऐक्सेस पा सकते हैं. इसके लिए, उन्हें हर चैनल के लिए अनुमति देने वाले क्रेडेंशियल देने की ज़रूरत नहीं होती. जिस CMS खाते से उपयोगकर्ता पुष्टि करता है वह, तय किए गए YouTube कॉन्टेंट के मालिक से लिंक होना चाहिए.
onBehalfOfContentOwnerChannel string
इस पैरामीटर का इस्तेमाल, सिर्फ़ अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर, सिर्फ़ YouTube के कॉन्टेंट पार्टनर के लिए है.

onBehalfOfContentOwnerChannel पैरामीटर, उस चैनल का YouTube चैनल आईडी तय करता है जिसमें कोई वीडियो जोड़ा जा रहा है. जब किसी अनुरोध में onBehalfOfContentOwner पैरामीटर के लिए कोई वैल्यू तय की जाती है, तब इस पैरामीटर का इस्तेमाल करना ज़रूरी होता है. इसका इस्तेमाल, सिर्फ़ उस पैरामीटर के साथ किया जा सकता है. इसके अलावा, अनुरोध को अनुमति देने के लिए, CMS के ऐसे खाते का इस्तेमाल करना ज़रूरी है जो उस कॉन्टेंट के मालिक से लिंक हो जिसे 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
यह इस संसाधन का 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 का इस्तेमाल करें.