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)

このフィールドにデータを入力して、コネクタやリポジトリのエラーの詳細を保存します。この情報は管理コンソールに表示されます。このフィールドは、typeREPOSITORY_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

詳しくは、OAuth 2.0 の概要をご覧ください。

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)

このフィールドにデータを入力して、コネクタやリポジトリのエラーの詳細を保存します。この情報は管理コンソールに表示されます。このフィールドは、typeREPOSITORY_ERROR の場合にのみ入力されます。

PushItem.Type

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

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