Method: indexing.datasources.items.push

تُرسِل عنصرًا إلى قائمة انتظار لفحصه وتعديله لاحقًا.

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

طلب HTTP

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

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

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

المعلمات
item.name

string

اسم item المطلوب دفعه إلى قائمة انتظار الفهرسة.

التنسيق: datasources/{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 المطلوب دفعه إلى قائمة انتظار الفهرسة.

التنسيق: datasources/{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 إلا للعناصر التي تم حجزها. يؤدي هذا الإجراء إلى إلغاء حجز العنصر وإعادة ضبط وقت التوفّر على وقت الساعة.