REST Resource: indexing.datasources.items

المرجع: عنصر

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

تمثيل JSON 
{
  "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)
}
الحقول
name

string

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

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

object (ItemAcl)

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

object (ItemMetadata)

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

object (ItemStructuredData)

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

object (ItemContent)

محتوى العنصر الذي سيتم فهرسته وتحويله إلى نص قابل للبحث
version

string (bytes format)

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

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

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

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

object (ItemStatus)

حالة العنصر. حقل للإخراج فقط
queue

string

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

string (bytes format)

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

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

enum (Item.ItemType)

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

ItemAcl

معلومات قائمة التحكّم في الوصول إلى العنصر لمزيد من المعلومات، اطّلِع على ربط جداول التحكم في الوصول.

تمثيل JSON 
{
  "inheritAclFrom": string,
  "aclInheritanceType": enum (ItemAcl.AclInheritanceType),
  "readers": [
    {
      object (Principal)
    }
  ],
  "deniedReaders": [
    {
      object (Principal)
    }
  ],
  "owners": [
    {
      object (Principal)
    }
  ]
}
الحقول
inheritAclFrom

string

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

enum (ItemAcl.AclInheritanceType)

لضبط نوع قواعد الوصول التي سيتم تطبيقها عندما يكتسب عنصر قائمة التحكّم في الوصول من عنصر رئيسي. ويجب ضبط هذا الحقل دائمًا مع الحقل inheritAclFrom. بالإضافة إلى ذلك، عند ضبط حقل inheritAclFrom، يجب ضبط هذا الحقل على AclInheritanceType صالح.
readers[]

object (Principal)

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

object (Principal)

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

object (Principal)

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

ItemAcl.AclInheritanceType

أنواع اكتساب أذونات الوصول إلى الملفات

عمليات التعداد
NOT_APPLICABLE القيمة التلقائية عندما لا يكتسب هذا العنصر قائمة تحكم بالوصول استخدِم NOT_APPLICABLE عندما تكون inheritAclFrom فارغة. يمكن أن يتضمّن العنصر الذي لا يتضمّن قائمة ACL موروثة قوائم ACL يوفّرها حقلَا readers وdeniedReaders.
CHILD_OVERRIDE أثناء تعارض الأذونات، تحدِّد قائمة التحكّم في الوصول إلى العنصر الثانوي إذن الوصول للقراءة.
PARENT_OVERRIDE أثناء تعارض الأذونات، تحدِّد قائمة التحكّم في الوصول إلى العنصر الرئيسي المحدّد في الحقل inheritAclFrom إذن الوصول للقراءة.
BOTH_PERMIT لا يتم منح الإذن بالوصول إلا إذا كان هذا العنصر والعنصر الرئيسي المحدَّد في الحقل inheritAclFrom يسمحان بالوصول للقراءة.

المشرف

إشارة إلى مستخدم أو مجموعة أو نطاق

تمثيل JSON 
{

  // 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.
}
الحقول

حقل الربط principal

يمكن أن يكون principal واحدًا فقط مما يلي:
gsuitePrincipal

object (GSuitePrincipal)

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

string

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

string

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

ItemMetadata

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

تمثيل JSON 
{
  "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)
    }
  ]
}
الحقول
title

string

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

string

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

string

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

string

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

string (Timestamp format)

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

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

string (Timestamp format)

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

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

object (Interaction)

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

string

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

string

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

object (SearchQualityMetadata)

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

string

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

string

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

object (ContextAttribute)

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

التفاعل

يمثّل تفاعلًا بين مستخدم وعنصر.

تمثيل JSON 
{
  "type": enum (Interaction.InteractionType),
  "principal": {
    object (Principal)
  },
  "interactionTime": string
}
الحقول
type

enum (Interaction.InteractionType)
principal

object (Principal)

المستخدم الذي اتّخذ إجراءً بشأن العنصر
interactionTime

string (Timestamp format)

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

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

Interaction.InteractionType

نوع النشاط الذي نفّذه المستخدم على العنصر

عمليات التعداد
UNSPECIFIED القيمة غير صالحة.
VIEW يشير هذا التفاعل إلى أنّ المستخدم شاهد العنصر.
EDIT يشير هذا التفاعل إلى أنّ المستخدم عدّل العنصر.

SearchQualityMetadata

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

تمثيل JSON 
{
  "quality": number
}
الحقول
quality

number

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

ContextAttribute

سمة مُسمّاة مرتبطة بعنصر يمكن استخدامها للتأثير في ترتيب العنصر استنادًا إلى السياق في الطلب.

تمثيل JSON 
{
  "name": string,
  "values": [
    string
  ]
}
الحقول
name

string

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

string

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

ItemStructuredData

حقول البيانات المنظَّمة المتاحة للعنصر

تمثيل JSON 
{
  "object": {
    object (StructuredDataObject)
  },
  "hash": string
}
الحقول
object

object (StructuredDataObject)

عنصر البيانات المنظَّمة الذي يجب أن يمتثل لتعريف عنصر مسجّل في مخطّط مصدر البيانات
hash

string

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

StructuredDataObject

كائن بيانات منظَّمة يتألّف من سمات محدّدة

تمثيل JSON 
{
  "properties": [
    {
      object (NamedProperty)
    }
  ]
}
الحقول
properties[]

object (NamedProperty)

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

NamedProperty

زوج مكتوب من الاسم والقيمة للبيانات المنظَّمة يجب أن يكون نوع القيمة هو نفسه النوع المسجّل للسمة name في تعريف الكائن objectType.

تمثيل JSON 
{
  "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.
}
الحقول
name

string

اسم الموقع. يجب أن يتطابق هذا الاسم مع اسم السمة التي تم تسجيلها لتعريف العنصر في المخطط. الحد الأقصى المسموح به لعدد الأحرف في هذا السمة هو 256 حرفًا.
حقل الربط value قيم السمة المُسمّاة يُرجى العِلم أنّ السمة يمكن أن تحتوي على قيم من نوع واحد فقط. يمكن أن يكون value واحدًا فقط مما يلي:
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)

NamedProperty.IntegerValues

قائمة بالقيم الصحيحة

تمثيل JSON 
{
  "values": [
    string
  ]
}
الحقول
values[]

string (int64 format)

NamedProperty.DoubleValues

قائمة بالقيم المزدوجة

تمثيل JSON 
{
  "values": [
    number
  ]
}
الحقول
values[]

number

NamedProperty.TimestampValues

قائمة بقيم الطابع الزمني

تمثيل JSON 
{
  "values": [
    string
  ]
}
الحقول
values[]

string (Timestamp format)

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

NamedProperty.ObjectValues

قائمة بقيم العناصر

تمثيل JSON 
{
  "values": [
    {
      object (StructuredDataObject)
    }
  ]
}
الحقول
values[]

object (StructuredDataObject)

NamedProperty.EnumValues

قائمة بقيم التعداد

تمثيل JSON 
{
  "values": [
    string
  ]
}
الحقول
values[]

string

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

NamedProperty.DateValues

قائمة بقيم التاريخ

تمثيل JSON 
{
  "values": [
    {
      object (Date)
    }
  ]
}
الحقول
values[]

object (Date)

NamedProperty.TextValues

قائمة بقيم النص

تمثيل JSON 
{
  "values": [
    string
  ]
}
الحقول
values[]

string

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

NamedProperty.HtmlValues

قائمة بقيم html

تمثيل JSON 
{
  "values": [
    string
  ]
}
الحقول
values[]

string

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

ItemContent

محتوى عنصر ليتم فهرسته وعرضه من خلال Cloud Search لا يُسمح إلا باستخدام سلاسل بترميز UTF-8 كـ inlineContent. إذا تم تحميل المحتوى وليس ثنائيًا، يجب ترميزه باستخدام UTF-8.

تمثيل JSON 
{
  "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.
}
الحقول
contentFormat

enum (ItemContent.ContentFormat)
hash

string

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

حقل الربط content

يمكن أن يكون content واحدًا فقط مما يلي:
inlineContent

string (bytes format)

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

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

object (UploadItemRef)

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

ItemContent.ContentFormat

تنسيق المحتوى إذا كان التنسيق RAW، يجب أن يكون المحتوى بالتنسيق المحدّد من خلال mimeType.

عمليات التعداد
UNSPECIFIED القيمة غير صالحة.
HTML ‫contentFormat هو HTML.
TEXT ‫contentFormat هو نص حر.
RAW ‫contentFormat هو عدد البايتات الأولية.

UploadItemRef

يمثّل مرجعًا لجلسة تحميل. تم إنشاء هذا المرجع من خلال upload method. يبقى هذا المرجع صالحًا لمدة 30 يومًا من تاريخ إنشائه. قد يشير تعديل محتوى السلعة إلى هذا المحتوى المحمَّل عبر contentDataRef.

تمثيل JSON 
{
  "name": string
}
الحقول
name

string

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

ItemStatus

يحتوي هذا الحقل على حالة السلعة وأي أخطاء.

تمثيل JSON 
{
  "code": enum (ItemStatus.Code),
  "processingErrors": [
    {
      object (ProcessingError)
    }
  ],
  "repositoryErrors": [
    {
      object (RepositoryError)
    }
  ]
}
الحقول
code

enum (ItemStatus.Code)

رمز الحالة
processingErrors[]

object (ProcessingError)

تفاصيل الخطأ في حال كان العنصر في حالة خطأ
repositoryErrors[]

object (RepositoryError)

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

ProcessingError

تمثيل JSON 
{
  "code": enum (ProcessingErrorCode),
  "errorMessage": string,
  "fieldViolations": [
    {
      object (FieldViolation)
    }
  ]
}
الحقول
code

enum (ProcessingErrorCode)

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

string

وصف الخطأ
fieldViolations[]

object (FieldViolation)

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

ProcessingErrorCode

رموز للإشارة إلى الخطأ الذي حدث أثناء معالجة العناصر من قِبل خادم Cloud Search قد يحتوي عنصر واحد على أخطاء معالجة متعددة.

عمليات التعداد
PROCESSING_ERROR_CODE_UNSPECIFIED أدخِل القيمة فقط. استخدِم هذه القيمة في "العناصر".
MALFORMED_REQUEST تم تنسيق قائمة التحكّم في الوصول أو البيانات الوصفية أو المحتوى للعنصر بشكل غير صحيح أو في حالة غير صالحة. يحتوي FieldViolations على مزيد من التفاصيل حول مكان المشكلة.
UNSUPPORTED_CONTENT_FORMAT تنسيق المحتوى غير متوافق.
INDIRECT_BROKEN_ACL العناصر التي تحتوي على معلومات غير مكتملة في قائمة أذونات الوصول بسبب اكتساب عناصر أخرى تحتوي على قائمة أذونات وصول غير صالحة أو تحتوي على مجموعات لها عناصر فرعية غير مُحدَّدة
ACL_CYCLE شكّل الرسم البياني لسلسلة الإرث في قائمة "الوصول إلى الملفات" حلقة.

FieldViolation

تمثيل JSON 
{
  "field": string,
  "description": string
}
الحقول
field

string

مسار الحقل الذي يتضمّن انتهاكًا
description

string

وصف الخطأ

RepositoryError

الأخطاء التي تحدث عند تواصل الموصِّل مع مستودع المصدر

تمثيل JSON 
{
  "type": enum (RepositoryError.Type),
  "httpStatusCode": integer,
  "errorMessage": string
}
الحقول
type

enum (RepositoryError.Type)

نوع الخطأ
httpStatusCode

integer

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

string

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

RepositoryError.Type

قائمة برموز الخطأ المتعلّقة بمشاكل الاتصال بالمستودع

عمليات التعداد
UNKNOWN حدث خطأ غير معروف.
NETWORK_ERROR مضيف غير معروف أو لا يمكن الوصول إليه
DNS_ERROR مشكلة في نظام أسماء النطاقات، مثل عدم استجابة خادم نظام أسماء النطاقات
CONNECTION_ERROR لا يمكن الاتصال بخادم المستودع.
AUTHENTICATION_ERROR تعذّرت المصادقة بسبب بيانات الاعتماد غير الصحيحة.
AUTHORIZATION_ERROR حساب الخدمة غير مصرَّح له بالوصول إلى المستودع.
SERVER_ERROR حدث خطأ في خادم المستودع.
QUOTA_EXCEEDED تمّ تجاوز الحصة المخصصة.
SERVICE_UNAVAILABLE الخادم غير متاح مؤقتًا.
CLIENT_ERROR خطأ مرتبط بالعميل، مثل طلب غير صالح من الموصِّل إلى خادم المستودع

Item.ItemType

عمليات التعداد
UNSPECIFIED
CONTENT_ITEM عنصر يتم فهرسته بغرض عرض المعلومات فقط لا يمكن الإشارة إلى هذه العناصر في حقلَي containerName أو inheritAclFrom.
CONTAINER_ITEM عنصر يتم فهرسته والغرض منه هو تزويد عناصر أخرى بقوائم أذونات وصول و/أو احتواء عناصر أخرى
VIRTUAL_CONTAINER_ITEM عنصر لا تتم فهرسته، ولكنّه يخدم الغرض نفسه الذي يخدمه CONTAINER_ITEM.

الطُرق

delete

 تحذف Item resource لاسم المورد المحدّد.

deleteQueueItems

 لحذف جميع العناصر في قائمة انتظار

get

 الحصول على Item resource حسب اسم السلعة

index

 تعديلات Item قائمة التحكّم بالوصول والبيانات الوصفية والمحتوى

list

 يتم إدراج كل Item resources أو مجموعة فرعية منها.

poll

 تبحث عن العناصر غير المحجوزة من قائمة الانتظار للفهرسة وتضع علامة على مجموعة على أنّها محجوزة، بدءًا بالعناصر التي لها الطابع الزمني الأقدم من أعلى أولوية ItemStatus.

push

 تُرسِل عنصرًا إلى قائمة انتظار لفحصه وتعديله لاحقًا.

unreserve

 تُلغي حجز جميع العناصر من قائمة الانتظار، ما يجعلها مؤهّلة للفحص.

upload

 لإنشاء جلسة تحميل لتحميل محتوى السلعة.