एपीआई अनुरोध के पैरामीटर से मेल खाने वाली प्लेलिस्ट की इमेज का कलेक्शन दिखाता है. किसी खास प्लेलिस्ट की इमेज को वापस पाया जा सकता है. इसके अलावा, एक या एक से ज़्यादा प्लेलिस्ट की इमेज को उनके यूनीक आईडी से वापस लाया जा सकता है.
कोटा का असर: इस तरीके को किए जाने वाले कॉल की कोटा लागत 1 यूनिट है.
अनुरोध
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/playlistImages
अनुमति देना
इस अनुरोध के लिए, इनमें से कम से कम एक दायरे का इस्तेमाल करके अनुमति लेना ज़रूरी है (पुष्टि करने और अनुमति देने के बारे में ज़्यादा पढ़ें).
दायरा |
---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
पैरामीटर
नीचे दी गई टेबल में ऐसे पैरामीटर दिए गए हैं जो इस क्वेरी के साथ काम करते हैं. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string
|
|
फ़िल्टर (नीचे दिए गए पैरामीटर में से कोई एक पैरामीटर बताएं) | ||
id |
string
id पैरामीटर, कॉमा लगाकर अलग किए गए एक या एक से ज़्यादा प्लेलिस्ट की इमेज आईडी के बारे में बताता है. |
|
playlistId |
string
playlistId पैरामीटर उस प्लेलिस्ट का यूनीक आईडी बताता है जिसके लिए आपको प्लेलिस्ट की इमेज वापस लानी हैं. ध्यान दें कि यह एक वैकल्पिक पैरामीटर है, लेकिन प्लेलिस्ट की इमेज पाने के हर अनुरोध में id पैरामीटर या playlistId पैरामीटर के लिए वैल्यू तय करनी होगी. |
|
वैकल्पिक पैरामीटर | ||
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#playlistImageListResponse", "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ playlistImages Resource ] }
प्रॉपर्टी
नीचे दी गई टेबल में, इस संसाधन में मौजूद प्रॉपर्टी के बारे में बताया गया है:
प्रॉपर्टी | |
---|---|
kind |
string
यह एपीआई संसाधन के टाइप की पहचान करता है. वैल्यू youtube#playlistImageListResponse होगी. |
nextPageToken |
string
वह टोकन जिसका इस्तेमाल pageToken पैरामीटर की वैल्यू के तौर पर किया जा सकता है, ताकि नतीजे के सेट का अगला पेज फिर से पाया जा सके. |
prevPageToken |
string
वह टोकन, जिसका इस्तेमाल नतीजे के सेट के पिछले पेज को फिर से पाने के लिए, pageToken पैरामीटर की वैल्यू के तौर पर किया जा सकता है. |
pageInfo |
object
pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग की जानकारी को इनकैप्सुलेट करता है. |
pageInfo.totalResults |
integer
नतीजे के सेट में नतीजों की कुल संख्या. |
pageInfo.resultsPerPage |
integer
एपीआई से मिले रिस्पॉन्स में शामिल नतीजों की संख्या. |
items[] |
list
अनुरोध की शर्तों से मेल खाने वाली प्लेलिस्ट की इमेज की सूची. |