Method: query.sources.list

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

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

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

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

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

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

पैरामीटर
requestOptions

object (RequestOptions)

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

pageToken

string

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

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

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

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

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

सोर्स के जवाब की सूची बनाएं.

जेएसओएन के काेड में दिखाना
{
  "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

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

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

object (Source)

सोर्स का नाम

shortName

string

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

displayName

string

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

operators[]

object (QueryOperator)

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

QueryOperator

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

जेएसओएन के काेड में दिखाना
{
  "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