Method: indexing.datasources.items.list

Item resources के सभी या किसी सबसेट की सूची बनाता है.

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

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

GET https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items

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

पाथ पैरामीटर

पैरामीटर
name

string

आइटम की सूची बनाने के लिए डेटा सोर्स का नाम. फ़ॉर्मैट: datasources/{sourceId}

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

पैरामीटर
connectorName

string

यह कॉल करने वाले कनेक्टर का नाम.

फ़ॉर्मैट: datasources/{sourceId}/connectors/{ID}

brief

boolean

'सही' पर सेट होने पर, इंडेक्स करने वाला सिस्टम सिर्फ़ इन फ़ील्ड को पॉप्युलेट करता है: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structuredData.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type,

अगर यह वैल्यू 'गलत' है, तो आइटम में सभी फ़ील्ड अपने-आप पॉप्युलेट हो जाते हैं.

pageToken

string

अगर सूची के लिए किए गए किसी पिछले अनुरोध से nextPageToken वैल्यू मिली है, तो वह वैल्यू.

pageSize

integer

एक अनुरोध में फ़ेच किए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या. brief के सही होने पर, मैक्स वैल्यू 1,000 होती है. अगर brief की वैल्यू 'गलत' है, तो ज़्यादा से ज़्यादा वैल्यू 10 हो सकती है.

डिफ़ॉल्ट वैल्यू 10 है

debugOptions

object (DebugOptions)

डीबग करने के सामान्य विकल्प.

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

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

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

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

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

object (Item)

nextPageToken

string

नतीजों के अगले पेज को वापस लाने के लिए टोकन. अगर सूची में कोई और नतीजा नहीं है, तो यह खाली होता है.

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

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

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

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