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

اسم قائمة الانتظار المطلوب جلب العناصر منها. في حال عدم تحديد ذلك، سيتم جلب items.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

لمزيد من المعلومات، راجِع دليل التفويض.