Method: query.suggest

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

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

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

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

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

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

अनुरोध के मुख्य हिस्से में इस तरह का डेटा शामिल होता है:

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

object (RequestOptions)

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

string

ऐसी आंशिक क्वेरी जिसके लिए अपने-आप पूरा होने वाले सुझाव दिखाए जाएंगे. उदाहरण के लिए, अगर क्वेरी "सी" है, तो सर्वर "सीज़न", "सर्च", "सीगल" वगैरह दिखा सकता है.
dataSourceRestrictions[]

object (DataSourceRestriction)

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

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

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

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

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

सुझाए गए एपीआई का रिस्पॉन्स.

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

object (SuggestResult)

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

अनुमति पाने के लिंक

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

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

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

SuggestResult

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

जेएसओएन के काेड में दिखाना 
{
  "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. इसमें सुझाई गई क्वेरी के बारे में अतिरिक्त मेटाडेटा होता है. इससे यह भी पता चलता है कि सुझाई गई क्वेरी किस तरह की है. उदाहरण के लिए, अगर लोगों का सुझाव मौजूद है, तो यह बताता है कि suggested_query व्यक्ति का सुझाव है. suggestion इनमें से सिर्फ़ एक हो सकता है:
querySuggestion

object (QuerySuggestion)

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

object (PeopleSuggestion)

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

QuerySuggestion

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

PeopleSuggestion

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

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

object (Person)

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