Method: indexing.datasources.items.push

アイテムをキューに push して、後でポーリングして更新します。

この API を実行するには、管理者またはサービス アカウントが必要です。使用されるサービス アカウントは、対応するデータソースでホワイトリストに登録されているアカウントです。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
item.name

string

インデックス キューに push する item の名前。

形式: datasources/{sourceId}/items/{id}

これは必須項目です。最大長は 1,536 文字です。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

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)

push 動作を定義する push オペレーションのタイプ。
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

インデックス キューに push されるアイテムを表します。

JSON 表現 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
フィールド
name

string

インデックス キューに push する item の名前。

形式: datasources/{sourceId}/items/{id}

これは必須項目です。最大長は 1,536 文字です。
type

enum (PushItem.Type)

push 動作を定義する push オペレーションのタイプ。
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

push 動作を定義する push オペレーションのタイプ。

列挙型
UNSPECIFIED デフォルトは UNSPECIFIED です。push オペレーションで ItemStatus を変更しないように指定します。
MODIFIED 前回の update 呼び出し以降にリポジトリ ドキュメントが変更または更新されたことを示します。これにより、既存のアイテムのステータスが MODIFIED 状態に変わります。存在しないアイテムに対して呼び出されると、ステータスは NEW_ITEM に変更されます。
NOT_MODIFIED リポジトリ内のアイテムは、前回の更新呼び出し以降変更されていません。この push オペレーションにより、ステータスが ACCEPTED 状態に設定されます。
REPOSITORY_ERROR このアイテムに関して、コネクタでリポジトリ エラーが発生しています。ステータスを REPOSITORY_ERROR に変更します。アイテムは予約解除され、指数バックオフによって決定された将来の時刻に再スケジュールされます。
REQUEUE 予約済みのアイテムにのみ、REQUEUE を指定して push を呼び出します。このアクションにより、アイテムの予約が解除され、使用可能な時間が壁時計の時間にリセットされます。