REST Resource: indexing.datasources.items

रिसॉर्स: आइटम

एक ऑब्जेक्ट दिखाता है जो Search इंडेक्स में मौजूद एक आइटम होता है. जैसे, कोई फ़ाइल, फ़ोल्डर या डेटाबेस रिकॉर्ड.

JSON के काेड में दिखाना 
{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}
फ़ील्ड
name

string

आइटम का नाम. फ़ॉर्मैट: datasources/{sourceId}/items/{itemId}

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

object (ItemAcl)

इस आइटम के लिए ऐक्सेस कंट्रोल की सूची.
metadata

object (ItemMetadata)

मेटाडेटा की जानकारी.
structuredData

object (ItemStructuredData)

आइटम के लिए वह स्ट्रक्चर्ड डेटा जिसे डेटा सोर्स के स्कीमा में रजिस्टर किए गए ऑब्जेक्ट की परिभाषा के मुताबिक होना चाहिए.
content

object (ItemContent)

आइटम का कॉन्टेंट इंडेक्स करना और टेक्स्ट खोजने लायक बनाना.
version

string (bytes format)

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

Cloud Search इंडेक्स करने से, सूची में मौजूद ऐसे किसी भी आइटम को न तो इंडेक्स किया जाएगा और न ही मिटाया जाएगा जिसका वर्शन वैल्यू, इंडेक्स किए गए मौजूदा आइटम के वर्शन से कम या उसके बराबर है. इस फ़ील्ड की लंबाई ज़्यादा से ज़्यादा 1024 बाइट होती है.

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

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

object (ItemStatus)

आइटम की स्थिति. सिर्फ़ आउटपुट वाला फ़ील्ड.
queue

string

सूची में यह आइटम जोड़ें. ज़्यादा से ज़्यादा 100 वर्ण हाेने चाहिए.
payload

string (bytes format)

राज्य का दूसरा कनेक्टर इस आइटम को स्टोर कर सकता है. ज़्यादा से ज़्यादा लंबाई 10000 बाइट होती है.

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

enum (Item.ItemType)

इस आइटम का टाइप.

ItemAcl

आइटम की ऐक्सेस कंट्रोल लिस्ट की जानकारी. ज़्यादा जानकारी के लिए मैप ACL देखें.

JSON के काेड में दिखाना 
{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}
फ़ील्ड
inheritAclFrom

string

उस आइटम का नाम जिससे ऐक्सेस की अनुमति वाली सूची (एसीएल) इनहेरिट की जानी है. ध्यान दें: एसीएल इनहेरिटेंस सिर्फ़ चाइल्ड आइटम को ऐक्सेस करने की अनुमतियां देती है. यह स्ट्रक्चर के संबंध को तय नहीं करती है. इसके अलावा, यह आइटम के बड़े ग्रुप को मिटाने के आसान तरीके भी उपलब्ध नहीं कराती है. इंडेक्स से किसी ACL पैरंट को मिटाने से, सिर्फ़ उन चाइल्ड आइटम की ऐक्सेस अनुमतियां बदलती हैं जो inheritAclFrom फ़ील्ड में पैरंट पैरंट के बारे में बताती हैं. आइटम अब भी इंडेक्स में है, लेकिन हो सकता है कि खोज के नतीजों में न दिखे. इसके उलट, किसी कंटेनर आइटम को मिटाने से, containerName फ़ील्ड के ज़रिए कंटेनर का रेफ़रंस देने वाले सभी आइटम भी मिट जाते हैं. इस फ़ील्ड में ज़्यादा से ज़्यादा 1,536 वर्ण हो सकते हैं.
aclInheritanceType

enum (ItemAcl.AclInheritanceType)

जब किसी आइटम को पैरंट से अपना ACL इनहेरिट होता है, तब लागू किए जाने वाले ऐक्सेस के नियम सेट करता है. इसे हमेशा inheritAclFrom फ़ील्ड के साथ सेट किया जाना चाहिए. साथ ही, जब inheritAclFrom फ़ील्ड को सेट किया जाता है, तो इस फ़ील्ड को मान्य AclInheritanceType पर सेट करना चाहिए.
readers[]

object (Principal)

उन मुख्य खातों की सूची जिन्हें खोज परिणामों में आइटम देखने की अनुमति है. यह तब ज़रूरी नहीं है, जब किसी अन्य आइटम से अनुमतियां इनहेरिट की जा रही हों या आइटम को दिखाने के लिए न बनाया गया हो, जैसे कि virtual containers. एलिमेंट की संख्या ज़्यादा से ज़्यादा 1000 हो सकती है.
deniedReaders[]

object (Principal)

उन मुख्य खातों की सूची जिन्हें खोज नतीजों में किसी आइटम का ऐक्सेस साफ़ तौर पर नहीं दिया गया है. हालांकि, प्रिंसिपल के ऐक्सेस की अनुमति डिफ़ॉल्ट रूप से नहीं दी जाती है. हालांकि, अपवादों को मैनेज करने और अनुमति वाले पाठकों की सूची को बदलने के लिए, मुख्य खातों को अनुमति वाली सूची में शामिल करने की अनुमति नहीं है. एलिमेंट की संख्या ज़्यादा से ज़्यादा 100 हो सकती है.
owners[]

object (Principal)

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

ItemAcl.AclInheritanceType

ACL इनहेरिटेंस के टाइप.

Enums
NOT_APPLICABLE यह डिफ़ॉल्ट वैल्यू होती है, जब इस आइटम को किसी ACL को इनहेरिट नहीं किया जाता. inheritAclFrom के खाली होने पर NOT_APPLICABLE का इस्तेमाल करें. बिना ACL इनहेरिटेंस वाले आइटम में अब भी उसके अपने readers और deniedReaders फ़ील्ड से ACL हो सकते हैं.
CHILD_OVERRIDE अनुमति देने से जुड़े विवाद के दौरान, चाइल्ड आइटम का ACL यह तय करता है कि उसे पढ़ने का ऐक्सेस किस तरह का है.
PARENT_OVERRIDE अनुमति से जुड़े विवाद के दौरान, inheritAclFrom फ़ील्ड में बताए गए पैरंट आइटम का ACL, पढ़ने का ऐक्सेस तय करता है.
BOTH_PERMIT इस आइटम और inheritAclFrom फ़ील्ड में बताए गए पैरंट आइटम, दोनों को पढ़ने का ऐक्सेस तभी दिया जाता है, जब पढ़ने का ऐक्सेस दिया गया हो.

मुख्य रकम

किसी उपयोगकर्ता, ग्रुप या डोमेन के बारे में जानकारी.

JSON के काेड में दिखाना 
{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}
फ़ील्ड

यूनियन फ़ील्ड principal.

principal इनमें से सिर्फ़ एक हो सकता है:
gsuitePrincipal

object (GSuitePrincipal)

यह मुख्य खाता, Google Workspace के उपयोगकर्ता, ग्रुप या डोमेन का है.
userResourceName

string

यह मुख्य खाता एक उपयोगकर्ता है जिसकी पहचान बाहरी पहचान का इस्तेमाल करके की गई है. नाम वाले फ़ील्ड में, उपयोगकर्ता के संसाधन का नाम इस फ़ॉर्मैट में होना चाहिए: Identitysources/{sourceId}/users/{ID}
groupResourceName

string

यह मुख्य खाता एक समूह है, जिसकी पहचान बाहरी पहचान का इस्तेमाल करके की गई है. नाम वाले फ़ील्ड में, ग्रुप के संसाधन का नाम इस फ़ॉर्मैट में होना चाहिए: Identitysources/{sourceId}/groups/{ID}

ItemMetadata

आइटम के लिए उपलब्ध मेटाडेटा फ़ील्ड.

JSON के काेड में दिखाना 
{
  "title": string,
  "sourceRepositoryUrl": string,
  "containerName": string,
  "objectType": string,
  "createTime": string,
  "updateTime": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "contentLanguage": string,
  "mimeType": string,
  "searchQualityMetadata": {
    object (SearchQualityMetadata)
  },
  "keywords": [
    string
  ],
  "hash": string,
  "contextAttributes": [
    {
      object (ContextAttribute)
    }
  ]
}
फ़ील्ड
title

string

आइटम का टाइटल. अगर दिया गया है, तो यह query.search के नतीजे का दिखाया जाने वाला टाइटल होगा. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.
sourceRepositoryUrl

string

डेटा दिखाने वाले सोर्स डेटा स्टोर करने की जगह का लिंक. खोज के नतीजे, इस लिंक को टाइटल के साथ लागू करते हैं. व्हाइटस्पेस या खास वर्णों की वजह से, Cloud Seach के नतीजे के लिंक पर रीडायरेक्ट की सूचना ट्रिगर हो सकती है; इससे बचने के लिए, यूआरएल को कोड में बदलें. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.
containerName

string

इस आइटम के कंटेनर का नाम. कंटेनर आइटम को मिटाने पर यह आइटम अपने-आप मिट जाएगा. ध्यान दें: एसीएल किसी कंटेनर आइटम से नहीं लिए जाते हैं. किसी आइटम को ACL इनहेरिटेंस देने के लिए, inheritAclFrom फ़ील्ड का इस्तेमाल करें. ज़्यादा से ज़्यादा 1,536 वर्ण हो सकते हैं.
objectType

string

आइटम किस तरह का है. यह डेटा सोर्स के लिए रजिस्टर किए गए स्कीमा में मौजूद ऑब्जेक्ट की परिभाषा के नाम से मेल खाना चाहिए. उदाहरण के लिए, अगर डेटा सोर्स के स्कीमा में 'दस्तावेज़' नाम के साथ किसी ऑब्जेक्ट की परिभाषा शामिल है, तो उस टाइप के ऑब्जेक्ट के लिए, आइटम को इंडेक्स करने के अनुरोधों को ऑब्जेक्ट टाइप को 'document' पर सेट करना चाहिए. ज़्यादा से ज़्यादा 256 वर्ण हाेने चाहिए.
createTime

string (Timestamp format)

वह समय जब आइटम को सोर्स रिपॉज़िटरी में बनाया गया था.

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

सोर्स डेटा स्टोर करने की जगह में, आइटम में पिछली बार बदलाव किए जाने का समय.

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
interactions[]

object (Interaction)

आइटम के लिए इंटरैक्शन की सूची. इंटरैक्शन का इस्तेमाल, query.search की क्वालिटी को बेहतर बनाने के लिए किया जाता है. हालांकि, ये असली उपयोगकर्ताओं को नहीं दिखाए जाते. एलिमेंट की संख्या ज़्यादा से ज़्यादा 1000 हो सकती है.
contentLanguage

string

आइटम के लिए BCP-47 भाषा कोड, जैसे कि "en-US" या "sr-Latn" के रूप में जाना जाता है. ज़्यादा जानकारी के लिए, http://www.unicode.org/reports/tr35/#Unicode_locale_identifier देखें. ज़्यादा से ज़्यादा 32 वर्ण हो सकते हैं.
mimeType

string

सोर्स रिपॉज़िटरी में ItemContent.content का ओरिजनल माइम-टाइप. ज़्यादा से ज़्यादा 256 वर्ण हाेने चाहिए.
searchQualityMetadata

object (SearchQualityMetadata)

सामान की खोज की क्वालिटी से जुड़ा अन्य मेटाडेटा
keywords[]

string

आइटम से मेल खाने वाले दूसरे कीवर्ड या वाक्यांश. यूज़र जनरेटेड कॉन्टेंट के लिए अंदरूनी तौर पर इस्तेमाल किया जाता है. एलिमेंट की संख्या ज़्यादा से ज़्यादा 100 हो सकती है. ज़्यादा से ज़्यादा 8,192 वर्ण हो सकते हैं.
hash

string

एपीआई कॉलर से मिली हैशिंग वैल्यू. बदलाव की स्थिति का हिसाब लगाने के लिए, items.push तरीके के साथ इसका इस्तेमाल किया जा सकता है. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.
contextAttributes[]

object (ContextAttribute)

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

बातचीत

यह उपयोगकर्ता और आइटम के बीच होने वाले इंटरैक्शन को दिखाता है.

JSON के काेड में दिखाना 
{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}
फ़ील्ड
type

enum (Interaction.InteractionType)
principal

object (Principal)

आइटम पर कार्रवाई करने वाला उपयोगकर्ता.
interactionTime

string (Timestamp format)

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

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

Interaction.InteractionType

उपयोगकर्ता की ओर से आइटम पर की गई गतिविधि का प्रकार.

Enums
UNSPECIFIED अमान्य मान.
VIEW इस इंटरैक्शन से पता चलता है कि उपयोगकर्ता ने आइटम को देख लिया है.
EDIT इस इंटरैक्शन से पता चलता है कि उपयोगकर्ता ने आइटम में बदलाव किया है.

SearchQualityMetadata

आइटम की खोज की क्वालिटी से जुड़ा अतिरिक्त मेटाडेटा.

JSON के काेड में दिखाना 
{
  "quality": number
}
फ़ील्ड
quality

number

आइटम की क्वालिटी का संकेत, जिसका इस्तेमाल खोज की क्वालिटी पर असर डालने के लिए किया जाता है. वैल्यू 0.0 (सबसे कम क्वालिटी) और 1.0 (सबसे अच्छी क्वालिटी) के बीच होनी चाहिए. डिफ़ॉल्ट वैल्यू 0.0 है.

ContextAttribute

नाम वाला एट्रिब्यूट, जो किसी आइटम से जुड़ा होता है. इसका इस्तेमाल, अनुरोध में दिए गए कॉन्टेक्स्ट के आधार पर, सामान की रैंकिंग तय करने के लिए किया जा सकता है.

JSON के काेड में दिखाना 
{
  "name": string,
  "values": [
    string
  ]
}
फ़ील्ड
name

string

एट्रिब्यूट का नाम. इसे खाली नहीं छोड़ा जा सकता. ज़्यादा से ज़्यादा 32 वर्ण हो सकते हैं. नाम किसी अक्षर से शुरू होना चाहिए और उसमें सिर्फ़ अक्षर (A-Z, a-z) या अंक (0-9) हो सकते हैं. मिलान करने से पहले, नाम को नॉर्मलाइज़ (छोटे अक्षर) किया जाएगा.
values[]

string

एट्रिब्यूट की टेक्स्ट वैल्यू. एलिमेंट की संख्या ज़्यादा से ज़्यादा 10 हो सकती है. कलेक्शन में किसी एलिमेंट की लंबाई ज़्यादा से ज़्यादा 32 वर्ण हो सकती है. मैच होने से पहले, वैल्यू को नॉर्मलाइज़ (छोटे अक्षर) कर दिया जाएगा.

ItemStructuredData

आइटम के लिए उपलब्ध स्ट्रक्चर्ड डेटा फ़ील्ड.

JSON के काेड में दिखाना 
{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}
फ़ील्ड
object

object (StructuredDataObject)

वह स्ट्रक्चर्ड डेटा ऑब्जेक्ट जो डेटा सोर्स के लिए स्कीमा में रजिस्टर किए गए ऑब्जेक्ट की परिभाषा के मुताबिक होना चाहिए.
hash

string

एपीआई कॉलर से मिली हैशिंग वैल्यू. बदलाव की स्थिति का हिसाब लगाने के लिए, items.push तरीके के साथ इसका इस्तेमाल किया जा सकता है. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.

StructuredDataObject

स्ट्रक्चर्ड डेटा ऑब्जेक्ट, जिसमें नाम वाली प्रॉपर्टी शामिल होती हैं.

JSON के काेड में दिखाना 
{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}
फ़ील्ड
properties[]

object (NamedProperty)

ऑब्जेक्ट के लिए प्रॉपर्टी. एलिमेंट की संख्या ज़्यादा से ज़्यादा 1000 हो सकती है.

NamedProperty

स्ट्रक्चर्ड डेटा के लिए टाइप किया गया नाम और वैल्यू का जोड़ा. वैल्यू का टाइप, objectType के ऑब्जेक्ट की डेफ़िनिशन में मौजूद name प्रॉपर्टी के लिए रजिस्टर किए गए टाइप से मेल खाना चाहिए.

JSON के काेड में दिखाना 
{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}
फ़ील्ड
name

string

प्रॉपर्टी का नाम. यह नाम, उस प्रॉपर्टी के नाम से मेल खाना चाहिए जिसे स्कीमा में ऑब्जेक्ट की डेफ़िनिशन के लिए रजिस्टर किया गया था. इस प्रॉपर्टी में ज़्यादा से ज़्यादा 256 वर्ण हो सकते हैं.
यूनियन फ़ील्ड value. नाम वाली प्रॉपर्टी की वैल्यू. ध्यान दें कि किसी प्रॉपर्टी में सिर्फ़ एक तरह के मान हो सकते हैं. value इनमें से सिर्फ़ एक हो सकता है:
integerValues

object (NamedProperty.IntegerValues)
doubleValues

object (NamedProperty.DoubleValues)
timestampValues

object (NamedProperty.TimestampValues)
booleanValue

boolean
objectValues

object (NamedProperty.ObjectValues)
enumValues

object (NamedProperty.EnumValues)
dateValues

object (NamedProperty.DateValues)
textValues

object (NamedProperty.TextValues)
htmlValues

object (NamedProperty.HtmlValues)

NamedProperty.IntegerValues

पूर्णांक वैल्यू की सूची.

JSON के काेड में दिखाना 
{
  "values": [
    string
  ]
}
फ़ील्ड
values[]

string (int64 format)

NamedProperty.DoubleValues

डबल वैल्यू की सूची.

JSON के काेड में दिखाना 
{
  "values": [
    number
  ]
}
फ़ील्ड
values[]

number

NamedProperty.TimestampValues

टाइमस्टैंप की वैल्यू की सूची.

JSON के काेड में दिखाना 
{
  "values": [
    string
  ]
}
फ़ील्ड
values[]

string (Timestamp format)

आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

NamedProperty.ObjectValues

ऑब्जेक्ट वैल्यू की सूची.

JSON के काेड में दिखाना 
{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}
फ़ील्ड
values[]

object (StructuredDataObject)

NamedProperty.EnumValues

ईनम वैल्यू की सूची.

JSON के काेड में दिखाना 
{
  "values": [
    string
  ]
}
फ़ील्ड
values[]

string

स्ट्रिंग की वैल्यू में ज़्यादा से ज़्यादा 32 वर्ण हो सकते हैं.

NamedProperty.DateValues

तारीख की वैल्यू की सूची.

JSON के काेड में दिखाना 
{
  "values": [
    {
      object (Date)
    }
  ]
}
फ़ील्ड
values[]

object (Date)

NamedProperty.TextValues

टेक्स्ट वैल्यू की सूची.

JSON के काेड में दिखाना 
{
  "values": [
    string
  ]
}
फ़ील्ड
values[]

string

टेक्स्ट वैल्यू में ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.

NamedProperty.HtmlValues

एचटीएमएल वैल्यू की सूची.

JSON के काेड में दिखाना 
{
  "values": [
    string
  ]
}
फ़ील्ड
values[]

string

एचटीएमएल वैल्यू के लिए ज़्यादा से ज़्यादा 2048 वर्ण इस्तेमाल किए जा सकते हैं.

ItemContent

किसी आइटम का ऐसा कॉन्टेंट जिसे इंडेक्स करना है और जिसे Cloud Search में दिखाना है. inlineContent के तौर पर, सिर्फ़ UTF-8 कोड में बदली गई स्ट्रिंग का इस्तेमाल किया जा सकता है. अगर कॉन्टेंट अपलोड किया गया है और बाइनरी नहीं है, तो इसे UTF-8 कोड में बदलना ज़रूरी है.

JSON के काेड में दिखाना 
{
  "contentFormat": enum (ItemContent.ContentFormat),
  "hash": string,

  // Union field content can be only one of the following:
  "inlineContent": string,
  "contentDataRef": {
    object (UploadItemRef)
  }
  // End of list of possible types for union field content.
}
फ़ील्ड
contentFormat

enum (ItemContent.ContentFormat)
hash

string

कॉन्टेंट के लिए हैशिंग की जानकारी का हिसाब लगाकर, उसे एपीआई क्लाइंट उपलब्ध कराता है. बदलाव की स्थिति का हिसाब लगाने के लिए, items.push तरीके के साथ इसका इस्तेमाल किया जा सकता है. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.

यूनियन फ़ील्ड content.

content इनमें से सिर्फ़ एक हो सकता है:
inlineContent

string (bytes format)

वह कॉन्टेंट जिसकी सप्लाई अपडेट करने के तरीके के अंदर की जाती है. ज़्यादा से ज़्यादा लंबाई 102400 बाइट (100 केआईबी) होती है.

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

object (UploadItemRef)

लिखने के तरीके का इस्तेमाल करके, पहले अपलोड किए गए कॉन्टेंट का रेफ़रंस आईडी अपलोड करना.

ItemContent.ContentFormat

कॉन्टेंट का फ़ॉर्मैट. अगर कॉन्टेंट का फ़ॉर्मैट RAW है, तो कॉन्टेंट mimeType के तय किए गए फ़ॉर्मैट में होना चाहिए.

Enums
UNSPECIFIED अमान्य मान.
HTML contentफ़ॉर्मैट एचटीएमएल है.
TEXT contentफ़ॉर्मैट मुफ़्त टेक्स्ट होता है.
RAW contentफ़ॉर्मैट रॉ बाइट होता है.

UploadItemRef

अपलोड सेशन का रेफ़रंस दिखाता है. यह पहचान फ़ाइल, upload method की मदद से बनाई गई है. यह पहचान फ़ाइल, बनाए जाने के 30 दिन बाद तक मान्य होती है. आइटम के कॉन्टेंट को अपडेट करने से, contentDataRef की मदद से अपलोड किए गए इस कॉन्टेंट का रेफ़रंस मिल सकता है.

JSON के काेड में दिखाना 
{
  "name": string
}
फ़ील्ड
name

string

कॉन्टेंट के रेफ़रंस का नाम. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं.

ItemStatus

इसमें सामान की स्थिति और सभी गड़बड़ियां शामिल हैं.

JSON के काेड में दिखाना 
{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}
फ़ील्ड
code

enum (ItemStatus.Code)

स्थिति कोड.
processingErrors[]

object (ProcessingError)

आइटम के गड़बड़ी की स्थिति में होने पर, गड़बड़ी की जानकारी.
repositoryErrors[]

object (RepositoryError)

कनेक्टर ने डेटा स्टोर करने की जगह से जुड़ी गड़बड़ी की शिकायत की.

ProcessingError

JSON के काेड में दिखाना 
{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
फ़ील्ड
code

enum (ProcessingErrorCode)

गड़बड़ी किस तरह की है, यह बताने के लिए गड़बड़ी का कोड.
errorMessage

string

गड़बड़ी के बारे में जानकारी.
fieldViolations[]

object (FieldViolation)

अगर आइटम फ़ील्ड अमान्य हैं, तो इस फ़ील्ड में पुष्टि करने से जुड़ी गड़बड़ियों के बारे में जानकारी दी जाती है.

ProcessingErrorCode

Cloud Search सर्वर के आइटम प्रोसेस करने के दौरान आई गड़बड़ी को बताने के लिए कोड. किसी एक आइटम की प्रोसेसिंग से जुड़ी कई गड़बड़ियां हो सकती हैं.

Enums
PROCESSING_ERROR_CODE_UNSPECIFIED सिर्फ़ इनपुट करें. आइटम में इस वैल्यू का इस्तेमाल करें.
MALFORMED_REQUEST आइटम का ACL, मेटाडेटा या सामग्री गलत है या अमान्य स्थिति में है. फ़ील्ड के उल्लंघन की जांच में समस्या की ज़्यादा जानकारी मौजूद होती है.
UNSUPPORTED_CONTENT_FORMAT काउंटडाउन का यह फ़ॉर्मैट इस्तेमाल नहीं किया जा सकता.
INDIRECT_BROKEN_ACL ऐसे आइटम जिनमें एसीएल की पूरी जानकारी नहीं है, क्योंकि उनमें काम न करने वाले एसीएल वाले दूसरे आइटम हैं या ऐसे ग्रुप हैं जिन्हें मैप नहीं किया गया है.
ACL_CYCLE एसीएल इनहेरिटेंस ग्राफ़ से एक साइकल बनता है.

FieldViolation

JSON के काेड में दिखाना 
{
  "field": string,
  "description": string
}
फ़ील्ड
field

string

उल्लंघन वाले फ़ील्ड का पाथ.
description

string

गड़बड़ी के बारे में जानकारी.

RepositoryError

जब कनेक्टर, सोर्स रिपॉज़िटरी से संपर्क कर रहा होता है, तब गड़बड़ियां होती हैं.

JSON के काेड में दिखाना 
{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}
फ़ील्ड
type

enum (RepositoryError.Type)

गड़बड़ी का टाइप.
httpStatusCode

integer

गड़बड़ी के कोड. एचटीटीपी स्टेटस कोड की परिभाषा से मेल खाता है.
errorMessage

string

गड़बड़ी के बारे में बताने वाला मैसेज. मैसेज में ज़्यादा से ज़्यादा 8,192 वर्ण हो सकते हैं.

RepositoryError.Type

डेटा स्टोर करने की जगह से जुड़ी कम्यूनिकेशन से जुड़ी समस्याओं के लिए, गड़बड़ी के कोड की सूची.

Enums
UNKNOWN ऐसी गड़बड़ी जिसके बारे में कोई जानकारी नहीं है.
NETWORK_ERROR होस्ट की जानकारी नहीं है या होस्ट तक पहुंचा नहीं जा सकता.
DNS_ERROR DNS समस्या, जैसे कि DNS सर्वर प्रतिक्रिया नहीं दे रहा है.
CONNECTION_ERROR डेटा स्टोर करने की जगह के सर्वर से कनेक्ट नहीं किया जा सका.
AUTHENTICATION_ERROR गलत क्रेडेंशियल की वजह से पुष्टि नहीं हो सकी.
AUTHORIZATION_ERROR सेवा खाते को डेटा स्टोर करने की जगह के लिए अनुमति नहीं है.
SERVER_ERROR डेटा स्टोर करने की जगह के सर्वर में गड़बड़ी हुई.
QUOTA_EXCEEDED कोटा सीमा से ज़्यादा हो गया.
SERVICE_UNAVAILABLE सर्वर कुछ समय के लिए उपलब्ध नहीं है.
CLIENT_ERROR क्लाइंट से जुड़ी गड़बड़ी, जैसे कि कनेक्टर से डेटा स्टोर करने की जगह के सर्वर पर किया गया कोई अमान्य अनुरोध.

Item.ItemType

Enums
UNSPECIFIED
CONTENT_ITEM एक ऐसा आइटम जिसे सिर्फ़ जानकारी देने के मकसद से इंडेक्स किया गया है. इन आइटम को containerName या inheritAclFrom फ़ील्ड में रेफ़र नहीं किया जा सकता.
CONTAINER_ITEM ऐसा आइटम जो इंडेक्स किया जाता है और जिसका मकसद, एसीएल वाले दूसरे आइटम मुहैया कराना और/या उनमें दूसरे आइटम शामिल होते हैं.
VIRTUAL_CONTAINER_ITEM ऐसा आइटम जो इंडेक्स नहीं होता है, लेकिन उसका मकसद CONTAINER_ITEM के जैसा ही है.

तरीके

delete

 बताए गए संसाधन नाम के लिए Item resource को मिटाता है.

deleteQueueItems

 सूची के सभी आइटम मिटा देता है.

get

 आइटम के नाम के हिसाब से Item resource पाएं.

index

 Item ACL, मेटाडेटा, और कॉन्टेंट को अपडेट करता है.

list

 Item resources की पूरी या एक सबसेट की सूची बनाता है.

poll

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

push

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

unreserve

 सूची के सभी आइटम बुक नहीं किए जाते, ताकि सभी आइटम के लिए पोल किया जा सके.

upload

 आइटम का कॉन्टेंट अपलोड करने के लिए, अपलोड सेशन बनाता है.