Method: indexing.datasources.items.poll

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

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

تضمن حجز العناصر عدم إنشاء مجموعات متداخلة من خلال الاستطلاع من سلاسل محادثات أخرى.

بعد معالجة العناصر المحجوزة، على العميل إعادة العناصر إلى الحالة "غير محجوزة"، إما عن طريق الاتصال برقم index, أو عن طريق الاتصال برقم push باستخدام النوع REQUEUE..

تصبح العناصر متاحة تلقائيًا (غير محجوزة) بعد 4 ساعات حتى في حال عدم استدعاء طريقة تعديل أو دفع.

تتطلّب واجهة برمجة التطبيقات هذه حساب مشرف أو حساب خدمة لتنفيذها. حساب الخدمة المستخدَم هو الحساب المدرَج في القائمة المسموح بها في مصدر البيانات المقابل.

طلب HTTP

POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

مَعلمات المسار

المعلمات
name

string

اسم مصدر البيانات للاستطلاع عن العناصر. التنسيق: datasources/{sourceId}

نص الطلب

يحتوي نص الطلب على بيانات بالبنية التالية:

تمثيل JSON
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
الحقول
connectorName

string

اسم الموصِّل الذي يُجري هذا الطلب

التنسيق: datasources/{sourceId}/connectors/{ID}

statusCodes[]

enum (ItemStatus.Code)

يمكنك حصر العناصر التي يتم استطلاعها بالعناصر التي تحمل هذه الحالات.

limit

integer

الحد الأقصى لعدد العناصر التي سيتم عرضها

الحد الأقصى للقيمة هو 100 والقيمة التلقائية هي 20.

queue

string

اسم "القائمة الانتظار" التي يتم جلب العناصر منها. في حال عدم تحديد قيمة، ستسترجع دالة items.poll العناصر من قائمة الانتظار "التلقائية". الحد الأقصى للطول هو 100 حرف.

debugOptions

object (DebugOptions)

خيارات تصحيح الأخطاء الشائعة

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

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

object (Item)

مجموعة من العناصر من "قائمة الانتظار" المتاحة للوصلة لمعالجتها

تمّت تعبئة المجموعة الفرعية التالية من الحقول في هذه العناصر:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.