Method: indexing.datasources.items.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 リポジトリ内のアイテムは、前回の update 呼び出しから変更されていません。この push オペレーションはステータスを ACCEPTED 状態に設定します。
REPOSITORY_ERROR このアイテムに関するリポジトリ エラーがコネクタで発生しています。ステータスを REPOSITORY_ERROR 状態に変更する。アイテムは予約解除され、指数バックオフによって決定された将来の時間に再スケジュールされます。
REQUEUE 予約済みのアイテムに対してのみ、REQUEUE を指定して push を呼び出します。この操作により、アイテムの予約が解除され、使用可能な時間が実時間にリセットされます。