- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- 承認スコープ
- PushItem
<ph type="x-smartling-placeholder">
- </ph>
- JSON 表現
- PushItem.Type
- 試してみる
後でポーリングして更新できるように、アイテムをキューにプッシュします。
この API を実行するには、管理者またはサービス アカウントが必要です。使用されるサービス アカウントが、対応するデータソースの許可リストに登録されている。
HTTP リクエスト
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:push
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
item.name |
インデックス キューに push する 形式: datasources/{sourceId}/items/{ID} これは必須項目です。最大長は 1,536 文字です。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "item": { "name": string, "type": enum ( |
フィールド | |
---|---|
item.type |
push 動作を定義する push オペレーションのタイプ。 |
item.metadataHash |
リポジトリに基づくアイテムのメタデータ ハッシュ。指定すると、このアイテムのステータスを変更する方法が決まります。このフィールドと |
item.structuredDataHash |
リポジトリに基づくアイテムの構造化データハッシュ。指定すると、このアイテムのステータスを変更する方法が決まります。このフィールドと |
item.contentHash |
リポジトリに基づくアイテムのコンテンツ ハッシュ。指定すると、このアイテムのステータスを変更する方法が決まります。このフィールドと |
item.payload |
代替リポジトリ ID やその他のメタデータなど、コネクタのドキュメント状態に関する追加情報を提供します。最大長は 8,192 バイトです。 Base64 でエンコードされた文字列。 |
item.queue |
このアイテムが属するキュー。このフィールドを指定しない場合は、 |
item.repositoryError |
このフィールドにデータを入力して、コネクタまたはリポジトリのエラーの詳細を保存します。この情報は管理コンソールに表示されます。このフィールドは、 |
connectorName |
この呼び出しを行うコネクタの名前。 形式: datasources/{sourceId}/connectors/{ID} |
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 ( |
フィールド | |
---|---|
name |
インデックス登録キューに push する 形式: datasources/{sourceId}/items/{ID} これは必須項目です。最大長は 1,536 文字です。 |
type |
push 動作を定義する push オペレーションのタイプ。 |
metadataHash |
リポジトリに基づくアイテムのメタデータ ハッシュ。指定すると、このアイテムのステータスを変更する方法が決まります。このフィールドと |
structuredDataHash |
リポジトリに基づくアイテムの構造化データハッシュ。指定すると、このアイテムのステータスを変更する方法が決まります。このフィールドと |
contentHash |
リポジトリに基づくアイテムのコンテンツ ハッシュ。指定すると、このアイテムのステータスを変更する方法が決まります。このフィールドと |
payload |
代替リポジトリ ID やその他のメタデータなど、コネクタのドキュメント状態に関する追加情報を提供します。最大長は 8,192 バイトです。 Base64 でエンコードされた文字列。 |
queue |
このアイテムが属するキュー。このフィールドを指定しない場合は、 |
repositoryError |
このフィールドにデータを入力して、コネクタまたはリポジトリのエラーの詳細を保存します。この情報は管理コンソールに表示されます。このフィールドは、 |
PushItem.Type
push 動作を定義する push オペレーションのタイプ。
列挙型 | |
---|---|
UNSPECIFIED |
デフォルトは UNSPECIFIED です。push オペレーションで ItemStatus を変更しないことを指定します |
MODIFIED |
前回の update 呼び出し以降に、リポジトリ ドキュメントが変更または更新されたことを示します。これにより、既存のアイテムのステータスが MODIFIED に変わります。これが存在しないアイテムに対して呼び出されると、ステータスは NEW_ITEM に変更されます。 |
NOT_MODIFIED |
リポジトリ内のアイテムは、前回の update 呼び出しから変更されていません。この push オペレーションはステータスを ACCEPTED 状態に設定します。 |
REPOSITORY_ERROR |
このアイテムに関するリポジトリ エラーがコネクタで発生しています。ステータスを REPOSITORY_ERROR 状態に変更する。アイテムは予約解除され、指数バックオフによって決定された将来の時間に再スケジュールされます。 |
REQUEUE |
予約済みのアイテムに対してのみ、REQUEUE を指定して push を呼び出します。この操作により、アイテムの予約が解除され、使用可能な時間が実時間にリセットされます。 |