Method: indexing.datasources.items.poll
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
نظرسنجی برای موارد رزرو نشده از صف نمایه‌سازی و علامت‌گذاری مجموعه‌ای به‌عنوان رزرو شده، با مواردی شروع می‌شود که دارای قدیمی‌ترین مُهر زمانی از ItemStatus با بالاترین اولویت هستند. ترتیب اولویت به شرح زیر است:
ERROR
MODIFIED
NEW_ITEM
ACCEPTED
رزرو موارد تضمین می کند که نظرسنجی از رشته های دیگر نمی تواند مجموعه های همپوشانی ایجاد کند.
پس از رسیدگی به موارد رزرو شده، مشتری باید موارد را به حالت رزرو نشده برگرداند، یا با فراخوانی index, یا با فراخوانی push با نوع REQUEUE.
موارد به‌طور خودکار پس از 4 ساعت در دسترس می‌شوند (بدون رزرو) حتی اگر به‌روزرسانی یا روش فشاری فراخوانی نشود.
این API برای اجرا به یک ادمین یا حساب سرویس نیاز دارد. حساب سرویس مورد استفاده در فهرست سفید منبع داده مربوطه است.
درخواست HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
name | string نام داده منبع برای موارد نظرسنجی. قالب: منابع داده/{sourceId} |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"connectorName": string,
"statusCodes": [
enum (ItemStatus.Code)
],
"limit": integer,
"queue": string,
"debugOptions": {
object (DebugOptions)
}
} |
| فیلدها |
|---|
connectorName | string نام رابطی که این تماس را برقرار می کند. قالب: منابع داده/{sourceId}/connectors/{id} |
statusCodes[] | enum ( ItemStatus.Code ) موارد نظرسنجی شده را به موارد دارای این وضعیت محدود کنید. |
limit | integer حداکثر تعداد اقلام برای بازگشت. حداکثر مقدار 100 و مقدار پیش فرض 20 است. |
queue | string نام صف برای واکشی موارد از. اگر نامشخص باشد، items.poll از صف «پیش‌فرض» واکشی می‌شود. حداکثر طول 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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
،
نظرسنجی برای موارد رزرو نشده از صف نمایه‌سازی و علامت‌گذاری مجموعه‌ای به‌عنوان رزرو شده، با مواردی شروع می‌شود که دارای قدیمی‌ترین مُهر زمانی از ItemStatus با بالاترین اولویت هستند. ترتیب اولویت به شرح زیر است:
ERROR
MODIFIED
NEW_ITEM
ACCEPTED
رزرو موارد تضمین می کند که نظرسنجی از رشته های دیگر نمی تواند مجموعه های همپوشانی ایجاد کند.
پس از رسیدگی به موارد رزرو شده، مشتری باید موارد را به حالت رزرو نشده برگرداند، یا با فراخوانی index, یا با فراخوانی push با نوع REQUEUE.
موارد به‌طور خودکار پس از 4 ساعت در دسترس می‌شوند (بدون رزرو) حتی اگر به‌روزرسانی یا روش فشاری فراخوانی نشود.
این API برای اجرا به یک ادمین یا حساب سرویس نیاز دارد. حساب سرویس مورد استفاده در فهرست سفید منبع داده مربوطه است.
درخواست HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll
URL از دستور GRPC Transcoding استفاده می کند.
پارامترهای مسیر
| پارامترها |
|---|
name | string نام داده منبع برای موارد نظرسنجی. قالب: منابع داده/{sourceId} |
درخواست بدن
بدنه درخواست حاوی داده هایی با ساختار زیر است:
| نمایندگی JSON |
|---|
{
"connectorName": string,
"statusCodes": [
enum (ItemStatus.Code)
],
"limit": integer,
"queue": string,
"debugOptions": {
object (DebugOptions)
}
} |
| فیلدها |
|---|
connectorName | string نام رابطی که این تماس را برقرار می کند. قالب: منابع داده/{sourceId}/connectors/{id} |
statusCodes[] | enum ( ItemStatus.Code ) موارد نظرسنجی شده را به موارد دارای این وضعیت محدود کنید. |
limit | integer حداکثر تعداد اقلام برای بازگشت. حداکثر مقدار 100 و مقدار پیش فرض 20 است. |
queue | string نام صف برای واکشی موارد از. اگر نامشخص باشد، items.poll از صف «پیش‌فرض» واکشی می‌شود. حداکثر طول 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
برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.
جز در مواردی که غیر از این ذکر شده باشد،محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است. نمونه کدها نیز دارای مجوز Apache 2.0 License است. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین به‌روزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین به‌روزرسانی 2025-07-25 بهوقت ساعت هماهنگ جهانی."],[],[],null,["# Method: indexing.datasources.items.poll\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.PollItemsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nPolls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority [ItemStatus](/workspace/cloud-search/docs/reference/rest/v1/ItemStatus.Code). The priority order is as follows:\n\n[ERROR](/workspace/cloud-search/docs/reference/rest/v1/ItemStatus.Code#ENUM_VALUES.ERROR)\n\n[MODIFIED](/workspace/cloud-search/docs/reference/rest/v1/ItemStatus.Code#ENUM_VALUES.MODIFIED)\n\n[NEW_ITEM](/workspace/cloud-search/docs/reference/rest/v1/ItemStatus.Code#ENUM_VALUES.NEW_ITEM)\n\n[ACCEPTED](/workspace/cloud-search/docs/reference/rest/v1/ItemStatus.Code#ENUM_VALUES.ACCEPTED)\n\nReserving items ensures that polling from other threads cannot create overlapping sets.\n\nAfter handling the reserved items, the client should put items back into the unreserved state, either by calling [index,](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items/index_#google.apps.search.v1.ItemsService.IndexItem) or by calling [push](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items/push#google.apps.search.v1.ItemsService.PushItem) with the type [REQUEUE.](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items/push#PushItem.Type.ENUM_VALUES.REQUEUE)\n\nItems automatically become available (unreserved) after 4 hours even if no update or push method is called.\n\nThis API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.\n\n### HTTP request\n\n`POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|------------------------------------------------------------------------------------|\n| `name` | `string` The name of the data Source to poll items. Format: datasources/{sourceId} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"connectorName\": string, \"statusCodes\": [ enum (/workspace/cloud-search/docs/reference/rest/v1/ItemStatus.Code) ], \"limit\": integer, \"queue\": string, \"debugOptions\": { object (/workspace/cloud-search/docs/reference/rest/v1/DebugOptions) } } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `connectorName` | `string` The name of connector making this call. Format: datasources/{sourceId}/connectors/{id} |\n| `statusCodes[]` | `enum (`[ItemStatus.Code](/workspace/cloud-search/docs/reference/rest/v1/ItemStatus.Code)`)` Limit the items polled to the ones with these statuses. |\n| `limit` | `integer` Maximum number of items to return. The maximum value is 100 and the default value is 20. |\n| `queue` | `string` Queue name to fetch items from. If unspecified, items.poll will fetch from 'default' queue. The maximum length is 100 characters. |\n| `debugOptions` | `object (`[DebugOptions](/workspace/cloud-search/docs/reference/rest/v1/DebugOptions)`)` Common debug options. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------|\n| ``` { \"items\": [ { object (/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#Item) } ] } ``` |\n\n| Fields ||\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `items[]` | `object (`[Item](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#Item)`)` Set of items from the queue available for connector to process. These items have the following subset of fields populated: [version](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#Item.FIELDS.version) [metadata.hash](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemMetadata.FIELDS.hash) [structuredData.hash](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemStructuredData.FIELDS.hash) [content.hash](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent.FIELDS.hash) [payload](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#Item.FIELDS.payload) [status](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#Item.FIELDS.status) [queue](/workspace/cloud-search/docs/reference/rest/v1/indexing.datasources.items#Item.FIELDS.queue) |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud_search.indexing`\n- `https://www.googleapis.com/auth/cloud_search`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
