REST Resource: indexing.datasources.items

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

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

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}

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

acl

object (ItemAcl)

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

metadata

object (ItemMetadata)

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

structuredData

object (ItemStructuredData)

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

content

object (ItemContent)

आइटम का ऐसा कॉन्टेंट जिसे इंडेक्स किया जाना है और जिसे टेक्स्ट के तौर पर खोजा जा सकता है.

version

string (bytes format)

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

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

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

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

status

object (ItemStatus)

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

queue

string

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

payload

string (bytes format)

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

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

itemType

enum (Item.ItemType)

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

ItemAcl

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

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

string

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

aclInheritanceType

enum (ItemAcl.AclInheritanceType)

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

readers[]

object (Principal)

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

deniedReaders[]

object (Principal)

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

owners[]

object (Principal)

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

ItemAcl.AclInheritanceType

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

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

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

sourceRepositoryUrl

string

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

containerName

string

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

objectType

string

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

createTime

string (Timestamp format)

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

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

updateTime

string (Timestamp format)

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

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

interactions[]

object (Interaction)

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

contentLanguage

string

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

mimeType

string

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

searchQualityMetadata

object (SearchQualityMetadata)

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

keywords[]

string

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

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 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड रिज़ॉल्यूशन और नौ दशमलव अंकों तक का होता है. उदाहरण के लिए: "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)

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

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 यूटीसी के "Zulu" फ़ॉर्मैट में एक टाइमस्टैंप, नैनोसेकंड रिज़ॉल्यूशन और नौ दशमलव अंकों तक का होता है. उदाहरण के लिए: "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

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

NamedProperty.HtmlValues

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

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

string

एचटीएमएल वैल्यू में ज़्यादा से ज़्यादा 2,048 वर्ण हो सकते हैं.

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)

अपडेट करने के तरीके में इनलाइन किया गया कॉन्टेंट. ज़्यादा से ज़्यादा 102,400 बाइट (100 केबी) हो सकते हैं.

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

contentDataRef

object (UploadItemRef)

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

ItemContent.ContentFormat

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

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

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 आइटम का एसीएल, मेटाडेटा या कॉन्टेंट गलत तरीके से बनाया गया है या अमान्य है. FieldViolations में, समस्या की जगह के बारे में ज़्यादा जानकारी होती है.
UNSUPPORTED_CONTENT_FORMAT कॉन्टेंट का यह फ़ॉर्मैट इस्तेमाल नहीं किया जा सकता.
INDIRECT_BROKEN_ACL ऐसे आइटम जिनमें एसीएल की जानकारी अधूरी है. ऐसा, गड़बड़ी वाले एसीएल वाले अन्य आइटम को इनहेरिट करने या ऐसे ग्रुप में शामिल होने की वजह से होता है जिनमें मैप नहीं किए गए वंशज शामिल हैं.
ACL_CYCLE ACL इनहेरिटेंस ग्राफ़ में एक साइकल बना.

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

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

RepositoryError.Type

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

Enums
UNKNOWN ऐसी गड़बड़ी जिसके बारे में कोई जानकारी नहीं है.
NETWORK_ERROR अज्ञात या पहुंच से बाहर का होस्ट.
DNS_ERROR डीएनएस से जुड़ी समस्या, जैसे कि डीएनएस सर्वर से कोई रिस्पॉन्स नहीं मिल रहा है.
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 एसीएल, मेटाडेटा, और कॉन्टेंट को अपडेट करता है.

list

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

poll

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

push

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

unreserve

यह किसी सूची से सभी आइटम को अनरिज़र्व कर देता है, ताकि उन सभी को पोल किया जा सके.

upload

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