इस दस्तावेज़ से, आपको 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 स्पेसिफ़िकेशन पर आधारित है. Custom Search JSON API, OpenSearch की स्टैंडर्ड प्रॉपर्टी के अलावा, दो कस्टम प्रॉपर्टी और दो कस्टम क्वेरी रोल तय करता है:
- कस्टम प्रॉपर्टी
cx: Programmable Search Engine का आइडेंटिफ़ायर.safe: खोज के नतीजों को फ़िल्टर करने के लिए, सेफ़ सर्च के लेवल का ब्यौरा.
- कस्टम क्वेरी रोल
nextPage: यह एक ऐसी भूमिका है जिससे पता चलता है कि इस क्वेरी का इस्तेमाल, नतीजों के अगले लॉजिकल पेज को ऐक्सेस करने के लिए किया जा सकता है.previousPage: यह एक ऐसी भूमिका है जो यह दिखाती है कि क्वेरी का इस्तेमाल, नतीजों के पिछले लॉजिकल पेज को ऐक्सेस करने के लिए किया जा सकता है.
इसे आज़माएं
बिना कोई कोड लिखे, एपीआई को आज़माने और यह देखने के लिए कि एपीआई क्या-क्या कर सकता है, "यह एपीआई आज़माएं" टूल पर जाएं.
पैरामीटर के बारे में पूरी जानकारी पाने के लिए, cse.list reference पर जाएं.
एचटीटीपी अनुरोधों के ज़रिए एपीआई का इस्तेमाल करने का तरीका जानने के लिए, REST का इस्तेमाल करना लेख पढ़ें.