|
楽天ブックス雑誌検索APIとは
楽天ブックス雑誌検索APIは、楽天ブックスで販売されている雑誌の情報を取得することが可能なAPIです。デベロッパーは雑誌のタイトルや出版社名などでの商品検索をはじめ、ジャンル別や在庫状態などでの絞り込み検索も可能となります。
（楽天ブックス総合検索APIよりも詳細な検索が可能となっています。）
|
|
|
■リクエストURL
http://api.rakuten.co.jp/rws/2.0/rest?[parameter]=[value]...
http://api.rakuten.co.jp/rws/2.0/json?[parameter]=[value]...
※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。
フィールド名title, publisherName, sortに対応する[value]はUTF-8でURLエンコードされている必要があります。（リクエストURL全体をエンコードするのではなく、[value]部分を個別にエンコードしてください。）
たとえば、「週間 経済」という雑誌名で、「ビジネス(booksGenreId=007604001)」ジャンルの雑誌を検索し、結果を価格の安い順に並べたい（sort=+itemPrice）場合のリクエストURLは下記になります。（実際には改行せず1行につなげてリクエストしてください。）
http://api.rakuten.co.jp/rws/2.0/rest?
developerId=[YOUR_developerID]
&operation=BooksMagazineSearch
&version=2009-03-26
&title=%E9%80%B1%E9%96%93%20%E7%B5%8C%E6%B8%88
&booksGenreId=007604001
&sort=%2BitemPrice
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■入力パラメーター
| 楽天ブックス雑誌検索API（BooksMagazineSearch) 入力パラメーター version:2009-03-26 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数） |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパーID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名:BooksMagazineSearch |
| 4 |
コールバック関数名 |
callBack |
String |
- |
--- |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
雑誌タイトル |
title |
String |
○
(*1) |
--- |
雑誌のタイトルから検索
UTF-8でURLエンコードした文字列
複数キーワードから検索したい場合は、半角スペースで区切って下さい
(*1)タイトル、出版社名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です |
| 2 |
出版社名 |
publisherName |
String |
○
(*1) |
--- |
出版社名から検索
UTF-8でURLエンコードした文字列
複数キーワードから検索したい場合は、半角スペースで区切って下さい
(*1)タイトル、出版社名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です |
| 3 |
雑誌のJANコード |
jan |
long |
○
(*1) |
--- |
雑誌に付与されているJANコードから検索
(*1)タイトル、出版社名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です |
| 4 |
楽天ブックスジャンルID |
booksGenreId |
String |
○(*1) |
007 |
楽天ブックスにおけるジャンルを特定するためのID
（楽天市場のジャンルIDとは違うので注意してください）
booksGenreId=007（雑誌）に所属するジャンルのみが指定できます
ジャンルのIDやジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ブックスジャンル検索API(BooksGenreSearch)」をご利用ください。
(*1)タイトル、出版社名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です |
| 5 |
バージョン |
version |
String |
○ |
--- |
2009-03-26 |
| 6 |
1ページあたりの取得件数 |
hits |
int |
- |
30 |
1から30までの整数 |
| 7 |
取得ページ |
page |
int |
- |
1 |
1から100までの整数 |
| 8 |
在庫状況 |
availability |
int(1) |
- |
0 |
0：すべての商品
1：在庫あり
2：取り寄せ
3：予約受付中 |
| 9 |
品切れ等購入不可商品表示フラグ |
outOfStockFlag |
int(1) |
- |
0 |
0：品切れや販売終了など購入不可の商品は結果に表示させない
1：品切れや販売終了など購入不可の商品を結果に表示させる |
| 10 |
ソート |
sort |
String |
- |
standard |
standard:標準
sales:売れてる順
+releaseDate:発売日(古い順)
-releaseDate:発売日(新しい順)
+itemPrice:価格(安い順)
-itemPrice:価格(高い順)
+reviewCount:感想の件数(少ない順)
-reviewCount:感想の件数(多い順)
※UTF-8でURLエンコードされている必要があります。 |
| 11 |
キャリア |
carrier |
int(1) |
- |
0 |
PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC: 0
mobile: 1 |
|
■出力パラメーター
| 楽天ブックス雑誌検索API（BooksMagazineSearch) 出力パラメーター version:2009-03-26 |
| 区分 |
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 |
全体情報 |
検索数 |
count |
検索結果の総商品数 |
| 2 |
ページ番号 |
page |
現在のページ番号 |
| 3 |
ページ内商品始追番 |
first |
検索結果の何件目からか |
| 4 |
ページ内商品終追番 |
last |
検索結果の何件目までか |
| 5 |
ヒット件数 |
hits |
1度に返却する商品数 |
| 6 |
キャリア情報 |
carrier |
PC=0 or mobile=1 |
| 7 |
総ページ数 |
pageCount |
最大100 |
| 8 |
商品情報 |
雑誌タイトル |
title |
|
| 9 |
雑誌タイトル カナ |
titleKana |
|
| 10 |
出版社名 |
publisherName |
|
| 11 |
JANコード |
jan |
|
| 12 |
商品説明文 |
itemCaption |
|
| 13 |
発売日 |
salesDate |
|
| 14 |
発行サイクル |
cycle |
|
| 15 |
税込み販売価格 |
itemPrice |
|
| 16 |
割引率 |
discountRate |
通常価格から何パーセント割引きされたか |
| 17 |
商品URL |
itemUrl |
|
| 18 |
アフィリエイトURL |
affiliateUrl |
（入力パラメーターにアフィリエイトIDが含まれていた時のみ） |
| 19 |
商品画像 64x64URL |
smallImageUrl |
(画像サイズ 64px*64px) |
| 20 |
商品画像 128x128URL |
mediumImageUrl |
(画像サイズ 128px*128px) |
| 21 |
商品画像 200x200URL |
largeImageUrl |
(画像サイズ 200px*200px) |
| 22 |
在庫状況 |
availability |
1:在庫あり
2:取り寄せ
3:予約受付中
4:品切れ等購入不可 |
| 23 |
送料フラグ |
postageFlag |
0:送料別
1:宅配送料無料
2:送料無料(コンビニ送料含む)
※キャンペーンなどで実際の送料の扱いは、出力内容と異なることがあります |
| 24 |
限定フラグ |
limitedFlag |
0:通常商品
1:限定商品
2:期間限定商品
3:予約限定商品
4:数量限定商品 |
| 25 |
レビュー件数 |
reviewCount |
|
| 26 |
レビュー平均 |
reviewAverage |
|
| 27 |
ジャンル情報 |
楽天ブックスジャンルID |
booksGenreId |
所属する最下位のジャンルIDを表示
該当商品が複数ジャンルに所属している場合は、「/」で区切ってそれぞれのジャンルIDを表示 |
|
■アフィリエイトに関して
デベロッパーは、楽天ブックス雑誌検索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）]
もしくは、
http://hb.afl.rakuten.co.jp/hgc/[アフィリエイトID]/?m=[商品URL（モバイル）]
|
■エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 |
内容 |
| NotFound |
検索結果が存在しない。 |
| ServerError |
楽天ウェブサービス側のエラー。 |
| ClientError |
デベロッパーの入力に起因するエラー。 |
| Maintenance |
メンテナンス。 |
|
|
