इस दस्तावेज़ से आपको Custom Search JSON API और इसके इस्तेमाल के बारे में जानकारी मिलेगी.
शुरू करने से पहले
Programmable Search Engine बनाना
एपीआई को कॉल करके, उपयोगकर्ता Programmable Search Engine के मौजूदा इंस्टेंस के लिए अनुरोध करता है. इसलिए, एपीआई का इस्तेमाल करने से पहले, आपको कंट्रोल पैनल में जाकर एक इंजन बनाना होगा. कॉन्फ़िगरेशन के अलग-अलग विकल्पों के बारे में ज़्यादा जानने के लिए, ट्यूटोरियल देखें. सर्च इंजन बन जाने के बाद, सर्च इंजन आईडी को खास जानकारी पेज के बुनियादी सेक्शन में देखा जा सकता है. यह एपीआई में इस्तेमाल किया जाने वाला cx पैरामीटर है.
एपीआई पासकोड की मदद से, Google को अपने ऐप्लिकेशन की पहचान बताना
Custom Search JSON API का इस्तेमाल करने के लिए, एपीआई पासकोड की ज़रूरत होती है. एपीआई पासकोड, Google को आपके क्लाइंट की पहचान कराने का एक तरीका है.
एपीआई पासकोड मिलने के बाद, आपका ऐप्लिकेशन सभी अनुरोध यूआरएल में क्वेरी पैरामीटर key=yourAPIKey जोड़ सकता है. एपीआई पासकोड को यूआरएल में एम्बेड करना सुरक्षित है. इसके लिए, किसी एन्कोडिंग की ज़रूरत नहीं होती.
एपीआई के बारे में खास जानकारी
एपीआई ऑपरेशन
Custom Search JSON API में, सिर्फ़ एक तरीका इस्तेमाल किया जा सकता है:
| कार्रवाई | ब्यौरा | REST एचटीटीपी मैपिंग |
|---|---|---|
| list | यह Programmable Search Engine से, खोज के अनुरोध किए गए नतीजे दिखाता है. | GET |
एपीआई डेटा मॉडल
Custom Search JSON API में सर्च क्वेरी का नतीजा, एक JSON ऑब्जेक्ट होता है. इसमें तीन तरह का डेटा शामिल होता है:
- अनुरोध की गई खोज (और, शायद मिलती-जुलती खोज के अनुरोधों) के बारे में जानकारी देने वाला मेटाडेटा
- Programmable Search Engine के बारे में जानकारी देने वाला मेटाडेटा
- खोज के नतीजे
ज़्यादा जानकारी के लिए, REST का इस्तेमाल करना लेख में मौजूद, रिस्पॉन्स डेटा सेक्शन देखें.
डेटा मॉडल, OpenSearch 1.1 स्पेसिफ़िकेशन पर आधारित है. स्टैंडर्ड OpenSearch प्रॉपर्टी के अलावा, Custom Search JSON API में दो कस्टम प्रॉपर्टी और दो कस्टम क्वेरी रोल तय किए गए हैं:
- कस्टम प्रॉपर्टी
cx: Programmable Search Engine का आइडेंटिफ़ायर.safe: नतीजों को फ़िल्टर करने के लिए, सेफ़ सर्च के लेवल की जानकारी.
- कस्टम क्वेरी की भूमिकाएं
nextPage: यह भूमिका बताती है कि क्वेरी का इस्तेमाल, नतीजों के अगले लॉजिकल पेज को ऐक्सेस करने के लिए किया जा सकता है. हालांकि, ऐसा तब ही किया जा सकता है, जब अगला पेज मौजूद हो.previousPage: यह भूमिका बताती है कि क्वेरी का इस्तेमाल, नतीजों के पिछले लॉजिकल पेज को ऐक्सेस करने के लिए किया जा सकता है. हालांकि, ऐसा तब ही किया जा सकता है, जब पिछला लॉजिकल पेज मौजूद हो.
इसे आज़माएं
बिना कोई कोड लिखे, एपीआई को आज़माने और यह देखने के लिए कि एपीआई क्या कर सकता है, "इस एपीआई को आज़माएं" टूल पर जाएं.
पैरामीटर की पूरी जानकारी के लिए, cse.list रेफ़रंस पर जाएं.
एचटीटीपी अनुरोधों के ज़रिए एपीआई इस्तेमाल करने का तरीका जानने के लिए, REST का इस्तेमाल करना पर जाएं.