Method: indexing.datasources.items.index

لتعديل قائمة التحكّم بالوصول (ACL) والبيانات الوصفية والمحتوى في "Item" سيؤدي ذلك إلى إدراج Item إذا لم يكن متوفّرًا. ولا تتيح هذه الطريقة إجراء تحديثات جزئية. يتم محو الحقول التي لا تحتوي على قيم في فهرس Cloud Search.

تتطلّب واجهة برمجة التطبيقات هذه توفّر حساب مشرف أو حساب خدمة لتنفيذها. حساب الخدمة المُستخدَم هو الحساب المضاف إلى القائمة البيضاء في مصدر البيانات المقابل.

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
item.name

string

اسم السلعة التنسيق: datasources/{sourceId}/items/{itemId}

هذا الحقل إلزامي. ويجب ألّا يزيد عدد الأحرف عن 1536 حرفًا.

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل 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)

يمكن تخزين موصل حالة إضافي لهذا العنصر. الحد الأقصى للطول هو 10,000 بايت.

سلسلة بترميز base64.

item.itemType

enum (Item.ItemType)

نوع هذا العنصر.

connectorName

string

اسم الموصل الذي يجري هذا الاستدعاء.

التنسيق: datasources/{sourceId}/connectors/{ID}

mode

enum (RequestMode.Mode)

مطلوب. The 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 الأساسية غير المتوفّرة أو التي تم حذفها.