|
楽天ダイナミックアドAPIとは
■リクエストURL
http://dynamic.rakuten.co.jp/rcm/1.0/i/rest?[parameter]=[value]...
http://dynamic.rakuten.co.jp/rcm/1.0/i/json?[parameter]=[value]...
※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。
フィールド名urlに対応する[value]はUTF-8でURLエンコードされている必要があります。（リクエストURL全体をエンコードするのではなく、 [value]部分を個別にエンコードしてください。）
※出力される楽天の商品は5件（固定）となります。
たとえば、「【続報】お酒♪取り寄せる価値ありの逸品」というページにマッチする楽天の商品一覧を取得する場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。）
http://dynamic.rakuten.co.jp/rcm/1.0/i/rest?
developerId=[YOUR_developerID]
&affiliateId=[YOUR_affiliateID]
&url=http%3a%2f%2fplaza%2erakuten%2eco%2ejp%2fisblog%2fdiary%2f200705230001%2f
| ※ |
短い時間の間に大量にリクエストへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■入力パラメーター
| 楽天ダイナミックアドAPI 入力パラメータ |
| ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数） |
必須 |
デフォルト |
備考 |
|
1 |
デベロッパーID |
developerId |
String |
○ |
--- |
デベロッパーID |
|
2 |
アフィリエイトID |
affiliateId |
String |
○ |
--- |
アフィリエイトID（β版） |
|
3 |
URL |
url |
String |
○ |
--- |
楽天の商品を掲載するページのURL |
|
4 |
キャリア |
carrier |
int |
- |
0 |
楽天の商品を掲載するページの種類
0:PCサイト
1:携帯サイト(注1) |
|
5 |
コールバック関数名 |
callBack |
String |
- |
--- |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
|
■出力パラメーター
| 楽天ダイナミックアドAPI 出力パラメータ |
| 区分 |
ID |
分類 |
項目名 |
フィールド名 |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
Arg
|
--- |
User-Agent |
Valueにはユーザのユーザエージェントが表示される |
|
2 |
--- |
developerId |
Valueにはユーザの指定したデベロッパーが表示される |
|
3 |
--- |
affiliateId |
Valueにはユーザの指定したアフィリエイトIDが表示される |
|
4 |
--- |
version |
Valueにはユーザの指定した操作のバージョンが表示される |
|
5 |
Status |
--- |
Status |
Success / NotFound / ServerError / ClientError / Maintenance のいずれか |
|
6 |
StatusMsg |
--- |
StatusMsg |
Statusに特化したメッセージを出力 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
商品情報
|
商品名 |
itemName |
|
|
2 |
商品コード |
itemCode |
|
|
3 |
商品価格 |
itemPrice |
|
|
4 |
アフィリエイト商品URL |
affiliateItemUrl |
|
|
5 |
商品画像64x64URL |
smallImageUrl |
（画像サイズ64px*64px） |
|
6 |
商品画像128x128URL |
mediumImageUrl |
（画像サイズ128px*128px） |
|
7 |
消費税フラグ |
taxFlag |
0：税込
1：税別 |
|
8 |
送料フラグ |
postageFlag |
0：送料込
1：送料別 |
|
9 |
クレジットカード利用可能フラグ |
creditCardFlag |
0：カード利用不可
1：カード利用可 |
|
10 |
レビュー件数 |
reviewCount |
|
|
11 |
レビュー平均 |
reviewAverage |
|
|
12 |
ジャンル情報 |
ジャンルID |
genreId |
|
|
■モバイルページでご利用時の注意
キャリア(carieer)で「1:携帯サイト」を入力した場合、下記の点にご注意ください。
・弊社のクローラーのIPアドレス（203.190.60.3）からのアクセスを許可してください。
・弊社のクローラーは携帯サイトの情報を取得する際には、User-Agent:DoCoMo/2.0 N902iS(c100;TB;W24H12)(compatible; Rakutenbot/1.0; +http://dynamic.rakuten.co.jp/bot.html)でアクセスしますので、このUser-Agentでのアクセスを許可してください。
■エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 |
内容 |
| NotFound |
検索結果が存在しない。 |
| ServerError |
楽天ウェブサービス側のエラー。 |
| ClientError |
デベロッパーの入力に起因するエラー。 |
| Maintenance |
メンテナンス。 |
|
|
