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