|
楽天オークションジャンル検索APIとは
| 楽天オークションジャンル検索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/3.0/rest?
developerId=[YOUR_developerID]
&operation=AuctionGenreSearch
&version=2010-09-15
&auctionGenreId=000
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■入力パラメーター
| 楽天オークションジャンル検索API（AuctionGenreSearch) 入力パラメータ version:2010-09-15 |
| 区分 |
ID |
項目名 |
フィールド名 |
型 |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパーID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名：AuctionGenreSearch |
| 4 |
コールバック関数名 |
callBack |
String |
- |
指定無し |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
楽天オークションジャンルID |
auctionGenreId |
String |
○ |
--- |
ジャンルルートは、auctionGenreId=0とする |
| 2 |
バージョン |
version |
String |
○ |
--- |
2010-09-15 |
| 3 |
ジャンルパス |
genrePath |
int(1) |
- |
0 |
結果セットに祖先ジャンル（親ジャンルよりも上のジャンル）を含めるか否 か
0：含めない
1：含める |
|
■出力パラメーター
| 楽天オークションジャンル検索API（AuctionGenreSearch) 出力パラメーター version:2010-09-15 |
| 区分 |
ID |
分類 |
項目名 |
フィールド名 |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
Arg |
--- |
User-Agent |
Valueにはユーザのユーザエージェントが表示される |
| 2 |
--- |
developerId |
ValueにはデベロッパーIDが表示される |
| 3 |
--- |
operation |
Valueにはユーザの指定した操作名が表示される |
| 4 |
--- |
version |
Valueにはユーザの指定した操作のバージョンが表示される |
| 5 |
Status |
--- |
Status |
Success/NotFound/ServerError/ClientError/Maintenance のいづれか |
| 6 |
StatusMsg |
--- |
StatusMsg |
Statusに特化したメッセージを出力 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
|
|
1 |
親ジャンル |
|
parent |
入力したジャンルIDの親ジャンル
「genrePath=1」の時、更に上位階層があれば、表示する |
| 2 |
楽天オークションジャンルID |
auctionGenreId |
ジャンルID |
| 3 |
楽天オークションジャンル名 |
auctionGenreName |
ジャンル名 |
| 4 |
ジャンル階層 |
genreLevel |
ジャンル階層
ジャンルルートは0 |
| 5 |
自ジャンル |
|
current |
ユーザの入力したジャンルID |
| 6 |
楽天オークションジャンルID |
auctionGenreId |
|
| 7 |
楽天オークションジャンル名 |
auctionGenreName |
|
| 8 |
ジャンル階層 |
genreLevel |
|
| 9 |
子ジャンル |
|
child |
ユーザの入力したジャンルIDの子ジャンル
複数の子ジャンルがある場合は<child>〜 </child>が複数生成される
入力が「auctionGenreId=0」の時はgenreLevel=1のジャンルが<child>〜</child>に表示される |
| 10 |
楽天オークションジャンルID |
auctionGenreId |
|
| 11 |
楽天オークションジャンル名 |
auctionGenreName |
|
| 12 |
ジャンル階層 |
genreLevel |
|
|
■エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 |
内容 |
| NotFound |
検索結果が存在しない。 |
| ServerError |
楽天ウェブサービス側のエラー。 |
| ClientError |
デベロッパーの入力に起因するエラー。 |
| Maintenance |
メンテナンス。 |
|
|
