Method: query.sources.list

उन सोर्स की सूची दिखाता है जिनका इस्तेमाल उपयोगकर्ता, Search और Suggest API के लिए कर सकता है.

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

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

GET https://cloudsearch.googleapis.com/v1/query/sources

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

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

पैरामीटर
requestOptions

object (RequestOptions)

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

string

जवाब में दिखाए जाने वाले सोर्स की संख्या.

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

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

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

सोर्स की सूची और उसके नतीजे.

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

JSON के काेड में दिखाना 
{
  "sources": [
    {
      object (QuerySource)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
sources[]

object (QuerySource)
nextPageToken

string

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

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

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

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

QuerySource

उन सोर्स की सूची जिन्हें उपयोगकर्ता, क्वेरी एपीआई का इस्तेमाल करके खोज सकता है.

JSON के काेड में दिखाना 
{
  "source": {
    object (Source)
  },
  "shortName": string,
  "displayName": string,
  "operators": [
    {
      object (QueryOperator)
    }
  ]
}
फ़ील्ड
source

object (Source)

सोर्स का नाम
shortName

string

सोर्स का छोटा नाम या कोई दूसरा नाम. इस वैल्यू का इस्तेमाल, 'सोर्स' ऑपरेटर के साथ किया जा सकता है.
displayName

string

डेटा सोर्स का डिसप्ले नेम.
operators[]

object (QueryOperator)

इस सोर्स के लिए लागू सभी ऑपरेटर की सूची.

QueryOperator

किसी ऐसे ऑपरेटर की परिभाषा जिसका इस्तेमाल Search/query.suggest अनुरोध में किया जा सकता है.

JSON के काेड में दिखाना 
{
  "operatorName": string,
  "lessThanOperatorName": string,
  "greaterThanOperatorName": string,
  "type": enum (QueryOperator.Type),
  "displayName": string,
  "isSortable": boolean,
  "isFacetable": boolean,
  "isReturnable": boolean,
  "isRepeatable": boolean,
  "isSuggestable": boolean,
  "enumValues": [
    string
  ],
  "objectType": string
}
फ़ील्ड
operatorName

string

ऑपरेटर का नाम.
lessThanOperatorName

string

ऑपरेटर का नाम दिखाता है. इसका इस्तेमाल, कम-से-कम ऑपरेटर का इस्तेमाल करके प्रॉपर्टी को अलग करने के लिए किया जा सकता है.
greaterThanOperatorName

string

ऑपरेटर का नाम दिखाता है. इसका इस्तेमाल, 'इससे ज़्यादा' ऑपरेटर का इस्तेमाल करके प्रॉपर्टी को अलग करने के लिए किया जा सकता है.
type

enum (QueryOperator.Type)

ऑपरेटर का टाइप.
displayName

string

ऑपरेटर का डिसप्ले नेम
isSortable

boolean

क्या इस ऑपरेटर का इस्तेमाल नतीजों को क्रम से लगाने के लिए किया जा सकता है.
isFacetable

boolean

क्या इस ऑपरेटर का इस्तेमाल फ़ेसेट पाने के लिए किया जा सकता है.
isReturnable

boolean

क्या इस फ़ेसेट से जुड़ी प्रॉपर्टी, खोज के नतीजों के हिस्से के तौर पर दिखाई जाएगी.
isRepeatable

boolean

इससे पता चलता है कि इस प्रॉपर्टी के लिए एक से ज़्यादा वैल्यू सेट की जा सकती हैं या नहीं.
isSuggestable

boolean

इस फ़ील्ड के लिए सुझाव मिल सकते हैं.
enumValues[]

string

ऑपरेटर फ़ील्ड के लिए वैल्यू की संभावित सूची. यह फ़ील्ड सिर्फ़ तब भरा जाता है, जब हम इस ऑपरेटर की सभी संभावित वैल्यू को सुरक्षित तरीके से बता सकें.
objectType

string

ऑपरेटर से जुड़े ऑब्जेक्ट का नाम. यह फ़ील्ड सिर्फ़ स्कीमा के हिसाब से ऑपरेटर के लिए भरा जाता है. सामान्य ऑपरेटर के लिए, इसे अनसेट किया जाता है.

QueryOperator.Type

ऑपरेटर की ओर से रेफ़र की गई प्रॉपर्टी का टाइप.

Enums
UNKNOWN अमान्य मान.
INTEGER
DOUBLE
TIMESTAMP
BOOLEAN
ENUM
DATE
TEXT
HTML