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)

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