REST Resource: indexing.datasources.items

{
  "name": string,
  "acl": {
    object (ItemAcl)
  },
  "metadata": {
    object (ItemMetadata)
  },
  "structuredData": {
    object (ItemStructuredData)
  },
  "content": {
    object (ItemContent)
  },
  "version": string,
  "status": {
    object (ItemStatus)
  },
  "queue": string,
  "payload": string,
  "itemType": enum (Item.ItemType)
}

string

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

هذا الحقل إلزامي. الحد الأقصى للطول هو 1536 حرفًا.

object (ItemAcl)

قائمة التحكّم بالوصول لهذا العنصر

object (ItemMetadata)

معلومات البيانات الوصفية

object (ItemStructuredData)

البيانات المنظَّمة للسلعة التي يجب أن تتوافق مع تعريف عنصر مسجّل في المخطط لمصدر البيانات.

object (ItemContent)

محتوى العنصر المطلوب فهرسته وإتاحة إمكانية البحث في النص

string (bytes format)

مطلوبة. يخزّن نظام الفهرسة النسخة من مصدر البيانات كسلسلة بايت ويقارن إصدار العنصر في الفهرس مع إصدار العنصر في قائمة الانتظار باستخدام الترتيب الأبجدي.

لن تفهرس "فهرسة Cloud Search" أي عنصر في قائمة الانتظار ذي قيمة إصدار أقل من أو تساوي إصدار العنصر المُفهرس حاليًا أو يحذفه. الحد الأقصى لطول هذا الحقل هو 1024 بايت.

للحصول على معلومات عن كيفية تأثير إصدار العنصر على عملية الحذف، يُرجى الرجوع إلى معالجة النُسخ السابقة بعد عمليات الحذف اليدوية.

سلسلة مشفّرة.

object (ItemStatus)

حالة السلعة. حقل الناتج فقط.

string

قائمة المحتوى التي ينتمي إليها هذا العنصر. الحد الأقصى للطول هو 100 حرف.

string (bytes format)

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

سلسلة مشفّرة.

enum (Item.ItemType)

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

{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}

string

اسم العنصر الذي سيكتسب منه قائمة أذونات الوصول (ACL). ملاحظة: يوفِّر اكتساب مستويات الوصول إلى البيانات فقط أذونات الوصول إلى العناصر الثانوية ولا يحدِّد العلاقات البنيوية، ولا يوفِّر طرقًا مناسبة لحذف مجموعات كبيرة من العناصر. لا يؤدي حذف العنصر الرئيسي ACL من الفهرس إلى تغيير أذونات الوصول للعناصر الفرعية التي تشير إلى العنصر الرئيسي في الحقل inheritAclFrom. لا يزال العنصر في الفهرس، ولكنه قد لا يظهر في نتائج البحث. وفي المقابل، يؤدي حذف عنصر في الحاوية إلى حذف كل العناصر التي تشير إلى الحاوية عبر الحقل containerName. الحد الأقصى لطول هذا الحقل هو 1536 حرفًا.

enum (ItemAcl.AclInheritanceType)

تحدِّد هذه السياسة نوع قواعد الوصول التي سيتم تطبيقها عندما تكتسب عنصرًا قائمة ACL من العنصر الرئيسي. يجب ضبط هذا الحقل دائمًا جنبًا إلى جنب مع الحقل inheritAclFrom. إضافةً إلى ذلك، عند ضبط الحقل inheritAclFrom، يجب إعداد هذا الحقل على Aclالاكتسابance صالح.

object (Principal)

قائمة العناصر الرئيسية المسموح لها برؤية العنصر في نتائج البحث. اختيارية إذا كانت الأذونات المكتسبة من عنصر آخر أو إذا لم تكن يقصد منها أن تكون مرئية، مثل virtual containers الحد الأقصى لعدد العناصر هو 1000.

object (Principal)

قائمة بالعناوين الرئيسية التي تم رفض الوصول إليها صراحةً في نتائج البحث. على الرغم من أنه يتم رفض وصول العناوين الرئيسية تلقائيًا، يمكنك استخدام القراء المرفوضين للتعامل مع الاستثناءات وإلغاء القائمة المسموح بها للقراء. الحد الأقصى لعدد العناصر هو 100.

object (Principal)

اختيارية: تمثّل هذه السمة قائمة مالكي العنصر. لا يؤثر هذا الحقل في أذونات الوصول إلى المستند. ولكنها توفّر ترتيبًا طفيفًا لتعزيز العناصر التي يكون المستخدم صاحب طلب البحث مالكًا لها. الحد الأقصى لعدد العناصر هو 5.

{

  // Union field principal can be only one of the following:
  "gsuitePrincipal": {
    object (GSuitePrincipal)
  },
  "userResourceName": string,
  "groupResourceName": string
  // End of list of possible types for union field principal.
}

object (GSuitePrincipal)

هذا المستخدم الرئيسي هو مستخدم أو مجموعة أو نطاق في Google Workspace.

string

هذا الأساسي هو مستخدم تم تحديده باستخدام هوية خارجية. ويجب أن يحدّد حقل الاسم اسم مورد المستخدم بهذا التنسيق: Identitysources/{sourceId}/users/{ID}

string

هذا رئيسي هو مجموعة تم تحديدها باستخدام هوية خارجية. يجب أن يحدّد حقل الاسم اسم مورد المجموعة بهذا التنسيق: Identitysources/{sourceId}/groups/{ID}

{
  "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)
    }
  ]
}

string

عنوان السلعة. في حال توفّر العنوان، سيكون هذا هو العنوان المعروض لنتيجة طلب البحث. الحد الأقصى للطول هو 2048 حرفًا.

string

رابط إلى مستودع المصدر الذي يقدّم البيانات تُطبّق نتائج البحث هذا الرابط على العنوان. قد تؤدي المسافات البيضاء أو الأحرف الخاصة إلى ظهور روابط نتائج Cloud Seach لإشعار إعادة التوجيه. ولتجنّب ذلك، يجب ترميز عنوان URL. الحد الأقصى للطول هو 2048 حرفًا.

string

اسم حاوية هذا العنصر. يؤدي حذف عنصر الحاوية إلى الحذف التلقائي لهذا العنصر. ملاحظة: لا يتم اكتساب قوائم التحكم بالوصول (ACL) من عنصر حاوية. لتقديم اكتساب قائمة التحكُّم بالوصول (ACL) لعنصر ما، يمكنك استخدام الحقل inheritAclFrom. الحد الأقصى للطول هو 1536 حرفًا.

string

نوع العنصر. يجب أن يتوافق هذا مع اسم تعريف العنصر في المخطط المسجَّل لمصدر البيانات. على سبيل المثال، إذا كان مخطط مصدر البيانات يحتوي على تعريف كائن بالاسم "document"، يجب أن تعيِّن طلبات فهرسة العناصر للعناصر من هذا النوع ضبط objectType إلى 'document'. الحد الأقصى للطول هو 256 حرفًا.

string (Timestamp format)

الوقت الذي تم فيه إنشاء العنصر في مستودع المصدر.

طابع زمني بتنسيق RFC3339 UTC "zulu"، مع دقة نانو ثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

وقت آخر تعديل للعنصر في مستودع المصدر.

طابع زمني بتنسيق RFC3339 UTC "zulu"، مع دقة نانو ثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

object (Interaction)

قائمة بالتفاعلات الخاصة بالعنصر. وتُستخدم التفاعلات لتحسين جودة طلب البحث، ولكن لا يتم عرضها للمستخدمين النهائيين. الحد الأقصى لعدد العناصر هو 1000.

string

رمز لغة BCP-47 للعنصر، مثل "en-US" أو "sr-Latn". لمزيد من المعلومات، يمكنك الاطّلاع على http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. الحد الأقصى للطول هو 32 حرفًا.

string

نوع MIME الأصلي من ItemContent.content في مستودع المصدر. الحد الأقصى للطول هو 256 حرفًا.

object (SearchQualityMetadata)

بيانات وصفية إضافية لجودة البحث عن العنصر

string

يجب أن تتطابق الكلمات الرئيسية أو العبارات الإضافية مع العنصر. يُستخدم داخليًا للمحتوى من إنشاء المستخدمين. الحد الأقصى لعدد العناصر هو 100. الحد الأقصى للطول هو 8192 حرفًا.

string

قيمة التجزئة التي يقدمها استدعاء واجهة برمجة التطبيقات. ويمكن استخدام هذا الإجراء مع طريقة items.push لاحتساب الحالة المعدَّلة. الحد الأقصى للطول هو 2048 حرفًا.

object (ContextAttribute)

مجموعة من السمات المُسماة المرتبطة بالسلعة. ويمكن استخدام هذا الإجراء للتأثير في ترتيب السلعة بناءً على السياق في الطلب. الحد الأقصى لعدد العناصر هو 10.

{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}

enum (Interaction.InteractionType)

object (Principal)

المستخدم الذي تصرف على العنصر.

string (Timestamp format)

الوقت الذي اتّخذ فيه المستخدم إجراءً على العنصر. في حال وجود إجراءات متعددة من النوع نفسه لمستخدم واحد، سيتم تسجيل الإجراء الأخير فقط.

طابع زمني بتنسيق RFC3339 UTC "zulu"، مع دقة نانو ثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

{
  "quality": number
}

number

إشارة إلى جودة السلعة المُستخدَمة للتأثير في جودة البحث، ويجب أن تتراوح القيمة بين 0.0 (أدنى جودة) و1.0 (أعلى جودة). القيمة التلقائية هي 0.0.

{
  "name": string,
  "values": [
    string
  ]
}

string

اسم السمة. يجب ألا يكون فارغًا. الحد الأقصى للطول هو 32 حرفًا. يجب أن يبدأ الاسم بحرف ويمكن أن يحتوي فقط على أحرف (A-Z أو a-z) أو أرقام (0-9). سيتم تسوية الاسم (بأحرف صغيرة) قبل مطابقته.

string

القيم النصية للسمة الحد الأقصى لعدد العناصر هو 10. الحد الأقصى لطول عنصر في المصفوفة هو 32 حرفًا. سيتم تسوية القيمة (بأحرف صغيرة) قبل مطابقتها.

{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}

object (StructuredDataObject)

كائن البيانات المنظَّمة الذي يجب أن يتوافق مع تعريف كائن مسجَّل في المخطط لمصدر البيانات.

string

قيمة التجزئة التي يقدمها استدعاء واجهة برمجة التطبيقات. ويمكن استخدام هذا الإجراء مع طريقة items.push لاحتساب الحالة المعدَّلة. الحد الأقصى للطول هو 2048 حرفًا.

{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}

object (NamedProperty)

خصائص العنصر. الحد الأقصى لعدد العناصر هو 1000.

{
  "name": string,

  // Union field value can be only one of the following:
  "integerValues": {
    object (NamedProperty.IntegerValues)
  },
  "doubleValues": {
    object (NamedProperty.DoubleValues)
  },
  "timestampValues": {
    object (NamedProperty.TimestampValues)
  },
  "booleanValue": boolean,
  "objectValues": {
    object (NamedProperty.ObjectValues)
  },
  "enumValues": {
    object (NamedProperty.EnumValues)
  },
  "dateValues": {
    object (NamedProperty.DateValues)
  },
  "textValues": {
    object (NamedProperty.TextValues)
  },
  "htmlValues": {
    object (NamedProperty.HtmlValues)
  }
  // End of list of possible types for union field value.
}

string

اسم الموقع. ويجب أن يتطابق هذا الاسم مع اسم الموقع الإلكتروني الذي تم تسجيله لتعريف العنصر في المخطط. الحد الأقصى للطول المسموح به لهذه السمة هو 256 حرفًا.

object (NamedProperty.IntegerValues)

object (NamedProperty.DoubleValues)

object (NamedProperty.TimestampValues)

boolean

object (NamedProperty.ObjectValues)

object (NamedProperty.EnumValues)

object (NamedProperty.DateValues)

object (NamedProperty.TextValues)

object (NamedProperty.HtmlValues)

{
  "values": [
    string
  ]
}

string (int64 format)

{
  "values": [
    number
  ]
}

number

{
  "values": [
    string
  ]
}

string (Timestamp format)

طابع زمني بتنسيق RFC3339 UTC "zulu"، مع دقة نانو ثانية وما يصل إلى تسعة أرقام كسور. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".

{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}

object (StructuredDataObject)

{
  "values": [
    string
  ]
}

string

الحد الأقصى للطول المسموح به لقيم السلسلة هو 32 حرفًا.

{
  "values": [
    {
      object (Date)
    }
  ]
}

object (Date)

{
  "values": [
    string
  ]
}

string

الحد الأقصى للطول المسموح به للقيم النصية هو 2048 حرفًا.

{
  "values": [
    string
  ]
}

string

الحد الأقصى للطول المسموح به لقيم html هو 2048 حرفًا.

{
  "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.
}

enum (ItemContent.ContentFormat)

string

معلومات التجزئة التي تم احتسابها وتقديمها من خلال عميل واجهة برمجة التطبيقات للمحتوى يمكن استخدامها مع طريقة item.push لحساب الحالة المعدّلة. الحد الأقصى للطول هو 2048 حرفًا.

string (bytes format)

المحتوى الذي يتم توفيره ضمن طريقة التحديث الحد الأقصى للطول هو 102400 بايت (100 كيبيبايت).

سلسلة مشفّرة.

object (UploadItemRef)

تحميل معرّف مرجعي لمحتوى تم تحميله سابقًا عبر طريقة الكتابة

{
  "name": string
}

string

اسم مرجع المحتوى. الحد الأقصى للطول هو 2048 حرفًا.

{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}

enum (ItemStatus.Code)

رمز الحالة.

object (ProcessingError)

تفاصيل الخطأ في حال كان العنصر في حالة "خطأ".

object (RepositoryError)

تم الإبلاغ عن خطأ في المستودع من خلال الموصِّل.

{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}

enum (ProcessingErrorCode)

رمز خطأ يشير إلى طبيعة الخطأ.

string

وصف الخطأ.

object (FieldViolation)

في حال كانت حقول العناصر غير صالحة، يحتوي هذا الحقل على تفاصيل حول أخطاء التحقق من الصحة.

{
  "field": string,
  "description": string
}

string

مسار الحقل مع انتهاك.

string

وصف الخطأ.

{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}

enum (RepositoryError.Type)

نوع الخطأ.

integer

رموز الأخطاء. تتطابق مع تعريف رموز حالة HTTP.

string

الرسالة التي تصف الخطأ. ويبلغ الحد الأقصى المسموح به لطول الرسالة 8192 حرفًا.