Shopping Intentの作成

Prev Next

VPC環境で利用できます。

Shopping Intentの Profileを作成します。

Profileの作成をリクエストすると、次の順序で作成が行われます。

順序 作成状態 説明
Step 1 registered: 登録完了 作成作業が NCLUEシステムに登録された状態
  • 作業開始前の状態で、Profileを削除すると作業をキャンセルできる
Step 2 pending: 待機中 作成作業がシステムキューに登録された状態
Step 3 in_progress: 作成中 作成作業がサーバで実行中の状態
Step 4
  • complete: 使用可能
  • failed: 失敗
 作成作業が完了した状態
  • 作成に成功するとcomplete状態になり、正常に使用可能
  • 作業中に発生したエラーにより作成できなかった場合はfailed状態になり、使用不可
参考

Profileの作成にかかる時間は、データ量と利用可能なリソースの状況によります。作成の進行状況は、Shopping Intentの照会 APIを呼び出すとレスポンスボディのstatusフィールドで確認できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /profile/shopping-intents

リクエストヘッダ

NCLUE APIで共通して使用されるヘッダの詳細は、NCLUEのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
name String Required Profile名
  • 1~100文字
task_id String Required プロファイリングに適用する Task ID

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/profile/shopping-intents' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
--data '{
    "name": "YOUR_PROFILE_NAME",
    "task_id": "3179664c-****-****-****-af6354344018"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
profile_id String - Profile ID
profile_name String - Profile名
task_id String - プロファイリングに適用する Task ID
task_name String - プロファイリングに適用する Task名
created_at String - Profile作成リクエスト日時(ISO 8601形式)

レスポンスステータスコード

NCLUEで共通して使用されるレスポンスステータスコードの詳細は、NCLUEのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "profile_id": "da523192-****-****-****-01fce3b4f90d",
    "profile_name": "YOUR_PROFILE_NAME",
    "task_id": "3179664c-****-****-****-af6354344018",
    "task_name": "YOUR_TASK_NAME",
    "created_at": "2024-11-26T16:47:27+09:00"
}