OpenSearch アプリケーション内のデータ収集に、ユーザーの動作または属性レコードのバッチをプッシュします。
リクエスト構文
POST /v3/openapi/app-groups/{appName}/data-collections/{dataCollectionName}/data-collection-type/{dataCollectionType}/actions/bulkパスパラメーター
| パラメーター | 説明 |
|---|---|
appName | OpenSearch アプリケーションの名称です。 |
dataCollectionName | データ収集の名称です。デフォルト値は OpenSearch アプリケーションの名称です。 |
dataCollectionType | プッシュ対象のデータの種別です。有効な値： USER、ITEM_INFO、BEHAVIOR、INDUSTRY_SPECIFIC。 |
上記の URL では、エンドポイントおよびリクエストヘッダーのパラメーターは省略されています。詳細については、「リクエスト構造」をご参照ください。
リクエストボディ
リクエストボディは、docs パラメーターの値として渡される JSON 配列です。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
docs | リスト | はい | プッシュ対象のドキュメントのリストです。 |
docs リスト内の各ドキュメントオブジェクトには、以下のパラメーターが含まれます。
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
cmd | 文字列 | はい | 実行する操作です。ADD を指定します。 |
fields | マップ | はい | ドキュメントのフィールドです。フィールドスキーマは対象テーブルの種別と一致している必要があります。 |
fields パラメーター
fields の値は、キーが対象テーブルのスキーマと一致する必要があるキー-値マップです。 OpenSearch は、ユーザーテーブル、アイテムテーブル、動作テーブルの 3 つのテーブルタイプをサポートしています。 各テーブルタイプのフィールド定義については、「データコレクション 2.0」をご参照ください。
レスポンス要素
| パラメーター | 型 | 説明 |
|---|---|---|
errors | リスト | エラーの詳細です。 |
status | 文字列 | リクエストの結果です。有効な値： OK（成功）、FAIL（失敗）。リクエストが失敗した場合は、エラーコードに基づいてトラブルシューティングを行ってください。 |
request_id | 文字列 | リクエスト ID です。 |
result | ブール値 | リクエストが成功した場合、true を返します。失敗した場合は返されません。 |
例
リクエスト
POST /v3/openapi/app-groups/zhao_special/data-collections/zhao_special/data-collection-type/behavior/actions/bulk[
{
"cmd": "ADD",
"fields": {
"sdk_type": "opensearch_sdk",
"sdk_version": "3.2.0",
"user_id": "10469628",
"biz_id": 123,
"trace_id": "231084198510103333",
"item_id": "id",
"item_type": "item",
"bhv_type": "click",
"reach_time": "20190730105931"
}
}
]レスポンス
{
"errors": [],
"request_id": "155084740119723291017595",
"status": "OK",
"result": true
}