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