Method: query.suggest

क्वेरी को अपने-आप पूरा करने के लिए सुझाव देता है.

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

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

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

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

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

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

JSON के काेड में दिखाना 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
फ़ील्ड
requestOptions

object (RequestOptions)

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

string

वह क्वेरी जिसे ऑटोकंप्लीट की सुविधा की मदद से पूरा किया जा सकता है. उदाहरण के लिए, अगर क्वेरी "sea" है, तो सर्वर "season", "search", "seagull" वगैरह दिखा सकता है.
dataSourceRestrictions[]

object (DataSourceRestriction)

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

ध्यान दें: सुझाव सिर्फ़ इन सोर्स के लिए काम करते हैं:

  • तीसरे पक्ष के डेटा सोर्स
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

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

suggest API का रिस्पॉन्स.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
फ़ील्ड
suggestResults[]

object (SuggestResult)

सुझावों की सूची.

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

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

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

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

SuggestResult

सुझाव का एक नतीजा.

JSON के काेड में दिखाना 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
फ़ील्ड
suggestedQuery

string

सुझाई गई क्वेरी, जिसका इस्तेमाल खोज के लिए किया जाएगा. ऐसा तब होगा, जब उपयोगकर्ता सुझाव पर क्लिक करेगा
source

object (Source)

सुझाव का सोर्स.
यूनियन फ़ील्ड suggestion. इसमें सुझाई गई क्वेरी के बारे में ज़्यादा मेटाडेटा होता है. इससे यह भी पता चलता है कि सुझाई गई क्वेरी किस तरह की है. उदाहरण के लिए, अगर PeopleSuggestion मौजूद है, तो इसका मतलब है कि suggested_query, किसी व्यक्ति का सुझाव है. suggestion इनमें से कोई एक हो सकता है:
querySuggestion

object (QuerySuggestion)

यह फ़ील्ड तब दिखेगा, जब सुझाई गई क्वेरी, शब्द/वाक्यांश पूरा करने वाली हो.
peopleSuggestion

object (PeopleSuggestion)

यह तब दिखता है, जब सुझाव किसी व्यक्ति से जुड़ा हो. इसमें व्यक्ति के बारे में ज़्यादा जानकारी होती है. जैसे, उसका ईमेल आईडी, नाम वगैरह.

QuerySuggestion

इस टाइप में कोई फ़ील्ड नहीं होता.

फ़िलहाल, इस फ़ील्ड में कुछ भी नहीं है. इसका इस्तेमाल सिर्फ़ इस बात के बारे में बताने के लिए किया जाता है कि सुझाया गया नतीजा, वाक्यांश पूरा करने वाला था.

PeopleSuggestion

इस फ़ील्ड में, उस व्यक्ति के बारे में जानकारी होती है जिसका सुझाव दिया जा रहा है.

JSON के काेड में दिखाना 
{
  "person": {
    object (Person)
  }
}
फ़ील्ड
person

object (Person)

सुझाया गया व्यक्ति. हो सकता है कि व्यक्ति ऑब्जेक्ट के सभी फ़ील्ड में जानकारी न भरी गई हो.