- एचटीटीपी अनुरोध
 - पाथ पैरामीटर
 - अनुरोध का मुख्य हिस्सा
 - जवाब का मुख्य हिस्सा
 - अनुमति पाने के लिंक
 - इसे आज़माएं!
 
इंडेक्स करने की सूची में से, ऐसे आइटम चुनता है जिन्हें बुक नहीं किया गया है. साथ ही, किसी सेट को बुक के तौर पर मार्क करता है. यह सेट, सबसे ज़्यादा प्राथमिकता वाले ItemStatus आइटम से शुरू होता है, जिनका टाइमस्टैंप सबसे पुराना होता है. प्राथमिकता का क्रम इस तरह से है:
आइटम रिज़र्व करने से यह पक्का होता है कि अन्य थ्रेड से पोलिंग करने पर, ओवरलैप होने वाले सेट न बनें.
रिज़र्व किए गए आइटम मैनेज करने के बाद, क्लाइंट को आइटम को फिर से रिज़र्व नहीं किए गए आइटम की स्थिति में डालना चाहिए. इसके लिए, index, को कॉल करें या push को टाइप REQUEUE. के साथ कॉल करें
चार घंटे बाद, आइटम अपने-आप उपलब्ध हो जाते हैं (बुक नहीं किए जाते). भले ही, कोई अपडेट या पुश तरीका न बुलाया गया हो.
इस एपीआई को चलाने के लिए, एडमिन या सेवा खाते की ज़रूरत होती है. इस्तेमाल किया गया सेवा खाता, उस डेटा सोर्स में मौजूद व्हाइटलिस्ट में शामिल होता है.
एचटीटीपी अनुरोध
POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
name | 
                
                   
 आइटम के लिए पोल करने वाले डेटा सोर्स का नाम. फ़ॉर्मैट: datasources/{sourceId}  | 
              
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:
| JSON के काेड में दिखाना | 
|---|
{ "connectorName": string, "statusCodes": [ enum (  | 
                
| फ़ील्ड | |
|---|---|
connectorName | 
                  
                     
 यह कॉल करने वाले कनेक्टर का नाम. फ़ॉर्मैट: datasources/{sourceId}/connectors/{id}  | 
                
statusCodes[] | 
                  
                     
 सिर्फ़ उन आइटम के लिए पोल करें जिनका स्टेटस इनमें से कोई एक है.  | 
                
limit | 
                  
                     
 ज़्यादा से ज़्यादा कितने आइटम लौटाए जा सकते हैं. इसकी ज़्यादा से ज़्यादा वैल्यू 100 और डिफ़ॉल्ट वैल्यू 20 होती है.  | 
                
queue | 
                  
                     
 आइटम फ़ेच करने के लिए, सूची का नाम. अगर कोई वैल्यू नहीं दी जाती है, तो items.poll 'डिफ़ॉल्ट' सूची से फ़ेच करेगा. इसमें 100 से ज़्यादा वर्ण नहीं हो सकते.  | 
                
debugOptions | 
                  
                     
 डीबग करने के सामान्य विकल्प.  | 
                
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
| JSON के काेड में दिखाना | 
|---|
{
  "items": [
    {
      object ( | 
                  
| फ़ील्ड | |
|---|---|
items[] | 
                    
                       
 कनेक्टर के लिए प्रोसेस करने के लिए, सूची में मौजूद आइटम का सेट. इन आइटम में, फ़ील्ड के ये सबसेट पॉप्युलेट होते हैं:  | 
                  
अनुमति के दायरे
इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/cloud_search.indexinghttps://www.googleapis.com/auth/cloud_search
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.