Method: indexing.datasources.items.push

ينقل العنصر إلى قائمة انتظار للاستطلاع والتحديث لاحقًا.

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

طلب HTTP

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

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

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

المعلمات
item.name

string

تمثّل هذه السمة اسم item لإدراجه في قائمة انتظار الفهرسة.

التنسيق: مصادر البيانات/{sourceId}/items/{ID}

هذا الحقل إلزامي. ويجب ألّا يزيد عدد الأحرف عن 1536 حرفًا.

نص الطلب

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

تمثيل JSON 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
الحقول
item.type

enum (PushItem.Type)

نوع عملية الدفع التي تحدد سلوك الدفع.
item.metadataHash

string

تشير هذه السمة إلى تجزئة البيانات الوصفية للسلعة وفقًا للمستودع. وفي حال تحديد هذه السمة، يتم استخدامها لتحديد كيفية تعديل حالة هذا العنصر. يؤدي ضبط هذا الحقل والحقل type إلى حدوث خطأ في الوسيطة. ويجب ألّا يزيد عدد الأحرف عن 2048 حرفًا.
item.structuredDataHash

string

تجزئة البيانات المنظَّمة للعنصر حسب المستودع وفي حال تحديد هذه السمة، يتم استخدامها لتحديد كيفية تعديل حالة هذا العنصر. يؤدي ضبط هذا الحقل والحقل type إلى حدوث خطأ في الوسيطة. ويجب ألّا يزيد عدد الأحرف عن 2048 حرفًا.
item.contentHash

string

تجزئة محتوى السلعة وفقًا للمستودع وفي حال تحديد هذه السمة، يتم استخدامها لتحديد كيفية تعديل حالة هذا العنصر. يؤدي ضبط هذا الحقل والحقل type إلى حدوث خطأ في الوسيطة. ويجب ألّا يزيد عدد الأحرف عن 2048 حرفًا.
item.payload

string (bytes format)

يتم تقديم معلومات إضافية عن حالة المستند للموصِّل، مثل رقم تعريف المستودع البديل والبيانات الوصفية الأخرى. يبلغ الحد الأقصى للطول 8192 بايت.

سلسلة بترميز base64.
item.queue

string

قائمة الانتظار التي ينتمي إليها هذا العنصر يتم اختيار قائمة انتظار default إذا لم يتم تحديد هذا الحقل. ويجب ألّا يزيد عدد الأحرف عن 512 حرفًا.
item.repositoryError

object (RepositoryError)

عليك تعبئة هذا الحقل لتخزين تفاصيل خطأ في الموصّل أو المستودع. يتم عرض هذه المعلومات في وحدة تحكم المشرف. لا يمكن تعبئة هذا الحقل إلا عندما تكون قيمة type هي REPOSITORY_ERROR.
connectorName

string

اسم الموصل الذي يجري هذا الاستدعاء.

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

object (DebugOptions)

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

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال Item.

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

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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

PushItem

تمثل هذه السمة عنصرًا يجب وضعه في قائمة انتظار الفهرسة.

تمثيل JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
الحقول
name

string

تمثّل هذه السمة اسم item لإدراجه في قائمة انتظار الفهرسة.

التنسيق: مصادر البيانات/{sourceId}/items/{ID}

هذا الحقل إلزامي. ويجب ألّا يزيد عدد الأحرف عن 1536 حرفًا.
type

enum (PushItem.Type)

نوع عملية الدفع التي تحدد سلوك الدفع.
metadataHash

string

تشير هذه السمة إلى تجزئة البيانات الوصفية للسلعة وفقًا للمستودع. وفي حال تحديد هذه السمة، يتم استخدامها لتحديد كيفية تعديل حالة هذا العنصر. يؤدي ضبط هذا الحقل والحقل type إلى حدوث خطأ في الوسيطة. ويجب ألّا يزيد عدد الأحرف عن 2048 حرفًا.
structuredDataHash

string

تجزئة البيانات المنظَّمة للعنصر حسب المستودع وفي حال تحديد هذه السمة، يتم استخدامها لتحديد كيفية تعديل حالة هذا العنصر. يؤدي ضبط هذا الحقل والحقل type إلى حدوث خطأ في الوسيطة. ويجب ألّا يزيد عدد الأحرف عن 2048 حرفًا.
contentHash

string

تجزئة محتوى السلعة وفقًا للمستودع وفي حال تحديد هذه السمة، يتم استخدامها لتحديد كيفية تعديل حالة هذا العنصر. يؤدي ضبط هذا الحقل والحقل type إلى حدوث خطأ في الوسيطة. ويجب ألّا يزيد عدد الأحرف عن 2048 حرفًا.
payload

string (bytes format)

يتم تقديم معلومات إضافية عن حالة المستند للموصِّل، مثل رقم تعريف المستودع البديل والبيانات الوصفية الأخرى. يبلغ الحد الأقصى للطول 8192 بايت.

سلسلة بترميز base64.
queue

string

قائمة الانتظار التي ينتمي إليها هذا العنصر يتم اختيار قائمة انتظار default إذا لم يتم تحديد هذا الحقل. ويجب ألّا يزيد عدد الأحرف عن 512 حرفًا.
repositoryError

object (RepositoryError)

عليك تعبئة هذا الحقل لتخزين تفاصيل خطأ في الموصّل أو المستودع. يتم عرض هذه المعلومات في وحدة تحكم المشرف. لا يمكن تعبئة هذا الحقل إلا عندما تكون قيمة type هي REPOSITORY_ERROR.

PushItem.Type

نوع عملية الدفع التي تحدد سلوك الدفع.

عمليات التعداد
UNSPECIFIED الإعداد التلقائي UNSPECIFIED. تحدِّد هذه السياسة أنّه يجب ألا تعدّل عملية الإرسال ItemStatus.
MODIFIED يشير إلى أنّه تم تعديل مستند المستودع أو تعديله منذ استدعاء update السابق. يؤدي هذا إلى تغيير الحالة إلى حالة MODIFIED لعنصر حالي. إذا تم طلب ذلك على عنصر غير متوفّر، سيتم تغيير الحالة إلى NEW_ITEM.
NOT_MODIFIED لم يتم تعديل العنصر في المستودع منذ آخر طلب تحديث. ستؤدي عملية الإرسال هذه إلى ضبط الحالة على الحالة ACCEPTED.
REPOSITORY_ERROR يواجه الموصل خطأ في المستودع بشأن هذا العنصر. تغيير الحالة إلى الحالة REPOSITORY_ERROR لا يتم حجز العنصر وإعادة جدولته في وقت لاحق يتم تحديده من خلال التراجع الأسي.
REQUEUE إرسال طلب بالضغط على REQUEUE للعناصر التي تم حجزها فقط. يؤدي هذا الإجراء إلى إلغاء حجز العنصر وإعادة ضبط الوقت المتاح على وقت الساعة.