REST Resource: indexing.datasources.items

संसाधन: आइटम

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

जेएसओएन के काेड में दिखाना
{
  "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 इंडेक्स करने की सुविधा, सूची में मौजूद किसी भी आइटम को इंडेक्स नहीं करेगी और न ही उसे मिटाएगी. इसकी वर्शन वैल्यू, इंडेक्स किए गए मौजूदा आइटम के वर्शन से कम या उसके बराबर होती है. इस फ़ील्ड के लिए ज़्यादा से ज़्यादा लंबाई 1024 बाइट है.

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

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

status

object (ItemStatus)

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

queue

string

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

payload

string (bytes format)

अतिरिक्त स्थिति कनेक्टर इस आइटम के लिए स्टोर कर सकता है. ज़्यादा से ज़्यादा 10,000 बाइट होना चाहिए.

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

itemType

enum (Item.ItemType)

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

ItemAcl

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

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

string

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

मुख्य रकम

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

जेएसओएन के काेड में दिखाना
{

  // 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

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

जेएसओएन के काेड में दिखाना
{
  "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 के नतीजे का दिखाया जाएगा. ज़्यादा से ज़्यादा 2,048 वर्ण इस्तेमाल किए जा सकते हैं.

sourceRepositoryUrl

string

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

containerName

string

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

objectType

string

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

createTime

string (Timestamp format)

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

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

updateTime

string (Timestamp format)

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

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

searchQualityMetadata

object (SearchQualityMetadata)

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

keywords[]

string

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

hash

string

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

contextAttributes[]

object (ContextAttribute)

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

इंटरैक्शन

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

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

enum (Interaction.InteractionType)

principal

object (Principal)

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

interactionTime

string (Timestamp format)

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

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

Interaction.InteractionType

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

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

SearchQualityMetadata

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

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

number

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

ContextAttribute

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

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

string

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

values[]

string

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

ItemStructuredData

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

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

object (StructuredDataObject)

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

hash

string

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

StructuredDataObject

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

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

object (NamedProperty)

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

NamedProperty

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

जेएसओएन के काेड में दिखाना
{
  "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

पूर्णांक मानों की सूची.

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

string (int64 format)

NamedProperty.DoubleValues

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

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

number

NamedProperty.TimestampValues

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

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

string (Timestamp format)

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

NamedProperty.ObjectValues

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

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

object (StructuredDataObject)

NamedProperty.EnumValues

Enum वैल्यू की सूची.

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

string

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

NamedProperty.DateValues

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

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

object (Date)

NamedProperty.TextValues

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

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

string

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

NamedProperty.HtmlValues

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

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

string

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

ItemContent

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

जेएसओएन के काेड में दिखाना
{
  "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 तरीके के साथ इस्तेमाल किया जा सकता है. ज़्यादा से ज़्यादा 2,048 वर्ण इस्तेमाल किए जा सकते हैं.

यूनियन फ़ील्ड 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 से अपलोड किया गया कॉन्टेंट दिख सकता है.

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

string

कॉन्टेंट की पहचान फ़ाइल का नाम. ज़्यादा से ज़्यादा 2,048 वर्ण इस्तेमाल किए जा सकते हैं.

ItemStatus

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

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

enum (ItemStatus.Code)

स्थिति कोड.

processingErrors[]

object (ProcessingError)

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

repositoryErrors[]

object (RepositoryError)

कनेक्टर की ओर से रिपोर्ट की गई डेटा स्टोर करने की जगह की गड़बड़ी.

ProcessingError

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

FieldViolation

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

string

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

description

string

गड़बड़ी की जानकारी.

RepositoryError

कनेक्टर, सोर्स रिपॉज़िटरी से डेटा शेयर करते समय दिखने वाली गड़बड़ियां.

जेएसओएन के काेड में दिखाना
{
  "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

आइटम सामग्री अपलोड करने के लिए अपलोड सत्र बनाता है.