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मान्य कुंजी वैल्यू ये हैं:
|
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 वैल्यू से पता चलता है कि चैनल पर कोई लाइव ब्रॉडकास्ट चल रहा है. |