Method: indexing.datasources.items.index

Item ACL, मेटाडेटा, और कॉन्टेंट को अपडेट करता है. Item मौजूद न होने पर, यह उसे शामिल कर देगा. इस तरीके से, ऐप्लिकेशन को सीमित तौर पर अपडेट नहीं किया जा सकता. जिन फ़ील्ड में कोई वैल्यू नहीं दी गई है उन्हें Cloud Search इंडेक्स से हटा दिया जाता है.

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

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

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

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

पाथ के पैरामीटर

पैरामीटर
item.name

string

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "item": {
    "name": string,
    "acl": {
      "inheritAclFrom": string,
      "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
      "readers": [
        {
          object (Principal)
        }
      ],
      "deniedReaders": [
        {
          object (Principal)
        }
      ],
      "owners": [
        {
          object (Principal)
        }
      ]
    },
    "metadata": {
      "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)
        }
      ]
    },
    "structuredData": {
      "object": {
        object (StructuredDataObject)
      },
      "hash": string
    },
    "content": {
      "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.
    },
    "version": string,
    "status": {
      "code": enum (ItemStatus.Code),
      "processingErrors": [
        {
          object (ProcessingError)
        }
      ],
      "repositoryErrors": [
        {
          object (RepositoryError)
        }
      ]
    },
    "queue": string,
    "payload": string,
    "itemType": enum (Item.ItemType)
  },
  "connectorName": string,
  "mode": enum (RequestMode.Mode),
  "debugOptions": {
    object (DebugOptions)
  },
  "indexItemOptions": {
    object (IndexItemOptions)
  }
}
फ़ील्ड
item.acl

object (ItemAcl)

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

object (ItemMetadata)

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

object (ItemStructuredData)

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

object (ItemContent)

आइटम का कॉन्टेंट, इंडेक्स किया जाना चाहिए और टेक्स्ट को खोजने लायक बनाया जा सकता है.
item.version

string (bytes format)

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

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

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

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

object (ItemStatus)

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

string

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

string (bytes format)

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

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

enum (Item.ItemType)

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

string

यह कॉल करने वाले कनेक्टर का नाम.

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

enum (RequestMode.Mode)

ज़रूरी है. इस अनुरोध के लिए अनुरोध मोड.
debugOptions

object (DebugOptions)

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

object (IndexItemOptions)

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

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

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

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

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

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

IndexItemOptions

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

boolean

इससे यह तय होता है कि क्या इंडेक्स करने के अनुरोध में, Google Workspace के उन मुख्य खातों को अनुमति दी जानी चाहिए जो मौजूद नहीं हैं या जिन्हें मिटा दिया गया है.