- एचटीटीपी अनुरोध
 - पाथ पैरामीटर
 - अनुरोध का मुख्य हिस्सा
 - जवाब का मुख्य हिस्सा
 - अनुमति पाने के लिंक
 - IndexItemOptions
 - इसे आज़माएं!
 
Item एसीएल, मेटाडेटा, और कॉन्टेंट को अपडेट करता है. अगर Item मौजूद नहीं है, तो यह उसे डाल देगा. इस तरीके से, कुछ हिस्से को अपडेट नहीं किया जा सकता. जिन फ़ील्ड में कोई वैल्यू नहीं दी गई है उन्हें Cloud Search के इंडेक्स से हटा दिया जाता है.
इस एपीआई को चलाने के लिए, एडमिन या सेवा खाते की ज़रूरत होती है. इस्तेमाल किया गया सेवा खाता, उस डेटा सोर्स में मौजूद व्हाइटलिस्ट में शामिल होता है.
एचटीटीपी अनुरोध
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
item.name | 
                
                   
 आइटम का नाम. फ़ॉर्मैट: datasources/{sourceId}/items/{itemId} यह अनिवार्य फ़ील्ड है. इसमें 1536 से ज़्यादा वर्ण नहीं हो सकते.  | 
              
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में नीचे दिए गए स्ट्रक्चर वाला डेटा होता है:
| JSON के काेड में दिखाना | 
|---|
{ "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum (  | 
                
| फ़ील्ड | |
|---|---|
item.acl | 
                  
                     
 इस आइटम के लिए ऐक्सेस कंट्रोल की सूची.  | 
                
item.metadata | 
                  
                     
 मेटाडेटा की जानकारी.  | 
                
item.structuredData | 
                  
                     
 आइटम का स्ट्रक्चर्ड डेटा, जो डेटा सोर्स के स्कीमा में रजिस्टर किए गए ऑब्जेक्ट की परिभाषा के मुताबिक होना चाहिए.  | 
                
item.content | 
                  
                     
 आइटम का ऐसा कॉन्टेंट जिसे इंडेक्स किया जाना है और जिसे टेक्स्ट के तौर पर खोजा जा सकता है.  | 
                
item.version | 
                  
                     
 ज़रूरी है. इंडेक्स करने वाला सिस्टम, डेटा सोर्स के वर्शन को बाइट स्ट्रिंग के तौर पर सेव करता है. साथ ही, इंडेक्स में मौजूद आइटम के वर्शन की तुलना, लीक्सिकल ऑर्डर का इस्तेमाल करके, सूची में शामिल आइटम के वर्शन से करता है. Cloud Search Indexing, सूची में मौजूद किसी भी ऐसे आइटम को इंडेक्स या मिटा नहीं देगा जिसका वर्शन, इंडेक्स किए गए मौजूदा आइटम के वर्शन से कम या उसके बराबर हो. इस फ़ील्ड की लंबाई ज़्यादा से ज़्यादा 1024 बाइट हो सकती है. आइटम के वर्शन का, आइटम मिटाने की प्रोसेस पर क्या असर पड़ता है, इस बारे में जानने के लिए मैन्युअल तरीके से आइटम मिटाने के बाद, बदलावों को मैनेज करना लेख पढ़ें. base64 कोड में बदली गई स्ट्रिंग.  | 
                
item.status | 
                  
                     
 आइटम की स्थिति. सिर्फ़ आउटपुट के लिए फ़ील्ड.  | 
                
item.queue | 
                  
                     
 इस आइटम की सूची. इसमें 100 से ज़्यादा वर्ण नहीं हो सकते.  | 
                
item.payload | 
                  
                     
 इस आइटम के लिए, अतिरिक्त स्टेटस कनेक्टर सेव किया जा सकता है. इस फ़ील्ड की लंबाई ज़्यादा से ज़्यादा 10,000 बाइट हो सकती है. base64 कोड में बदली गई स्ट्रिंग.  | 
                
item.itemType | 
                  
                     
 इस आइटम का टाइप.  | 
                
connectorName | 
                  
                     
 यह कॉल करने वाले कनेक्टर का नाम. फ़ॉर्मैट: datasources/{sourceId}/connectors/{id}  | 
                
mode | 
                  
                     
 ज़रूरी है. इस अनुरोध के लिए RequestMode.  | 
                
debugOptions | 
                  
                     
 डीबग करने के सामान्य विकल्प.  | 
                
indexItemOptions | 
                  
                     
  | 
                
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में Operation का एक इंस्टेंस शामिल किया जाता है.
अनुमति के दायरे
इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/cloud_search.indexinghttps://www.googleapis.com/auth/cloud_search
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.
IndexItemOptions
| JSON के काेड में दिखाना | 
|---|
{ "allowUnknownGsuitePrincipals": boolean }  | 
              
| फ़ील्ड | |
|---|---|
allowUnknownGsuitePrincipals | 
                
                   
 इससे यह तय होता है कि इंडेक्स करने के अनुरोध में, Google Workspace के ऐसे प्रिंसिपल को अनुमति दी जानी चाहिए जो मौजूद नहीं हैं या मिटा दिए गए हैं.  |