एपीआई अनुरोध के पैरामीटर से मेल खाने वाले वीडियो की सूची दिखाता है.
कोटा असर: इस तरीके को कॉल करने पर कोटा लागत एक इकाई हो जाती है.
इस्तेमाल के सामान्य उदाहरण
अनुरोध करें
एचटीटीपी अनुरोध
GET https://www.googleapis.com/youtube/v3/videos
पैरामीटर
इस टेबल में ऐसे पैरामीटर दिए गए हैं जो क्वेरी के साथ काम करते हैं. सूची में दिए गए सभी पैरामीटर, क्वेरी पैरामीटर हैं.
पैरामीटर | ||
---|---|---|
ज़रूरी पैरामीटर | ||
part |
string part पैरामीटर में एक या उससे ज़्यादा video संसाधन प्रॉपर्टी की कॉमा-सेपरेटेड लिस्ट होती है, जिसमें एपीआई से मिलने वाला जवाब शामिल होगा.अगर पैरामीटर ऐसी प्रॉपर्टी की पहचान करता है जिसमें चाइल्ड प्रॉपर्टी हैं, तो चाइल्ड प्रॉपर्टी, रिस्पॉन्स में शामिल हो जाएंगी. उदाहरण के लिए, video प्रॉपर्टी की snippet प्रॉपर्टी में channelId , title , description , tags , और categoryId प्रॉपर्टी शामिल हैं. इसलिए, अगर आप part=snippet सेट करते हैं, तो एपीआई रिस्पॉन्स में वे सभी प्रॉपर्टी शामिल होंगी.नीचे दी गई सूची में part नाम शामिल हैं, जिन्हें आप पैरामीटर वैल्यू में शामिल कर सकते हैं:
|
|
फ़िल्टर (इनमें से किसी एक पैरामीटर के बारे में बताएं) | ||
chart |
string chart पैरामीटर उस चार्ट की पहचान करता है जिसे वापस पाना है.ये वैल्यू स्वीकार की जाती हैं:
|
|
id |
string id पैरामीटर में, हटाए जा रहे संसाधनों के लिए, YouTube वीडियो के आईडी की कॉमा-सेपरेटेड लिस्ट दी गई है. video रिसॉर्स में, id प्रॉपर्टी में वीडियो का आईडी दिखता है. |
|
myRating |
string इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. इस पैरामीटर की वैल्यू को like या dislike पर सेट करें, ताकि एपीआई को सिर्फ़ ऐसे वीडियो वापस करने के निर्देश मिल सकें जो पुष्टि किए गए उपयोगकर्ता को पसंद या नापसंद हों.मान्य वैल्यू ये हैं:
|
|
ज़रूरी पैरामीटर | ||
hl |
string hl पैरामीटर, एपीआई को निर्देश देता है कि स्थानीय भाषा के हिसाब से बनाए गए रिसॉर्स मेटाडेटा को उस ऐप्लिकेशन की भाषा के हिसाब से बनाया जाए जिस पर YouTube की वेबसाइट काम करती है. पैरामीटर वैल्यू, भाषा का कोड होना चाहिए. इसे i18nLanguages.list तरीके से मिली सूची में शामिल किया जाना चाहिए.अगर स्थानीय भाषा में उपलब्ध संसाधन की जानकारी उसी भाषा में उपलब्ध है, तो संसाधन के snippet.localized ऑब्जेक्ट में स्थानीय भाषा के अनुसार वैल्यू शामिल होंगी. हालांकि, अगर स्थानीय भाषा में जानकारी नहीं दी गई है, तो snippet.localized ऑब्जेक्ट में संसाधन की डिफ़ॉल्ट भाषा में संसाधन की जानकारी दी जाएगी. |
|
maxHeight |
unsigned integer maxHeight पैरामीटर से पता चलता है कि player.embedHtml प्रॉपर्टी में एम्बेड किए गए प्लेयर की ऊंचाई कितनी है. इस पैरामीटर का इस्तेमाल यह बताने के लिए किया जा सकता है कि डिफ़ॉल्ट डाइमेंशन के बजाय, एम्बेड कोड को आपके ऐप्लिकेशन लेआउट के लिए सही ऊंचाई का इस्तेमाल करना चाहिए. अगर maxWidth पैरामीटर भी दिया गया है, तो ज़्यादा से ज़्यादा चौड़ाई का उल्लंघन न करने के लिए प्लेयर की लंबाई maxHeight से कम हो सकती है. 72 से 8192 तक के मान स्वीकार किए जाते हैं. |
|
maxResults |
unsigned integer maxResults पैरामीटर से पता चलता है कि नतीजों के सेट में कितने आइटम लौटाने हैं.ध्यान दें: इस पैरामीटर को myRating पैरामीटर के साथ इस्तेमाल किया जा सकता है, लेकिन id पैरामीटर के साथ इस्तेमाल करने के लिए इसका इस्तेमाल नहीं किया जा सकता. 1 से 50 तक के मान स्वीकार किए जाते हैं. डिफ़ॉल्ट वैल्यू 5 है. |
|
maxWidth |
unsigned integer maxWidth पैरामीटर से पता चलता है कि player.embedHtml प्रॉपर्टी में एम्बेड किए गए प्लेयर की चौड़ाई कितनी है. इस पैरामीटर का इस्तेमाल यह बताने के लिए किया जा सकता है कि डिफ़ॉल्ट डाइमेंशन के बजाय, एम्बेड कोड को आपके ऐप्लिकेशन लेआउट के लिए सही चौड़ाई का इस्तेमाल करना चाहिए.अगर maxHeight पैरामीटर भी दिया गया है, तो ज़्यादा से ज़्यादा ऊंचाई का उल्लंघन न करने के लिए, प्लेयर maxWidth से छोटा हो सकता है. 72 से 8192 तक के मान स्वीकार किए जाते हैं. |
|
onBehalfOfContentOwner |
string इस पैरामीटर का इस्तेमाल सिर्फ़ सही तरीके से की गई अनुमति वाले अनुरोध में किया जा सकता है. ध्यान दें: यह पैरामीटर खास तौर पर YouTube कॉन्टेंट पार्टनर के लिए है. onBehalfOfContentOwner पैरामीटर से पता चलता है कि अनुरोध की पुष्टि के लिए, किसी YouTube कॉन्टेंट मैनेजमेंट सिस्टम के उपयोगकर्ता की पहचान की गई है. यह उपयोगकर्ता, पैरामीटर वैल्यू में तय किए गए कॉन्टेंट के मालिक की तरफ़ से काम करता है. यह पैरामीटर उन YouTube कॉन्टेंट पार्टनर के लिए है जो कई अलग-अलग YouTube चैनलों के मालिक हैं और उन्हें प्रबंधित करते हैं. इसकी मदद से कॉन्टेंट के मालिक एक बार पुष्टि कर सकते हैं. साथ ही, अपने सभी वीडियो और चैनल के डेटा को ऐक्सेस कर सकते हैं. इसके लिए, उन्हें हर चैनल के लिए पुष्टि करने के क्रेडेंशियल नहीं देने होंगे. जिस कॉन्टेंट मैनेजमेंट सिस्टम खाते से उपयोगकर्ता की पुष्टि होती है उसे YouTube के कॉन्टेंट के मालिक से लिंक होना चाहिए. |
|
pageToken |
string pageToken पैरामीटर, नतीजों के सेट में मौजूद उस खास पेज की पहचान करता है जिसे दिखाना है. एपीआई रिस्पॉन्स में, nextPageToken और prevPageToken प्रॉपर्टी, उन दूसरे पेजों की पहचान करती हैं जिन्हें फिर से हासिल किया जा सकता है.ध्यान दें: इस पैरामीटर का इस्तेमाल myRating पैरामीटर के साथ किया जा सकता है, लेकिन यह id पैरामीटर के साथ इस्तेमाल करने के लिए काम नहीं करता. |
|
regionCode |
string regionCode पैरामीटर, एपीआई को कुछ खास इलाकों में उपलब्ध वीडियो चार्ट चुनने के लिए कहता है. इस पैरामीटर का इस्तेमाल सिर्फ़ chart पैरामीटर के साथ किया जा सकता है. पैरामीटर वैल्यू, ISO 3166-1 ऐल्फ़ा-2 देश कोड है. |
|
videoCategoryId |
string videoCategoryId पैरामीटर उस वीडियो कैटगरी की पहचान करता है जिसके लिए चार्ट वापस लाना है. इस पैरामीटर का इस्तेमाल सिर्फ़ chart पैरामीटर के साथ किया जा सकता है. डिफ़ॉल्ट रूप से, चार्ट किसी खास श्रेणी के लिए प्रतिबंधित नहीं हैं. डिफ़ॉल्ट वैल्यू 0 है. |
अनुरोध का मुख्य भाग
इस तरीके को कॉल करते समय, अनुरोध का मुख्य हिस्सा न दें.
जवाब
अगर अनुरोध कामयाब रहता है, तो इस रिस्पॉन्स के साथ रिस्पॉन्स का फ़ॉर्मैट नीचे दिया गया है:
{ "kind": "youtube#videoListResponse", "etag": etag, "nextPageToken": string, "prevPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ video Resource ] }
प्रॉपर्टी
इस टेबल में उन प्रॉपर्टी के बारे में बताया गया है जो इस रिसॉर्स में मौजूद हैं:
प्रॉपर्टी | |
---|---|
kind |
string इससे यह पता चलता है कि एपीआई संसाधन किस तरह का है. वैल्यू youtube#videoListResponse होगी. |
etag |
etag इस संसाधन का ऐट. |
nextPageToken |
string यह टोकन, pageToken सेट की वैल्यू के तौर पर इस्तेमाल किया जा सकता है. इससे नतीजों के सेट में, अगला पेज फिर से मिल जाता है. |
prevPageToken |
string यह टोकन, pageToken सेट की वैल्यू के तौर पर इस्तेमाल किया जा सकता है. इससे नतीजों के सेट में, पिछले पेज को वापस लाया जा सकता है. |
pageInfo |
object pageInfo ऑब्जेक्ट, नतीजे के सेट के लिए पेजिंग जानकारी इकट्ठा करता है. |
pageInfo.totalResults |
integer नतीजों के सेट में कुल नतीजे. |
pageInfo.resultsPerPage |
integer एपीआई रिस्पॉन्स में शामिल किए गए नतीजों की संख्या. |
items[] |
list ऐसे वीडियो की सूची जो अनुरोध से जुड़ी शर्तों को पूरा करते हैं. |
गड़बड़ियां
इस टेबल में उन गड़बड़ी के मैसेज के बारे में बताया गया है जो इस तरीके से कॉल करने पर एपीआई मिल सकता है. ज़्यादा जानकारी के लिए, कृपया गड़बड़ी का मैसेज दस्तावेज़ देखें.
गड़बड़ी का टाइप | गड़बड़ी की जानकारी | ब्यौरा |
---|---|---|
badRequest (400) |
videoChartNotFound |
जिस वीडियो चार्ट का अनुरोध किया गया है वह काम नहीं करता या वह उपलब्ध नहीं है. |
forbidden (403) |
forbidden |
अनुरोध को वीडियो फ़ाइल या प्रोसेसिंग जानकारी को ऐक्सेस करने के लिए उचित अनुमति नहीं है. ध्यान दें कि fileDetails , processingDetails , और suggestions के पार्ट, सिर्फ़ वीडियो के मालिक के लिए उपलब्ध हैं. |
forbidden (403) |
forbidden |
उपयोगकर्ता रेटिंग की जानकारी को ऐक्सेस नहीं किया जा सकता. यह गड़बड़ी तब हो सकती है, जब अनुरोध को myRating पैरामीटर का इस्तेमाल करने की अनुमति न हो. |
notFound (404) |
videoNotFound |
जिस वीडियो को पाने की कोशिश की जा रही है वह नहीं मिला. अनुरोध के id पैरामीटर की वैल्यू देखकर, पक्का करें कि वह सही है. |
इसे आज़माएं!
इस एपीआई को कॉल करने और एपीआई का अनुरोध और जवाब देखने के लिए, APIs Explorer का इस्तेमाल करें.