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}

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

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

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

JSON के काेड में दिखाना 
{
  "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)

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

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

enum (Item.ItemType)

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

string

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

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

enum (RequestMode.Mode)

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

object (DebugOptions)

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

object (IndexItemOptions)

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

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

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

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

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

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

IndexItemOptions

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

boolean

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