Method: indexing.datasources.items.push

किसी आइटम को बाद में पोलिंग और अपडेट करने के लिए सूची में पुश करता है.

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

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

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

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

पाथ पैरामीटर

पैरामीटर
item.name

string

इंडेक्स करने की सूची में शामिल करने के लिए, item का नाम.

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

यह अनिवार्य फ़ील्ड है. ज़्यादा से ज़्यादा 1,536 वर्ण हो सकते हैं.

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

अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:

JSON के काेड में दिखाना 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
फ़ील्ड
item.type

enum (PushItem.Type)

पुश ऑपरेशन का वह टाइप, जो पुश के व्यवहार के बारे में बताता है.
item.metadataHash

string

रिपॉज़िटरी के हिसाब से आइटम का मेटाडेटा हैश. अगर बताया गया है, तो इसका इस्तेमाल यह तय करने के लिए किया जाता है कि इस आइटम की स्थिति में बदलाव कैसे किया जाए. इस फ़ील्ड और type फ़ील्ड को सेट करने पर, आर्ग्युमेंट में गड़बड़ी होती है. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.
item.structuredDataHash

string

डेटा स्टोर करने की जगह के हिसाब से, सामान का स्ट्रक्चर्ड डेटा हैश. अगर बताया गया है, तो इसका इस्तेमाल यह तय करने के लिए किया जाता है कि इस आइटम की स्थिति में बदलाव कैसे किया जाए. इस फ़ील्ड और type फ़ील्ड को सेट करने पर, आर्ग्युमेंट में गड़बड़ी होती है. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.
item.contentHash

string

डेटा स्टोर करने की जगह के हिसाब से आइटम का कॉन्टेंट हैश. अगर बताया गया है, तो इसका इस्तेमाल यह तय करने के लिए किया जाता है कि इस आइटम की स्थिति में बदलाव कैसे किया जाए. इस फ़ील्ड और type फ़ील्ड को सेट करने पर, आर्ग्युमेंट में गड़बड़ी होती है. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.
item.payload

string (bytes format)

कनेक्टर के लिए, दस्तावेज़ की स्थिति से जुड़ी ज़्यादा जानकारी देता है. जैसे, रिपॉज़िटरी का वैकल्पिक आईडी और अन्य मेटाडेटा. ज़्यादा से ज़्यादा 8,192 बाइट होना चाहिए.

base64 कोड में बदली गई स्ट्रिंग.
item.queue

string

वह सूची जिससे यह आइटम जुड़ा है. अगर इस फ़ील्ड में जानकारी नहीं दी गई है, तो default सूची को चुना जाता है. इसमें 512 से ज़्यादा वर्ण नहीं होने चाहिए.
item.repositoryError

object (RepositoryError)

कनेक्टर या डेटा स्टोर करने की जगह से जुड़ी गड़बड़ी की जानकारी सेव करने के लिए, इस फ़ील्ड को भरें. यह जानकारी Admin console में दिखती है. इस फ़ील्ड में जानकारी सिर्फ़ तब भरी जा सकती है, जब type REPOSITORY_ERROR पर हो.
connectorName

string

इस कॉल को करने वाले कनेक्टर का नाम.

फ़ॉर्मैट: datasources/{sourceId}/कनेक्टर/{ID}
debugOptions

object (DebugOptions)

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

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

कामयाब रहने पर, जवाब के मुख्य हिस्से में Item का एक इंस्टेंस शामिल किया जाता है.

अनुमति पाने के लिंक

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

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

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

PushItem

यह किसी आइटम को इंडेक्स करने की सूची में पुश किए जाने वाले आइटम के बारे में बताता है.

JSON के काेड में दिखाना 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
फ़ील्ड
name

string

इंडेक्स करने की सूची में शामिल करने के लिए, item का नाम.

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

यह अनिवार्य फ़ील्ड है. ज़्यादा से ज़्यादा 1,536 वर्ण हो सकते हैं.
type

enum (PushItem.Type)

पुश ऑपरेशन का वह टाइप, जो पुश के व्यवहार के बारे में बताता है.
metadataHash

string

रिपॉज़िटरी के हिसाब से आइटम का मेटाडेटा हैश. अगर बताया गया है, तो इसका इस्तेमाल यह तय करने के लिए किया जाता है कि इस आइटम की स्थिति में बदलाव कैसे किया जाए. इस फ़ील्ड और type फ़ील्ड को सेट करने पर, आर्ग्युमेंट में गड़बड़ी होती है. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.
structuredDataHash

string

डेटा स्टोर करने की जगह के हिसाब से, सामान का स्ट्रक्चर्ड डेटा हैश. अगर बताया गया है, तो इसका इस्तेमाल यह तय करने के लिए किया जाता है कि इस आइटम की स्थिति में बदलाव कैसे किया जाए. इस फ़ील्ड और type फ़ील्ड को सेट करने पर, आर्ग्युमेंट में गड़बड़ी होती है. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.
contentHash

string

डेटा स्टोर करने की जगह के हिसाब से आइटम का कॉन्टेंट हैश. अगर बताया गया है, तो इसका इस्तेमाल यह तय करने के लिए किया जाता है कि इस आइटम की स्थिति में बदलाव कैसे किया जाए. इस फ़ील्ड और type फ़ील्ड को सेट करने पर, आर्ग्युमेंट में गड़बड़ी होती है. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.
payload

string (bytes format)

कनेक्टर के लिए, दस्तावेज़ की स्थिति से जुड़ी ज़्यादा जानकारी देता है. जैसे, रिपॉज़िटरी का वैकल्पिक आईडी और अन्य मेटाडेटा. ज़्यादा से ज़्यादा 8,192 बाइट होना चाहिए.

base64 कोड में बदली गई स्ट्रिंग.
queue

string

वह सूची जिससे यह आइटम जुड़ा है. अगर इस फ़ील्ड में जानकारी नहीं दी गई है, तो default सूची को चुना जाता है. इसमें 512 से ज़्यादा वर्ण नहीं होने चाहिए.
repositoryError

object (RepositoryError)

कनेक्टर या डेटा स्टोर करने की जगह से जुड़ी गड़बड़ी की जानकारी सेव करने के लिए, इस फ़ील्ड को भरें. यह जानकारी Admin console में दिखती है. इस फ़ील्ड में जानकारी सिर्फ़ तब भरी जा सकती है, जब type REPOSITORY_ERROR पर हो.

PushItem.Type

पुश ऑपरेशन का वह टाइप, जो पुश के व्यवहार के बारे में बताता है.

Enums
UNSPECIFIED डिफ़ॉल्ट तौर पर जानकारी उपलब्ध नहीं है. इससे पता चलता है कि पुश कार्रवाई से ItemStatus में बदलाव नहीं होना चाहिए
MODIFIED इससे पता चलता है कि डेटा स्टोर करने की जगह के दस्तावेज़ में, पिछले update कॉल के बाद बदलाव किया गया है या उसे अपडेट किया गया है. इससे किसी मौजूदा आइटम की स्थिति बदलकर MODIFIED हो जाती है. अगर इसे किसी ऐसे आइटम पर कॉल किया जाता है जो मौजूद नहीं है, तो स्टेटस NEW_ITEM में बदल जाता है.
NOT_MODIFIED पिछले अपडेट कॉल के बाद से, डेटा स्टोर करने की जगह के आइटम में कोई बदलाव नहीं किया गया है. इस पुश कार्रवाई से स्थिति ACCEPTED स्थिति पर सेट हो जाएगी.
REPOSITORY_ERROR इस आइटम के संबंध में कनेक्टर को रिपॉज़िटरी की गड़बड़ी का सामना करना पड़ रहा है. स्टेटस को REPOSITORY_ERROR के तौर पर सेट करें. एक्स्पोनेंशियल बैकऑफ़ के आधार पर, यह आइटम रिज़र्व नहीं किया गया है और इसे आने वाले समय में फिर से शेड्यूल किया गया है.
REQUEUE सिर्फ़ रिज़र्व किए गए आइटम के लिए 'ज़रूरी है' के साथ कॉल पुश करें. इस कार्रवाई से आइटम का रिज़र्वेशन हो जाता है और उसके उपलब्ध समय को वॉल क्लॉक के समय पर रीसेट कर दिया जाता है.