Method: indexing.datasources.items.push

將項目推送到佇列，以便稍後輪詢及更新。

您必須具備管理員或服務帳戶才能執行這個 API。使用的服務帳戶已列入對應資料來源的許可清單。

HTTP 要求

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

這個網址使用 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 欄位會導致引數錯誤。長度上限為 2,048 個半形字元。
item.structuredDataHash

string

項目的結構化資料雜湊 (取決於存放區)。如已指定，系統會根據這個值判斷如何修改這個項目的狀態。設定這個欄位和 type 欄位會導致引數錯誤。長度上限為 2,048 個半形字元。
item.contentHash

string

存放區的內容雜湊值。如已指定，系統會根據這個值判斷如何修改這個項目的狀態。設定這個欄位和 type 欄位會導致引數錯誤。長度上限為 2,048 個半形字元。
item.payload

string (bytes format)

提供連接器的其他文件狀態資訊，例如替代存放區 ID 和其他中繼資料。長度上限為 8,192 個位元組。

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 欄位會導致引數錯誤。長度上限為 2,048 個半形字元。
structuredDataHash

string

項目的結構化資料雜湊 (取決於存放區)。如已指定，系統會根據這個值判斷如何修改這個項目的狀態。設定這個欄位和 type 欄位會導致引數錯誤。長度上限為 2,048 個半形字元。
contentHash

string

存放區的內容雜湊值。如已指定，系統會根據這個值判斷如何修改這個項目的狀態。設定這個欄位和 type 欄位會導致引數錯誤。長度上限為 2,048 個半形字元。
payload

string (bytes format)

提供連接器的其他文件狀態資訊，例如替代存放區 ID 和其他中繼資料。長度上限為 8,192 個位元組。

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 呼叫推送。這項操作會取消保留該項目，並將該項目的可用時間重設為實際時間。