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