ご利用マニュアル

ランキング情報取得

作成者: レコメンドサポート担当|2021.10.13

ランキング情報の取得を行うAPIです。
出力方法はJsonです。

概要

GET https://connect.rcmd.jp/connector/rankings/[account]/[recommend]/[type]/[span]?limit=[limit]

前提

  • サイト内の行動履歴収集のため、アイテム詳細ページにJavaScriptタグによるトラッキング情報収集タグ設置が必須
  • type「CV」を利用する場合、CV完了ページにJavaScriptタグによるCV情報取得タグ設置が必須
  • 「url」パラメータの値には、トラッキングに必要なパラメータが付いているため、「url」パラメータで取得した値はそのまま使用する

処理概要

ランキング情報の取得を行います。

パラメタ

要否

説明

account

必須

アカウント名
レコメンド管理画面にログインする際の「アカウントID」です。

recommend

必須

レコメンド名
レコメンド管理画面URL内のパスが、以下の構造になっています。
https://adm.rcmd.jp/アカウントID/レコメンド名/XXXXXXX
お手数ですが、レコメンド管理画面URLよりご確認をお願いします。

type

必須

表示種別。pv / cv のいずれか を指定

span

必須

day / week / month

 

オプション

要否

説明

limit

任意

最大取得件数を指定
※ 通常上限は10件となります。10件以上取得したい場合はご連絡ください。

Headers

Content-Type: application/json

Response  200

Headers

Content-Type: application/json

Body

{
"ranking":{
"type": "pv",
"span": "day",
"items":[
{ ランキングアイテム情報(一位) },
{ ランキングアイテム情報(二位) },
・・・
]
}
}

ランキングアイテム情報の内容

"rank": [ランクキング順位(数値1~)], 
"code": [アイテムコード],
"url": [アイテムページのURL],
"name": [アイテム名],
"image": [アイテム画像のURL],
"price": [商品価格],
"category": [カテゴリ情報],
"release_date": [リリース日],
"stock": [在庫],
:
(その他ユーザ任意項目)
: