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 بايت.

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

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

object (ItemStatus)

حالة السلعة حقل الإخراج فقط.

string

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

string (bytes format)

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

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

enum (Item.ItemType)

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

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

string

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

enum (ItemAcl.AclInheritanceType)

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

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

عنوان السلعة. وسيكون هذا العنوان هو العنوان المعروض لنتيجة البحث query.search، في حال توفّرها. ويجب ألّا يزيد عدد الأحرف عن 2048 حرفًا.

string

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

string

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

string

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

string (Timestamp format)

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

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

string (Timestamp format)

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

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

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

string (bytes format)

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

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

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 حرفًا.