- एचटीटीपी अनुरोध
 - क्वेरी पैरामीटर
 - अनुरोध का मुख्य हिस्सा
 - जवाब का मुख्य हिस्सा
 - अनुमति के दायरे
 - इसे आज़माएं!
 
की गई खोज का मेटाडेटा, खोज के लिए इस्तेमाल किए गए इंजन का मेटाडेटा, और खोज के नतीजों की जानकारी देता है.
एचटीटीपी अनुरोध
GET https://customsearch.googleapis.com/customsearch/v1
यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
क्वेरी पैरामीटर
| पैरामीटर | |
|---|---|
c2coff | 
                
                   
 सिंप्लिफ़ाइड और ट्रेडिशनल चाइनीज़ सर्च को चालू या बंद करता है. इस पैरामीटर की डिफ़ॉल्ट वैल्यू 0 (शून्य) है. इसका मतलब है कि सुविधा चालू है. इन वैल्यू का इस्तेमाल किया जा सकता है: 
  | 
              
cr | 
                
                   
 खोज के नतीजों को किसी खास देश में लिखे गए दस्तावेज़ों तक सीमित करता है. आप cr पैरामीटर की वैल्यू में बूलियन ऑपरेटर का इस्तेमाल कर सकते हैं. Google Search, विश्लेषण करके यह पता लगाता है कि दस्तावेज़ किस देश का है: 
 इस पैरामीटर के लिए मान्य वैल्यू की सूची देखने के लिए, देश के पैरामीटर की वैल्यू पेज देखें.  | 
              
cx | 
                
                   
 इस अनुरोध के लिए, Programmable Search Engine का आईडी.  | 
              
dateRestrict | 
                
                   
 तारीख के आधार पर नतीजों को यूआरएल तक सीमित करता है. ये वैल्यू इस्तेमाल की जा सकती हैं: 
  | 
              
exactTerms | 
                
                   
 ऐसे वाक्यांश की पहचान करता है जो खोज नतीजों के सभी दस्तावेज़ों में मौजूद होना चाहिए.  | 
              
excludeTerms | 
                
                   
 ऐसे शब्द या वाक्यांश की पहचान करता है जो खोज के नतीजों में किसी दस्तावेज़ में नहीं दिखना चाहिए.  | 
              
fileType | 
                
                   
 चुने गए एक्सटेंशन की फ़ाइलों को नतीजों में दिखाता है. Google जिन फ़ाइल टाइप को इंडेक्स कर सकता है उनकी सूची Search Console के सहायता केंद्र पर देखी जा सकती है.  | 
              
filter | 
                
                   
 इस नीति से, डुप्लीकेट कॉन्टेंट वाले फ़िल्टर को चालू या बंद करने की सुविधा को कंट्रोल किया जाता है. 
 ये वैल्यू स्वीकार की जा सकती हैं: 
  | 
              
gl | 
                
                   
 असली उपयोगकर्ता की जियोलोकेशन. 
  | 
              
googlehost | 
                
                   
 अब काम नहीं करता. इसी तरह के इफ़ेक्ट के लिए,  खोज करने के लिए इस्तेमाल करने के लिए इस्तेमाल किया जाने वाला लोकल Google डोमेन (उदाहरण के लिए, google.com, google.de या google.fr).  | 
              
highRange | 
                
                   
 यह खोज रेंज की आखिरी वैल्यू बताता है. 
  | 
              
hl | 
                
                   
 यूज़र इंटरफ़ेस की भाषा सेट करता है. 
  | 
              
hq | 
                
                   
 तय किए गए क्वेरी शब्दों को क्वेरी में इस तरह जोड़ता है जैसे उन्हें किसी लॉजिकल AND ऑपरेटर के साथ जोड़ा गया हो.  | 
              
imgColorType | 
                
                   
 ब्लैक और व्हाइट, ग्रेस्केल, पारदर्शी या रंगीन इमेज दिखाता है. ये वैल्यू स्वीकार की जा सकती हैं: 
  | 
              
imgDominantColor | 
                
                   
 किसी खास रंग की इमेज दिखाता है. ये वैल्यू स्वीकार की जा सकती हैं: 
  | 
              
imgSize | 
                
                   
 किसी खास साइज़ की इमेज दिखाता है. ये वैल्यू स्वीकार की जा सकती हैं: 
  | 
              
imgType | 
                
                   
 किसी खास तरह की इमेज दिखाता है. ये वैल्यू स्वीकार की जा सकती हैं: 
  | 
              
linkSite | 
                
                   
 इससे पता चलता है कि सभी खोज नतीजों में किसी खास यूआरएल का लिंक शामिल होना चाहिए.  | 
              
lowRange | 
                
                   
 यह किसी खोज रेंज की शुरुआती वैल्यू बताती है. क्वेरी में   | 
              
lr | 
                
                   
 खोज को किसी खास भाषा में लिखे गए दस्तावेज़ों तक सीमित करता है (उदाहरण के लिए,  ये वैल्यू स्वीकार की जा सकती हैं: 
  | 
              
num | 
                
                   
 लौटाए जाने वाले खोज के नतीजों की संख्या. 
  | 
              
orTerms | 
                
                   
 किसी दस्तावेज़ में जांच करने के लिए अतिरिक्त खोज शब्द देता है, जहां खोज परिणामों में हर दस्तावेज़ में अतिरिक्त खोज शब्दों में से कम से कम एक शब्द होना चाहिए.  | 
              
q | 
                
                   
 क्वेरी  | 
              
relatedSite | 
                
                   
 समर्थन नहीं होना या रुकना.  | 
              
rights | 
                
                   
 लाइसेंस देने के हिसाब से फ़िल्टर. इस्तेमाल की जा सकने वाली वैल्यू में ये शामिल हैं:   | 
              
safe | 
                
                   
 खोज सुरक्षा स्तर. ये वैल्यू स्वीकार की जा सकती हैं: 
  | 
              
searchType | 
                
                   
 यह खोज टाइप बताता है:  ये वैल्यू स्वीकार की जा सकती हैं: 
  | 
              
siteSearch | 
                
                   
 इससे किसी ऐसी साइट के बारे में जानकारी मिलती है जिसे नतीजों में हमेशा शामिल किया जाना चाहिए या नतीजों में शामिल नहीं किया जाना चाहिए. इसके बारे में ज़्यादा जानने के लिए, नीचे दिया गया   | 
              
siteSearchFilter | 
                
                   
 यह नीति कंट्रोल करती है कि  ये वैल्यू स्वीकार की जा सकती हैं: 
  | 
              
sort | 
                
                   
 नतीजों पर लागू करने के लिए, क्रम से लगाने का एक्सप्रेशन. क्रम से लगाने वाला पैरामीटर यह बताता है कि नतीजों को बताए गए एक्सप्रेशन के मुताबिक क्रम से लगाया जाए यानी तारीख के मुताबिक क्रम से लगाया जाए. उदाहरण: sort=date.  | 
              
start | 
                
                   
 दिखाए जाने वाले पहले नतीजे का इंडेक्स. हर पेज पर नतीजों की डिफ़ॉल्ट संख्या 10 होती है. इसलिए,   | 
              
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य हिस्सा
कामयाब रहने पर, जवाब के मुख्य हिस्से में Search का एक इंस्टेंस शामिल किया जाता है.
अनुमति देने के दायरे
नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:
https://www.googleapis.com/auth/cse
ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.