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

اسم مصدر البيانات لعناصر الاستطلاع. التنسيق: مصادر البيانات/{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

اسم قائمة المحتوى التالي التي تريد جلب العناصر منها في حال عدم تحديد قيمة item.poll، سيتم جلبها من "default" قائمة الانتظار. الحد الأقصى للطول هو 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

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