Method: cse.siterestrict.list

की गई खोज का मेटाडेटा, खोज के लिए इस्तेमाल किए गए इंजन का मेटाडेटा, और खोज के नतीजों की जानकारी देता है. यूआरएल पैटर्न के छोटे सेट का इस्तेमाल करता है.

एचटीटीपी अनुरोध

GET https://customsearch.googleapis.com/customsearch/v1/siterestrict

यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
c2coff

string

सिंप्लिफ़ाइड और ट्रेडिशनल चाइनीज़ सर्च को चालू या बंद करता है.

इस पैरामीटर की डिफ़ॉल्ट वैल्यू 0 (शून्य) है. इसका मतलब है कि सुविधा चालू है. इन वैल्यू का इस्तेमाल किया जा सकता है:

  • 1: बंद है

  • 0: चालू है (डिफ़ॉल्ट)
cr

string

खोज के नतीजों को किसी खास देश में लिखे गए दस्तावेज़ों तक सीमित करता है. आप cr पैरामीटर की वैल्यू में बूलियन ऑपरेटर का इस्तेमाल कर सकते हैं.

Google Search, विश्लेषण करके यह पता लगाता है कि दस्तावेज़ किस देश का है:

  • दस्तावेज़ के यूआरएल का टॉप लेवल डोमेन (टीएलडी)

  • वेब सर्वर के आईपी पते की भौगोलिक जगह

इस पैरामीटर के लिए मान्य वैल्यू की सूची देखने के लिए, देश के पैरामीटर की वैल्यू पेज देखें.
cx

string

इस अनुरोध के लिए, Programmable Search Engine का आईडी.
dateRestrict

string

तारीख के आधार पर नतीजों को यूआरएल तक सीमित करता है. ये वैल्यू इस्तेमाल की जा सकती हैं:

  • d[number]: पिछले दिनों की तय संख्या के आधार पर नतीजे अनुरोध करता है.

  • w[number]: अनुरोध, पिछले हफ़्तों की तय संख्या के मुताबिक मिले.

  • m[number]: पिछले महीनों की तय संख्या से मिले अनुरोधों के नतीजे.

  • y[number]: अनुरोध, पिछले सालों की तय संख्या के मुताबिक मिले हैं.
exactTerms

string

ऐसे वाक्यांश की पहचान करता है जो खोज नतीजों के सभी दस्तावेज़ों में मौजूद होना चाहिए.
excludeTerms

string

ऐसे शब्द या वाक्यांश की पहचान करता है जो खोज के नतीजों में किसी दस्तावेज़ में नहीं दिखना चाहिए.
fileType

string

चुने गए एक्सटेंशन की फ़ाइलों को नतीजों में दिखाता है. Google जिन फ़ाइल टाइप को इंडेक्स कर सकता है उनकी सूची Search Console के सहायता केंद्र पर देखी जा सकती है.
filter

string

इस नीति से, डुप्लीकेट कॉन्टेंट वाले फ़िल्टर को चालू या बंद करने की सुविधा को कंट्रोल किया जाता है.

  • Google के खोज नतीजों के फ़िल्टर के बारे में ज़्यादा जानकारी के लिए, अपने-आप फ़िल्टर करना देखें. ध्यान दें कि होस्ट क्राउडिंग फ़िल्टरिंग सिर्फ़ मल्टी-साइट खोजों पर लागू होती है.

  • डिफ़ॉल्ट रूप से, Google खोज के सभी नतीजों को बेहतर बनाने के लिए, उन पर फ़िल्टर लागू करता है.

ये वैल्यू स्वीकार की जा सकती हैं:

  • 0: इससे डुप्लीकेट कॉन्टेंट को फ़िल्टर करने की सुविधा बंद हो जाती है.

  • 1: इससे डुप्लीकेट कॉन्टेंट फ़िल्टर करने की सुविधा चालू हो जाती है.
gl

string

असली उपयोगकर्ता की जियोलोकेशन.

  • gl पैरामीटर की वैल्यू, देश का दो अक्षरों वाला कोड होती है. gl पैरामीटर, उन खोज नतीजों को बढ़ाता है जिनके मूल देश का नाम, पैरामीटर की वैल्यू से मेल खाता है. मान्य वैल्यू की सूची देखने के लिए, देशों के कोड पेज देखें.

  • gl पैरामीटर की वैल्यू तय करने से, ज़्यादा काम के नतीजे मिलते हैं. यह खास तौर पर अंतरराष्ट्रीय ग्राहकों पर लागू होता है. खास तौर पर, अमेरिका के अलावा, अंग्रेज़ी बोलने वाले देशों के ग्राहकों के लिए भी यह सही है.
googlehost

string

अब काम नहीं करता. इसी तरह के इफ़ेक्ट के लिए, gl पैरामीटर का इस्तेमाल करें.

खोज करने के लिए इस्तेमाल करने के लिए इस्तेमाल किया जाने वाला लोकल Google डोमेन (उदाहरण के लिए, google.com, google.de या google.fr).
highRange

string

यह खोज रेंज की आखिरी वैल्यू बताता है.

  • क्वेरी में lowRange...highRange की शामिल की जाने वाली खोज रेंज जोड़ने के लिए, lowRange और highRange का इस्तेमाल करें.
hl

string

यूज़र इंटरफ़ेस की भाषा सेट करता है.
hq

string

तय किए गए क्वेरी शब्दों को क्वेरी में इस तरह जोड़ता है जैसे उन्हें किसी लॉजिकल AND ऑपरेटर के साथ जोड़ा गया हो.
imgColorType

enum (ImgColorType)

ब्लैक और व्हाइट, ग्रेस्केल, पारदर्शी या रंगीन इमेज दिखाता है. ये वैल्यू स्वीकार की जा सकती हैं:

  • "color"

  • "gray"

  • "mono": ब्लैक एंड व्हाइट

  • "trans": पारदर्शी बैकग्राउंड
imgDominantColor

enum (ImgDominantColor)

किसी खास रंग की इमेज दिखाता है. ये वैल्यू स्वीकार की जा सकती हैं:

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"
imgSize

enum (ImgSize)

किसी खास साइज़ की इमेज दिखाता है. ये वैल्यू स्वीकार की जा सकती हैं:

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"
imgType

enum (ImgType)

किसी खास तरह की इमेज दिखाता है. ये वैल्यू स्वीकार की जा सकती हैं:

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"
lowRange

string

यह किसी खोज रेंज की शुरुआती वैल्यू बताती है. क्वेरी में lowRange...highRange की शामिल की जाने वाली खोज रेंज जोड़ने के लिए, lowRange और highRange का इस्तेमाल करें.
lr

string

खोज को किसी खास भाषा में लिखे गए दस्तावेज़ों तक सीमित करता है (उदाहरण के लिए, lr=lang_ja).

ये वैल्यू स्वीकार की जा सकती हैं:

  • "lang_ar": अरबी

  • "lang_bg": बुल्गारियन

  • "lang_ca": कैटलैन

  • "lang_cs": चेक

  • "lang_da": डेनिश

  • "lang_de": जर्मन

  • "lang_el": ग्रीक

  • "lang_en": अंग्रेज़ी

  • "lang_es": स्पैनिश

  • "lang_et": एस्टोनियन

  • "lang_fi": फ़िनिश

  • "lang_fr": फ़्रेंच

  • "lang_hr": क्रोएशियन

  • "lang_hu": हंगेरियन

  • "lang_id": इंडोनेशियन

  • "lang_is": आइसलैंडिक

  • "lang_it": इटैलियन

  • "lang_iw": हिब्रू

  • "lang_ja": जैपनीज़

  • "lang_ko": कोरियन

  • "lang_lt": लिथुआनियन

  • "lang_lv": लातवियाई

  • "lang_nl": डच

  • "lang_no": नॉर्वीजन

  • "lang_pl": पोलिश

  • "lang_pt": पॉर्चुगीज़

  • "lang_ro": रोमेनियन

  • "lang_ru": रशियन

  • "lang_sk": स्लोवाक

  • "lang_sl": स्लोवेनियन

  • "lang_sr": सर्बियाई

  • "lang_sv": स्वीडिश

  • "lang_tr": तुर्किये

  • "lang_zh-CN": चाइनीज़ (आसान)

  • "lang_zh-TW": चाइनीज़ (पारंपरिक)
num

integer

लौटाए जाने वाले खोज के नतीजों की संख्या.

  • मान्य वैल्यू, 1 से 10 के बीच के पूर्णांक होते हैं.
orTerms

string

किसी दस्तावेज़ में जांच करने के लिए अतिरिक्त खोज शब्द देता है, जहां खोज परिणामों में हर दस्तावेज़ में अतिरिक्त खोज शब्दों में से कम से कम एक शब्द होना चाहिए.
q

string

क्वेरी
relatedSite
(deprecated)

string

समर्थन नहीं होना या रुकना.
rights

string

लाइसेंस देने के हिसाब से फ़िल्टर. इस्तेमाल की जा सकने वाली वैल्यू में ये शामिल हैं: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial, cc_nonderived, और इनके कॉम्बिनेशन. सामान्य कॉम्बिनेशन देखें.
safe

enum (Safe)

खोज सुरक्षा स्तर. ये वैल्यू स्वीकार की जा सकती हैं:

  • "active": सेफ़ सर्च से फ़िल्टर करने की सुविधा चालू करता है.

  • "off": सेफ़ सर्च से फ़िल्टर करने की सुविधा बंद करता है. (डिफ़ॉल्ट)
searchType

enum (SearchType)

यह खोज टाइप बताता है: image. अगर जानकारी नहीं दी गई है, तो नतीजों को सिर्फ़ वेबपेजों पर दिखाया जाएगा.

ये वैल्यू स्वीकार की जा सकती हैं:

  • "image": पसंद के मुताबिक इमेज खोज.
siteSearchFilter

enum (SiteSearchFilter)

यह नीति कंट्रोल करती है कि siteSearch पैरामीटर में नाम वाली साइट के नतीजों को शामिल करना है या बाहर रखना है.

ये वैल्यू स्वीकार की जा सकती हैं:

  • "e": छोड़ें

  • "i": शामिल करें
sort

string

नतीजों पर लागू करने के लिए, क्रम से लगाने का एक्सप्रेशन. क्रम से लगाने वाला पैरामीटर यह बताता है कि नतीजों को बताए गए एक्सप्रेशन के मुताबिक क्रम से लगाया जाए यानी तारीख के मुताबिक क्रम से लगाया जाए. उदाहरण: sort=date.
start

integer (uint32 format)

दिखाए जाने वाले पहले नतीजे का इंडेक्स. हर पेज पर नतीजों की डिफ़ॉल्ट संख्या 10 होती है. इसलिए, &start=11, नतीजों के दूसरे पेज से सबसे ऊपर शुरू होगा. ध्यान दें: JSON API कभी भी 100 से ज़्यादा नतीजे नहीं दिखाएगा, भले ही क्वेरी से मेल खाने वाले 100 से ज़्यादा दस्तावेज़ हों. इसलिए, start + num के योग को 100 से ज़्यादा पर सेट करने से गड़बड़ी पैदा होगी. यह भी ध्यान रखें कि num की ज़्यादा से ज़्यादा वैल्यू 10 है.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य हिस्सा

कामयाब रहने पर, जवाब के मुख्य हिस्से में Search का एक इंस्टेंस शामिल किया जाता है.

अनुमति देने के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/cse

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.