概要
API操作を呼び出して、収集したデータを特定のアプリケーションにプッシュできます。
サポートされているHTTPリクエストメソッド
POST
URL
/v3/openapi/app-groups/{appName}/data-collections/{dataCollectionName}/data-collection-type/{dataCollectionType}/actions/bulkappName パラメーターをOpenSearchアプリケーションの名前に置き換えます。
dataCollectionName パラメーターをプッシュするデータコレクションの名前に置き換えます。デフォルトでは、このパラメーターはOpenSearchアプリケーションの名前に設定されています。
dataCollectionType パラメーターをプッシュするデータのタイプに置き換えます。有効な値：USER、ITEM_INFO、BEHAVIOR、およびINDUSTRY_SPECIFIC。
上記のサンプルURLには、リクエストヘッダーのパラメーターやOpenSearchへの接続に使用するエンドポイントなどの情報は省略されています。完全なリクエスト構造の詳細については、リクエスト構造を参照してください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
docs | リスト | はい | ドキュメントのリスト。 |
ドキュメント関連のパラメーター
パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
cmd | 文字列 | はい | ドキュメントに対して実行される操作。値をADDに設定します。 |
fields | マップ | はい | フィールドのコレクション。 |
fields パラメーター
fields パラメーターの値は、特定のテーブルのフィールドのコレクションです。OpenSearchは、異なるスキーマを持つ以下のタイプのテーブルをサポートしています：ユーザーテーブル、アイテムテーブル、および行動テーブル。たとえば、行動テーブルにデータをプッシュする場合、fields パラメーターには行動テーブルで定義されているフィールドが含まれている必要があります。詳細については、データコレクション 2.0を参照してください。
パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
field1 | xxx | はい | 特定のテーブルのフィールド。 |
field2 | xxx | はい | 特定のテーブルのフィールド。 |
レスポンスパラメーター
パラメーター | タイプ | 説明 |
|---|---|---|
errors | リスト | エラーの詳細。 |
status | 文字列 | リクエストの実行結果。有効な値：OKとFAIL。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
}