Method: query.search

Cloud Search क्वेरी एपीआई, खोज का तरीका उपलब्ध कराता है. यह उपयोगकर्ता की क्वेरी के हिसाब से सबसे काम के नतीजे दिखाता है. ये नतीजे, Gmail या Google Drive जैसे Google Workspace ऐप्लिकेशन से मिल सकते हैं. इसके अलावा, ये किसी तीसरे पक्ष के उस डेटा से भी मिल सकते हैं जिसे आपने इंडेक्स किया है.

ध्यान दें: इस एपीआई को चलाने के लिए, स्टैंडर्ड असली उपयोगकर्ता खाते की ज़रूरत होती है. सेवा खाता, सीधे तौर पर क्वेरी एपीआई के अनुरोधों को पूरा नहीं कर सकता. क्वेरी करने के लिए, सेवा खाते का इस्तेमाल करने के लिए, Google Workspace के डोमेन के लिए, अधिकार देने की सुविधा सेट अप करें.

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

POST https://cloudsearch.googleapis.com/v1/query/search

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

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

अनुरोध के मुख्य भाग में नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:

JSON के काेड में दिखाना 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "pageSize": integer,
  "start": integer,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ],
  "facetOptions": [
    {
      object (FacetOptions)
    }
  ],
  "sortOptions": {
    object (SortOptions)
  },
  "queryInterpretationOptions": {
    object (QueryInterpretationOptions)
  },
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
फ़ील्ड
requestOptions

object (RequestOptions)

अनुरोध के विकल्प, जैसे कि खोज ऐप्लिकेशन और उपयोगकर्ता का टाइमज़ोन.
query

string

रॉ क्वेरी स्ट्रिंग. ऑपरेटर की मदद से खोज के सटीक नतीजे पाना में, काम करने वाले खोज ऑपरेटर देखें
pageSize

integer

एक पेज पर खोज के नतीजों की ज़्यादा से ज़्यादा संख्या. मान्य वैल्यू 1 से 100 के बीच होनी चाहिए. डिफ़ॉल्ट वैल्यू 10 है. अगर 2,000 से ज़्यादा नतीजों का अनुरोध किया जाता है, तो कम से कम वैल्यू 50 होनी चाहिए.
start

integer

नतीजों का शुरुआती इंडेक्स.
dataSourceRestrictions[]

object (DataSourceRestriction)

क्वेरी करने के लिए इस्तेमाल किए जाने वाले सोर्स. अगर कोई डेटा सोर्स नहीं चुना जाता है, तो मौजूदा सर्च ऐप्लिकेशन के सभी डेटा सोर्स का इस्तेमाल किया जाता है.
facetOptions[]

object (FacetOptions)
sortOptions

object (SortOptions)

खोज के नतीजों को क्रम से लगाने के विकल्प
queryInterpretationOptions

object (QueryInterpretationOptions)

उपयोगकर्ता की क्वेरी को समझने के लिए विकल्प.
contextAttributes[]

object (ContextAttribute)

अनुरोध के लिए कॉन्टेक्स्ट एट्रिब्यूट, जिनका इस्तेमाल खोज के नतीजों की रैंकिंग में बदलाव करने के लिए किया जाएगा. एलिमेंट की ज़्यादा से ज़्यादा संख्या 10 हो सकती है.

जवाब का मुख्य भाग

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

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

इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.