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