search नतीजे में, YouTube वीडियो, चैनल या प्लेलिस्ट के बारे में जानकारी होती है. यह जानकारी, एपीआई अनुरोध में खोज के लिए तय किए गए पैरामीटर से मेल खाती है. खोज के नतीजे में, किसी यूनीक संसाधन (जैसे, वीडियो) का लिंक होता है. हालांकि, इसमें खुद का कोई स्थायी डेटा नहीं होता.
तरीके
यह एपीआई, खोज के लिए इन तरीकों का इस्तेमाल करता है:
- list
- यह एपीआई अनुरोध में दिए गए क्वेरी पैरामीटर से मेल खाने वाले खोज नतीजों का कलेक्शन दिखाता है. डिफ़ॉल्ट रूप से, खोज के नतीजों का सेट, मिलते-जुलते
video,channel, औरplaylistरिसॉर्स की पहचान करता है. हालांकि, क्वेरी को सिर्फ़ किसी खास तरह के रिसॉर्स को वापस पाने के लिए भी कॉन्फ़िगर किया जा सकता है. इसे अभी आज़माएं.
संसाधन का रेप्रज़ेंटेशन
JSON के इस स्ट्रक्चर में, खोज के नतीजे का फ़ॉर्मैट दिखाया गया है:
{
"kind": "youtube#searchResult",
"etag": etag,
"id": {
"kind": string,
"videoId": string,
"channelId": string,
"playlistId": string
},
"snippet": {
"publishedAt": datetime,
"channelId": string,
"title": string,
"description": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
},
"channelTitle": string,
"liveBroadcastContent": string
}
}प्रॉपर्टी
नीचे दी गई टेबल में, खोज के नतीजों में दिखने वाली प्रॉपर्टी के बारे में बताया गया है:
| प्रॉपर्टी | |
|---|---|
kind |
stringइससे एपीआई संसाधन के टाइप की पहचान होती है. वैल्यू youtube#searchResult होगी. |
etag |
etagइस संसाधन का ETag. |
id |
objectid ऑब्जेक्ट में ऐसी जानकारी होती है जिसका इस्तेमाल, खोज के अनुरोध से मेल खाने वाले संसाधन की पहचान करने के लिए किया जा सकता है. |
id.kind |
stringयह एपीआई संसाधन का टाइप है. |
id.videoId |
stringअगर id.type प्रॉपर्टी की वैल्यू youtube#video है, तो यह प्रॉपर्टी मौजूद होगी. इसकी वैल्यू में वह आईडी शामिल होगा जिसका इस्तेमाल YouTube, खोज क्वेरी से मेल खाने वाले वीडियो की पहचान करने के लिए करता है. |
id.channelId |
stringअगर id.type प्रॉपर्टी की वैल्यू youtube#channel है, तो यह प्रॉपर्टी मौजूद होगी. इसकी वैल्यू में वह आईडी शामिल होगा जिसका इस्तेमाल YouTube, खोज क्वेरी से मेल खाने वाले किसी चैनल की खास तौर पर पहचान करने के लिए करता है. |
id.playlistId |
stringअगर id.type प्रॉपर्टी की वैल्यू youtube#playlist है, तो यह प्रॉपर्टी मौजूद होगी. इसकी वैल्यू में वह आईडी शामिल होगा जिसका इस्तेमाल YouTube, खोज क्वेरी से मेल खाने वाली किसी प्लेलिस्ट की खास तौर पर पहचान करने के लिए करता है. |
snippet |
objectsnippet ऑब्जेक्ट में, खोज के नतीजे के बारे में बुनियादी जानकारी होती है. जैसे, उसका टाइटल या ब्यौरा. उदाहरण के लिए, अगर खोज का नतीजा कोई वीडियो है, तो टाइटल, वीडियो का टाइटल होगा और ब्यौरा, वीडियो का ब्यौरा होगा. |
snippet.publishedAt |
datetimeखोज के नतीजे में जिस संसाधन की पहचान की गई है उसके बनने की तारीख और समय. वैल्यू को ISO 8601 फ़ॉर्मैट में तय किया जाता है. |
snippet.channelId |
stringयह ऐसी वैल्यू होती है जिसका इस्तेमाल YouTube, उस चैनल की खास तौर पर पहचान करने के लिए करता है जिसने खोज के नतीजे में दिखने वाली संसाधन को पब्लिश किया है. |
snippet.title |
stringखोज के नतीजे का टाइटल. |
snippet.description |
stringखोज के नतीजे की जानकारी. |
snippet.thumbnails |
objectयह खोज के नतीजे से जुड़ी थंबनेल इमेज का मैप है. मैप में मौजूद हर ऑब्जेक्ट के लिए, कुंजी थंबनेल इमेज का नाम होती है. साथ ही, वैल्यू एक ऐसा ऑब्जेक्ट होता है जिसमें थंबनेल के बारे में अन्य जानकारी होती है. |
snippet.thumbnails.(key) |
objectकुंजी की मान्य वैल्यू ये हैं:
ध्यान दें: खोज के नतीजों में, 1080 पिक्सल से ज़्यादा रिज़ॉल्यूशन वाली थंबनेल इमेज ( |
snippet.thumbnails.(key).url |
stringइमेज का यूआरएल. |
snippet.thumbnails.(key).width |
unsigned integerइमेज की चौड़ाई. |
snippet.thumbnails.(key).height |
unsigned integerइमेज की ऊंचाई. |
snippet.channelTitle |
stringयह उस चैनल का टाइटल है जिसने खोज के नतीजे में पहचाने गए संसाधन को पब्लिश किया है. |
snippet.liveBroadcastContent |
stringइससे पता चलता है कि video या channel रिसॉर्स में लाइव ब्रॉडकास्ट कॉन्टेंट है या नहीं. प्रॉपर्टी की मान्य वैल्यू upcoming, live, और none हैं.video रिसॉर्स के लिए, upcoming वैल्यू का मतलब है कि वीडियो एक लाइव ब्रॉडकास्ट है, जो अभी शुरू नहीं हुआ है. वहीं, live वैल्यू का मतलब है कि वीडियो एक चालू लाइव ब्रॉडकास्ट है. channel संसाधन के लिए, upcoming वैल्यू का मतलब है कि चैनल पर शेड्यूल किया गया ऐसा ब्रॉडकास्ट है जो अभी शुरू नहीं हुआ है. वहीं, live वैल्यू का मतलब है कि चैनल पर लाइव ब्रॉडकास्ट चल रहा है. |