楽天ブックスジャンル検索APIは楽天ブックスのジャンル名・ジャンル構造を返すAPIです。デベロッパーはジャンルIDを指定することでこれらの情報を得ることができます。
リクエスト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を指定することで出力されます。
たとえば、第一階層目のジャンル一覧を取得したい場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)
http://api.rakuten.co.jp/rws/2.0/rest?
developerId=[YOUR_developerID]
&operation=BooksGenreSearch
&version=2009-03-26
&booksGenreId=000
※短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。
入力パラメーター
楽天ブックスジャンル検索API(BooksGenreSearch) 入力パラメータ version:2009-03-26
| ID | 項目名 | パラメーター | 型(括弧内は最大バイト数) | 必須 | デフォルト | 備考 |
|---|---|---|---|---|---|---|
| 区分:共通パラメーター | ||||||
| 1 | デベロッパーID | developerId | String | - | デベロッパーID(こちらで確認できるアプリケーションIDのことです) | |
| 2 | アフィリエイトID | affiliateId | String | - | 指定無し | アフィリエイトID |
| 3 | 操作 | operation | String | - | 使用するAPIの操作名:BooksGenreSearch | |
| 4 | コールバック関数名 | callBack | String | - | 指定無し | JSONPとして出力する際のコールバック関数名 (UTF-8でURLエンコードした文字列) 英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
| 区分:サービス固有パラメーター | ||||||
| 1 | 楽天ブックスジャンルID | booksGenreId | String | - | ジャンルルートは、booksGenreId=000とする | |
| 2 | バージョン | version | String | - | 2009-03-26 | |
| 3 | ジャンルパス | genrePath | int(1) | - | 0 | 結果セットに祖先ジャンル(親ジャンルよりも上のジャンル)を含めるか否 か
0:含めない 1:含める |
出力パラメーター
楽天ブックスジャンル検索API(BooksGenreSearch) 出力パラメーター 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 | 親ジャンル | - | parent | 入力したジャンルIDの親ジャンル | |
| 2 | 楽天ブックスジャンルID | booksGenreId | ジャンルID | ||
| 3 | 楽天ブックスジャンル名 | booksGenreName | ジャンル名 | ||
| 4 | ジャンル階層 | genreLevel | ジャンル階層 ジャンルルートは000 |
||
| 5 | 自ジャンル | - | current | ユーザの入力したジャンルID | |
| 6 | 楽天ブックスジャンルID | booksGenreId | |||
| 7 | 楽天ブックスジャンル名 | booksGenreName | |||
| 8 | ジャンル階層 | genreLevel | |||
| 9 | 子ジャンル | - | child |
ユーザの入力したジャンルIDの子ジャンル 複数の子ジャンルがある場合は<child> ~ </child>が複数生成される 入力が「booksGenreId=000」の時はgenreLevel=1のジャンルが<child> ~ </child>に表示される |
|
| 10 | 楽天ブックスジャンルID | booksGenreId | |||
| 11 | 楽天ブックスジャンル名 | booksGenreName | |||
| 12 | ジャンル階層 | genreLevel | |||
エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 | 内容 |
|---|---|
| NotFound | 検索結果が存在しない。 |
| ServerError | 楽天ウェブサービス側のエラー。 |
| ClientError | デベロッパーの入力に起因するエラー。 |
| Maintenance | メンテナンス。 |