レコメンデーションAPI

レコメンデーションAPIについて
本APIは、ECサイトにておなじみの「オススメ商品」・「この商品を買った人はこの商品もかっています」などの情報を、ユーザの行動履歴に従ってアイテムベースで解析、取得できる機能を提供します。
ご利用方法
※ご利用には、サービス毎のデータを識別する為にアプリケーションIDの登録が必要です。まだの方はコチラ
行動履歴データの登録
行動履歴データとは、サービス利用者（消費者）がサイト内において、商品詳細ページの閲覧や、カートに追加又は商品購入など、商品のレコメンドに必要な行動をとった際の情報の事を指し、 それらのデータを解析することでレコメンドを行うことが可能になります。
以下の方法で必要なページにタグを設置することでデータの登録が簡単に行えます。
エンドポイントURL
http://wiki.balloo.jp/recm/api/item_beacon.gif
リクエストパラメータ
パラメータ名 型 意味
AID（必須） String アプリケーションID。あなたのサービスを識別する為のID。
UID（必須） String（128桁） ユーザID。行動履歴データを識別する為のID。このIDに従って集計・解析される。よって、同一ユーザでも日毎に行動履歴を分けて解析したい。もしくは、一回の購入でセット購入したものを推薦対象のセットとしたいなど、サービスでのレコメンド方法を考慮にいれて設定下さい。わからない場合は、ユーザIDもしくはセッションIDを設定することで、ある程度の精度の結果となります。
IID（必須） String（1024桁） 商品ID。レコメンドアイテムを識別する為のID。
カートで購入時など一回のタイミングで商品が複数ある場合は、複数指定
例）
IID={001}&IID={002}&IID={003}
ISL（任意） 0 or 1 レコメンド経由で商品詳細ページを表示したか否かを識別する為のパラメータ。0 or 1のどちらかを指定。
1: レコメンド結果のリンクを経由した場合
0: レコメンド結果のリンクを経由しない場合
※指定がない場合は0と判断
DK（任意） 1 or 2 or 3 行動の種類を指定。
1: 商品詳細ページを閲覧した際に指定
2: 商品に興味を示した行動をした際に指定
3: 商品を購入した際に指定
※上記はあくまでも一般的なECサービスのパターンを示したものなので、1~3の意味については各サービスにより異なる意味でご利用されても問題ありません。
設置例）
<img src="http://wiki.balloo.jp/recm/api/item_beacon.gif?AID={あなたのアプリケーションID}&UID={ユーザID}&IID={商品ID}&ISL=0&DK=1"/>

レコメンド結果の取得
行動履歴データの登録にて登録されたデータを基に解析した結果、その商品に対して推薦の商品の情報を返却します。
※データの解析及び更新は毎日朝4時に自動で行われます。
エンドポイントURL
http://wiki.balloo.jp/recm/api/recommendation_item.html
リクエストパラメータ
パラメータ名 型 意味
AID（必須） String アプリケーションID。あなたのサービスを識別する為のID。
IID（必須） String（1024桁） 商品ID。レコメンドの基商品となる商品のID
DK（任意） 1 or 2 or 3 推薦対象の行動の種類を指定。
1: 商品詳細ページを閲覧した際
2: 商品に興味を示した際
3: 商品を購入した際
※1~3を各サービスにより異なる意味でご利用されている場合は、その意味での集計になります
※未指定の場合は全パターンを対象に解析。
レスポンス
タグ名 意味
/Result/Request/AID リクエストされたアプリケーションID。
/Result/Request/IID リクエストされた商品ID。
/Result/Request/status/@code リクエスト結果
0: 正常
-1: サーバにて何らかのエラーが発生
/Result/Responce/Item/@base_item_id リクエストされた商品ID。
/Result/Responce/Item/@recommend_item_id 推薦商品のID。
/Result/Responce/Item/@count その商品を参照したユニークユーザ数
/Result/Responce/Item/@ratio 商品の推薦度（単位：%　0~100）

サンプルレスポンス

HOME > レコメンデーションAPI

▲ページの先頭へ