لتعديل قائمة التحكّم بالوصول (ACL) والبيانات الوصفية والمحتوى في "Item
" سيؤدي ذلك إلى إدراج Item
إذا لم يكن متوفّرًا. ولا تتيح هذه الطريقة إجراء تحديثات جزئية. يتم محو الحقول التي لا تحتوي على قيم في فهرس Cloud Search.
تتطلّب واجهة برمجة التطبيقات هذه توفّر حساب مشرف أو حساب خدمة لتنفيذها. حساب الخدمة المُستخدَم هو الحساب المضاف إلى القائمة البيضاء في مصدر البيانات المقابل.
طلب HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:index
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المعلمات | |
---|---|
item.name |
اسم السلعة التنسيق: datasources/{sourceId}/items/{itemId} هذا الحقل إلزامي. ويجب ألّا يزيد عدد الأحرف عن 1536 حرفًا. |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "item": { "name": string, "acl": { "inheritAclFrom": string, "aclInheritanceType": enum ( |
الحقول | |
---|---|
item.acl |
قائمة التحكّم بالوصول لهذا العنصر |
item.metadata |
معلومات بيانات التعريف. |
item.structuredData |
البيانات المنظَّمة للعنصر التي يجب أن تتوافق مع تعريف عنصر مسجَّل في المخطط لمصدر البيانات. |
item.content |
محتوى العنصر المطلوب فهرسته وجعل النص قابلاً للبحث. |
item.version |
مطلوب. يخزِّن نظام الفهرسة الإصدار من مصدر البيانات كسلسلة بايت ويقارن إصدار العنصر في الفهرس بإصدار العنصر في قائمة الانتظار باستخدام الترتيب المعجم. لن تعمل فهرسة Cloud Search على فهرسة أو حذف أي عنصر في قائمة الانتظار بقيمة إصدار أقل من أو تساوي نسخة العنصر المفهرَس حاليًا. يبلغ الحد الأقصى لطول هذا الحقل 1024 بايت. للحصول على معلومات عن مدى تأثير إصدار العنصر في عملية الحذف، راجِع التعامل مع النُسخ السابقة بعد عمليات الحذف اليدوية. سلسلة بترميز base64. |
item.status |
حالة السلعة حقل الإخراج فقط. |
item.queue |
قائمة الانتظار التي ينتمي إليها هذا العنصر الحد الأقصى للطول هو 100 حرف. |
item.payload |
يمكن تخزين موصل حالة إضافي لهذا العنصر. الحد الأقصى للطول هو 10,000 بايت. سلسلة بترميز base64. |
item.itemType |
نوع هذا العنصر. |
connectorName |
اسم الموصل الذي يجري هذا الاستدعاء. التنسيق: datasources/{sourceId}/connectors/{ID} |
mode |
مطلوب. The RequestMode (وضع الطلب) لهذا الطلب. |
debugOptions |
خيارات تصحيح الأخطاء الشائعة. |
indexItemOptions |
|
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Operation
.
نطاقات التفويض
يتطلب هذا الإعداد أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
لمزيد من المعلومات، يُرجى الاطّلاع على دليل التفويض.
IndexItemOptions
تمثيل JSON |
---|
{ "allowUnknownGsuitePrincipals": boolean } |
الحقول | |
---|---|
allowUnknownGsuitePrincipals |
تحدِّد هذه السياسة ما إذا كان طلب الفهرسة يجب أن يسمح بمبادئ Google Workspace الأساسية غير المتوفّرة أو التي تم حذفها. |