|
楽天プロダクト製品検索APIとは
| 楽天プロダクト製品検索APIは、キーワードやジャンルによって楽天プロダクト内の製品を検索することが可能なAPIです。 |
|
|
■リクエストURL（REST／JSON形式の場合）
http://api.rakuten.co.jp/rws/3.0/rest?[parameter]=[value]…
http://api.rakuten.co.jp/rws/3.0/json?[parameter]=[value]…
※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。
フィールド名keyword, sortに対応する[value]はUTF-8でURLエンコードされている必要があります。（リクエストURL全体をエンコードするのではなく、[value]部分を個別にエンコードしてください。）
たとえば、「ノートパソコン」という検索キーワードで、かつ「ノートパソコン（ジャンルID:100040）」から検索した場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。）
http://api.rakuten.co.jp/rws/3.0/rest?
developerId=[YOUR_developerID]
&operation=ProductSearch
&version=2010-11-18
&keyword=%E3%83%8E%E3%83%BC%E3%83%88%E3%83%91%E3%82%BD%E3%82%B3%E3%83%B3
&genreId=100040
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■入力パラメーター
| 楽天プロダクト製品検索API（ProductSearch) 入力パラメーター version:2010-11-18 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数） |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名：
ProductSearch |
| 4 |
コールバック関数名 |
callBack |
String |
- |
指定無し |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
検索キーワード |
keyword |
String |
○(*1) |
--- |
UTF-8でURLエンコードした文字列
(*1)検索キーワード、ジャンルIDのいずれかが指定されていることが必須です。 |
| 2 |
バージョン |
version |
String |
○ |
--- |
2010-11-18 |
| 3 |
ジャンルID |
genreId |
long |
○(*1) |
0 |
楽天市場におけるジャンルを特定するためのID
ジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ジャンル検索API(GenreSearch)」をご利用ください
(*1)検索キーワード、ジャンルIDのいずれかが指定されていることが必須です。 |
| 4 |
製品最大取得件数 |
maxProductHits |
int |
- |
30 |
1から60までの整数 |
| 5 |
最小価格 |
minPrice |
long |
- |
指定無し |
0以上の整数 |
| 6 |
最大価格 |
maxPrice |
long |
- |
指定無し |
0以上の整数
maxPriceはminPriceより大きい必要がある |
|
■出力パラメーター
| 楽天プロダクト製品検索API（ProductSearch) 出力パラメーター version:2010-11-18 |
| 区分 |
ID |
大分類 |
分類 |
項目名 |
フィールド名 |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
ARG |
--- |
User-Agent |
Valueにはユーザのユーザエージェントが表示される |
| 2 |
--- |
developerId |
ValueにはデベロッパーIDが表示される |
| 3 |
--- |
affiliateId |
ValueにはアフィリエイトIDが表示される |
| 4 |
--- |
operation |
Valueにはユーザの指定した操作名が表示される |
| 5 |
--- |
version |
Valueにはユーザの指定した操作のバージョンが表示される |
| 6 |
Status |
--- |
Status |
Success / NotFound / ServerError / ClientError / Maintenance のいずれか |
| 7 |
StatusMsg |
--- |
StatusMsg |
Statusに特化したメッセージを出力 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
全体情報 |
ヒット件数 |
hits |
|
| 2 |
製品基本情報 |
楽天プロダクト製品ID |
productId |
|
| 3 |
製品名 |
productName |
|
| 4 |
製品ページURL(PC) |
productUrlPC |
|
| 5 |
製品ページURL(モバイル) |
productUrlMobile |
|
| 6 |
アフィリエイトURL |
affiliateUrl |
PC/モバイル両対応のURLを返却 |
| 7 |
製品画像64x64URL |
smallImageUrl |
（画像サイズ64px*64px） |
| 8 |
製品画像128x128URL |
mediumImageUrl |
（画像サイズ128px*128px） |
| 9 |
製品説明文 |
productCaption |
|
| 10 |
発売年月日 |
releaseDate |
|
| 11 |
当該製品の取扱商品数 |
itemCount |
※中古品、売り切れ商品も含む |
| 12 |
メーカー情報 |
楽天プロダクトメーカーコード |
makerCode |
|
| 13 |
会社名 |
makerName |
|
| 14 |
価格情報 |
標準価格 |
productPrice |
オープン価格フラグが「1」の場合、もしくは、標準価格の情報がない場合には、
標準価格の値は「0」になる |
| 15 |
オープン価格フラグ |
openPriceFlag |
0：通常の製品
1：オープン価格製品 |
| 16 |
消費税フラグ |
taxFlag |
0：不明 1：税込 2：税抜
※オープン価格フラグが「1」の場合、もしくは、標準価格の情報がない場合には、
消費税フラグは「0」になる |
| 17 |
最低価格 |
minPrice |
※中古品、売り切れ商品も含む |
| 18 |
評価情報 |
レビュー数 |
reviewCount |
|
| 19 |
レビュー平均 |
reviewAverage |
|
| 20 |
ジャンル情報 |
ジャンルID |
genreId |
|
| 21 |
ジャンル名 |
genreName |
|
|
■アフィリエイトに関して
デベロッパーは、楽天プロダクト製品検索APIから取得した商品情報からアフィリエイトURLを作成することが可能です。リンク先にそのアフィリエイトURLを指定することで、楽天アフィリエイト経由の成果報酬を獲得することができます。
アフィリエイトURLの作り方は2通りあります。入力パラメーターcarrierでPCが指定された場合でもモバイルが指定された場合でも同様の方法でアフィリエイトURLを作成することができます。
| （1） |
APIの入力パラメーターに「アフィリエイトID」を含める場合：
APIの出力に「アフィリエイトURL」が含まれます。
|
| （2） |
デベロッパーが自ら、（APIから取得した）「商品URL」と「アフィリエイトID（β版）」から「アフィリエイトURL」を作成する場合：
「アフィリエイトURL」は以下のルールで生成可能です。ただし、「商品URL」の部分はURLエンコードされている必要があります。
http://hb.afl.rakuten.co.jp/hgc/[アフィリエイトID]/?pc=[商品URL（PC）]&m=[商品URL（モバイル）]
|
■エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 |
内容 |
| NotFound |
検索結果が存在しない。 |
| ServerError |
楽天ウェブサービス側のエラー。 |
| ClientError |
デベロッパーの入力に起因するエラー。 |
| Maintenance |
メンテナンス。 |
| AccessForbidden |
リクエスト回数制限オーバー。
※しばらく時間を空けて、再度ご利用ください |
|
|
