खोज के नतीजे में 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 इस संसाधन का ईटैग. |
id |
object id ऑब्जेक्ट में ऐसी जानकारी होती है जिसका इस्तेमाल, खोज के अनुरोध से मेल खाने वाले संसाधन की पहचान करने के लिए किया जा सकता है. |
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 |
object snippet ऑब्जेक्ट में, खोज के नतीजे के बारे में बुनियादी जानकारी मौजूद होती है, जैसे कि टाइटल या ब्यौरा. उदाहरण के लिए, अगर खोज के नतीजे में दिखने वाला कोई वीडियो है, तो टाइटल को वीडियो का टाइटल माना जाएगा और वीडियो का ब्यौरा, वीडियो का ब्यौरा होगा. |
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 की वैल्यू से पता चलता है कि चैनल पर कोई लाइव ब्रॉडकास्ट चल रहा है. |