商品カタログは、AI 肌分析 (AI Skin Analysis) が商品レコメンド (Product Recommendation) に使用する商品のリストです。カタログは 1 度アップロードすれば catalog_id が残り、その ID を肌分析に渡すだけです。カタログは、削除するまで保持されます。
カタログは個別の API キーではなくアカウントに属します。プロジェクトキーも含め、アカウントのすべての API キーが同じカタログを参照します。キーのローテーションや削除の影響も受けません。
カタログのアップロードと保存は無料です。
- カタログファイル
| 項目 | 値 |
|---|---|
| 形式 | ヘッダー行付きの CSV |
| エンコーディング | UTF-8（BOM（バイトオーダーマーク）の有無は問いません）。Excel の「CSV UTF-8」形式では BOM が付与されます。 |
| ファイルサイズの上限 | 5 MB |
| SKU 数の上限 | ファイルサイズの上限以外にはありません |
必須の列：
| 列 | 説明 |
|---|---|
product_id | お客様の商品 ID |
product_name | 商品名 |
product_description | 商品の説明 |
その他の列は無視されますが、5 MB の上限にはカウントされます。カンマや改行を含む値は、標準の CSV と同じくクォートで囲んでください。空でないデータ行は 1 行につき 1 SKU としてカウントされます。
例：
product_id,product_name,product_description
SKU-001,Hydrating Serum,"A lightweight serum for dry skin."
SKU-002,Brightening Cream,"Evens out skin tone, for daily use."- カタログの状態
| ステータス | 意味 | 肌分析で使用可能 |
|---|---|---|
ready | アップロードと検証が完了 | 可 |
failed | アップロードされたが、ファイルの検証に失敗 | 不可 |
検証に失敗したアップロードはエラーを返しますが、failed 状態のカタログとして記録され、カタログ一覧 (List catalogs) に表示されます。削除は他のカタログと同じです。
- 制限
1 つのアカウントで保持できるカタログは、ready と failed を合わせて最大 10 件です。新しいカタログをアップロードする前に、既存のカタログを削除してください。
カタログを更新するには、新しいファイルをアップロードします。アップロードごとに新しい catalog_id が作成され、旧カタログは削除するまで使用できるため、新しいカタログを確認してから切り替えることができます。
- 削除
カタログの削除は即座に完了し、元に戻せません。削除された時点で、その catalog_id を使用するすべての肌分析呼び出しが失敗します。削除したカタログを復元することはできません。同じファイルを再アップロードすると、新しい catalog_id を持つ新しいカタログが作成されます。