Method: indexing.datasources.items.index

تعديلات 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)

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