لوضع عنصر في قائمة الانتظار لاستطلاعات الرأي والتحديث لاحقًا
تتطلّب واجهة برمجة التطبيقات هذه مشرفًا أو حساب خدمة لتنفيذها. حساب الخدمة المستخدَم هو حساب الخدمة المُضافة إلى القائمة البيضاء في مصدر البيانات المقابل.
طلب HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:push
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
مَعلمات المسار
المَعلمات | |
---|---|
item.name |
اسم السمة التنسيق: datasources/{sourceId}/items/{ID} هذا الحقل إلزامي. الحد الأقصى للطول هو 1536 حرفًا. |
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
تمثيل JSON |
---|
{ "item": { "name": string, "type": enum ( |
الحقول | |
---|---|
item.type |
تمثّل هذه السمة نوع عملية الدفع التي تحدّد سلوك الدفع. |
item.metadataHash |
تشير هذه السمة إلى تجزئة البيانات الوصفية للعنصر وفقًا للمستودع. يتمّ استخدامها في حال تحديدها لتحديد كيفية تعديل حالة هذه السلعة. يؤدي ضبط هذا الحقل والحقل |
item.structuredDataHash |
تجزئة البيانات المنظَّمة للعنصر وفقًا للمستودع. يتمّ استخدامها في حال تحديدها لتحديد كيفية تعديل حالة هذه السلعة. يؤدي ضبط هذا الحقل والحقل |
item.contentHash |
تجزئة محتوى العنصر وفقًا للمستودع. يتمّ استخدامها في حال تحديدها لتحديد كيفية تعديل حالة هذه السلعة. يؤدي ضبط هذا الحقل والحقل |
item.payload |
يوفر معلومات إضافية عن حالة المستند للموصل، مثل رقم تعريف مستودع بديل وبيانات وصفية أخرى. يبلغ الحد الأقصى للطول 8192 بايت. سلسلة بترميز base64. |
item.queue |
قائمة الانتظار التي ينتمي إليها هذا العنصر. ويتم اختيار قائمة الانتظار " |
item.repositoryError |
عليك تعبئة هذا الحقل لتخزين تفاصيل خطأ الموصل أو المستودع. يتم عرض هذه المعلومات في وحدة تحكّم المشرف. لا يمكن ملء هذا الحقل إلّا عندما تكون قيمة |
connectorName |
اسم الموصّل الذي يجري هذا الاستدعاء. التنسيق: datasources/{sourceId}/connectors/{ID} |
debugOptions |
خيارات تصحيح الأخطاء الشائعة |
نص الاستجابة
إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Item
.
نطاقات الأذونات
يتطلب استخدام أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
لمزيد من المعلومات، راجِع دليل التفويض.
PushItem
يمثّل هذا الخيار عنصرًا سيتم إرساله إلى قائمة انتظار الفهرسة.
تمثيل JSON |
---|
{ "name": string, "type": enum ( |
الحقول | |
---|---|
name |
اسم السمة التنسيق: datasources/{sourceId}/items/{ID} هذا الحقل إلزامي. الحد الأقصى للطول هو 1536 حرفًا. |
type |
تمثّل هذه السمة نوع عملية الدفع التي تحدّد سلوك الدفع. |
metadataHash |
تشير هذه السمة إلى تجزئة البيانات الوصفية للعنصر وفقًا للمستودع. يتمّ استخدامها في حال تحديدها لتحديد كيفية تعديل حالة هذه السلعة. يؤدي ضبط هذا الحقل والحقل |
structuredDataHash |
تجزئة البيانات المنظَّمة للعنصر وفقًا للمستودع. يتمّ استخدامها في حال تحديدها لتحديد كيفية تعديل حالة هذه السلعة. يؤدي ضبط هذا الحقل والحقل |
contentHash |
تجزئة محتوى العنصر وفقًا للمستودع. يتمّ استخدامها في حال تحديدها لتحديد كيفية تعديل حالة هذه السلعة. يؤدي ضبط هذا الحقل والحقل |
payload |
يوفر معلومات إضافية عن حالة المستند للموصل، مثل رقم تعريف مستودع بديل وبيانات وصفية أخرى. يبلغ الحد الأقصى للطول 8192 بايت. سلسلة بترميز base64. |
queue |
قائمة الانتظار التي ينتمي إليها هذا العنصر. ويتم اختيار قائمة الانتظار " |
repositoryError |
عليك تعبئة هذا الحقل لتخزين تفاصيل خطأ الموصل أو المستودع. يتم عرض هذه المعلومات في وحدة تحكّم المشرف. لا يمكن ملء هذا الحقل إلّا عندما تكون قيمة |
PushItem.Type
تمثّل هذه السمة نوع عملية الدفع التي تحدّد سلوك الدفع.
عمليات التعداد | |
---|---|
UNSPECIFIED |
الخيار التلقائي UNSPECIFIED. تحدِّد هذه السياسة أنّه يجب ألا تعدِّل عملية الدفع ItemStatus . |
MODIFIED |
يشير إلى أنّه تم تعديل مستند المستودع أو تعديله منذ استدعاء update السابق. يؤدي هذا الإجراء إلى تغيير الحالة إلى "MODIFIED " لعنصر حالي. وإذا تم طلبها على عنصر غير متوفّر، ستتغيّر الحالة إلى NEW_ITEM . |
NOT_MODIFIED |
لم يتم تعديل العنصر في المستودع منذ آخر طلب تعديل. ستؤدي عملية الدفع هذه إلى ضبط الحالة على حالة "ACCEPTED ". |
REPOSITORY_ERROR |
يواجه الموصل خطأ في المستودع بشأن هذا العنصر. تغيير الحالة إلى حالة REPOSITORY_ERROR لم يتم حجز العنصر وتمت إعادة جدولته في وقت لاحق يتم تحديده من خلال التراجع الأسي. |
REQUEUE |
دفع زر "استدعاء" مع "طلب" فقط للعناصر التي تم حجزها. يؤدي هذا الإجراء إلى إلغاء حجز العنصر وإعادة ضبط الوقت المتاح له على وقت الساعة الحائطية. |