Method: indexing.datasources.items.push

یک مورد را برای نظرسنجی و به‌روزرسانی بعدی به صف می‌برد.

این API برای اجرا به یک ادمین یا حساب سرویس نیاز دارد. حساب سرویس مورد استفاده در فهرست سفید منبع داده مربوطه است.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
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 )

برای ذخیره جزئیات خطای رابط یا مخزن، این فیلد را پر کنید. این اطلاعات در Admin Console نمایش داده می شود. این فیلد فقط زمانی پر می شود که type REPOSITORY_ERROR باشد.

connectorName

string

نام رابطی که این تماس را برقرار می کند.

قالب: منابع داده/{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 )

برای ذخیره جزئیات خطای رابط یا مخزن، این فیلد را پر کنید. این اطلاعات در Admin Console نمایش داده می شود. این فیلد فقط زمانی پر می شود که type REPOSITORY_ERROR باشد.

PushItem.Type

نوع عملیات فشاری که رفتار فشار را مشخص می کند.

Enums
UNSPECIFIED پیش‌فرض نامشخص. مشخص می کند که عملیات فشار نباید ItemStatus تغییر دهد
MODIFIED نشان می دهد که سند مخزن از زمان تماس قبلی update اصلاح یا به روز شده است. این وضعیت را برای یک مورد موجود به حالت MODIFIED تغییر می دهد. اگر این مورد روی یک مورد غیر موجود فراخوانی شود، وضعیت به NEW_ITEM تغییر می‌کند.
NOT_MODIFIED مورد موجود در مخزن از آخرین تماس به‌روزرسانی تغییر نکرده است. این عملیات فشار، وضعیت را روی حالت ACCEPTED تنظیم می کند.
REPOSITORY_ERROR رابط در مورد این مورد با یک خطای مخزن مواجه است. وضعیت را به حالت REPOSITORY_ERROR تغییر دهید. مورد رزرو نشده و در زمان آتی که با عقب نشینی نمایی تعیین می شود مجدداً برنامه ریزی می شود.
REQUEUE فقط برای مواردی که رزرو شده اند، با REQUEUE تماس بگیرید. این عمل مورد را از حالت رزرو خارج می کند و زمان در دسترس آن را به زمان ساعت دیواری بازنشانی می کند.