Method: indexing.datasources.items.poll

針對索引佇列中未保留的項目進行意見調查，並將該項目標示為已保留，開頭日期為最高優先順序 ItemStatus 的項目。優先順序如下：

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

保留項目可確保從其他執行緒輪詢不會建立重疊集。

處理保留項目後，用戶端應呼叫 index, 或透過 REQUEUE. 類型呼叫 push，將項目放回未保留狀態

即使未呼叫更新或推送方法，項目在 4 小時後就會自動開放使用 (無法保留)。

這個 API 需要管理員或服務帳戶才能執行。使用的服務帳戶會列入對應資料來源的許可清單中。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

輪詢項目的資料來源名稱。格式：datasources/{sourceId}

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
欄位
connectorName

string

發出此呼叫的連接器名稱。

格式：datasources/{sourceId}/connectors/{ID}
statusCodes[]

enum (ItemStatus.Code)

限制只有處於這些狀態的項目才會輪詢項目。
limit

integer

傳回的項目數量上限。

最大值 100，預設值為 20。
queue

string

要從中擷取項目的佇列名稱。如未指定，系統會從「default」擷取 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

詳情請參閱授權指南。