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

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

تمثيل 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)

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

object (Principal)

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

object (Principal)

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

object (Principal)

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

ItemAcl.AclInheritanceType

أنواع توريث قائمة التحكم بالوصول (ACL).

عمليات التعداد
NOT_APPLICABLE القيمة التلقائية عندما لا يكتسب هذا العنصر قائمة التحكم بالوصول (ACL). يمكن استخدام NOT_APPLICABLE عندما يكون inheritAclFrom فارغًا. يمكن لأي عنصر بدون اكتساب قوائم التحكم بالوصول (ACL) أن يحتوي على قوائم التحكم بالوصول التي يتم توفيرها من خلال حقلي readers وdeniedReaders الخاصين به.
CHILD_OVERRIDE أثناء تعارض التفويض، تحدد قائمة التحكم بالوصول (ACL) للعنصر الفرعي إمكانية الوصول للقراءة.
PARENT_OVERRIDE أثناء تعارض التفويض، تحدد قائمة التحكم بالوصول (ACL) للعنصر الرئيسي المحدد في الحقل 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 Seach إلى تشغيل إشعار بإعادة التوجيه. ولتجنب ذلك، قم بترميز عنوان URL. ويجب ألّا يزيد عدد الأحرف عن 2048 حرفًا.
containerName

string

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

string

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

string (Timestamp format)

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

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

string (Timestamp format)

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

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

object (Interaction)

تمثّل هذه السمة قائمة بالتفاعلات مع العنصر. تُستخدَم التفاعلات لتحسين جودة طلب البحث.ولا يتم عرضها للمستخدمين النهائيين. الحد الأقصى لعدد العناصر هو 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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "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

معلومات التجزئة التي احتسبها عميل واجهة برمجة التطبيقات وقدّمها للمحتوى يمكن استخدامها مع طريقة 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 قائمة التحكم بالوصول (ACL) للعنصر أو البيانات الوصفية أو المحتوى مكتوب بشكل غير صحيح أو في حالة غير صالحة. يحتوي حقل FieldViolations على مزيد من التفاصيل حول مكان المشكلة.
UNSUPPORTED_CONTENT_FORMAT تنسيق العدد غير متوافق.
INDIRECT_BROKEN_ACL عناصر ذات معلومات غير مكتملة في قائمة التحكم بالوصول (ACL) بسبب اكتساب عناصر أخرى مع قائمة التحكم بالوصول (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 عنصر تتم فهرسته والغرض منه هو توفير عناصر أخرى مع قوائم التحكم بالوصول (ACLs) و/أو تحتوي على عناصر أخرى.
VIRTUAL_CONTAINER_ITEM عنصر لم تتم فهرسته، ولكن له الغرض نفسه مثل CONTAINER_ITEM.

الطُرق

delete

 يؤدي هذا الإجراء إلى حذف Item resource لاسم المورد المحدّد.

deleteQueueItems

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

get

 يحصل على Item resource حسب اسم العنصر.

index

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

list

 يسرد كل أو مجموعة فرعية من Item resources.

poll

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

push

 ينقل العنصر إلى قائمة انتظار للاستطلاع والتحديث لاحقًا.

unreserve

 يؤدي هذا الخيار إلى إلغاء حجز كل العناصر من قائمة انتظار، ما يجعلها جميعها مؤهَّلة للاستطلاع.

upload

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