Home     API一覧     楽天プロダクトジャンル情報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]部分を個別にエンコードしてください。)
たとえば、「123456」というジャンルIDから検索し、メーカー情報を10件取得し、満足度ランキングの情報を1ページ5件ずつ取得し、かつ、その3ページ目の情報を取得したい場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)

http://api.rakuten.co.jp/rws/3.0/rest?
developerId=[YOUR_developerID]
&operation=ProductGenreInfo
&version=2010-11-18
&genreId=123456
&makerHits=10
&satisfiedHits=5
&satisfiedPage=3

※短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。

入力パラメーター


楽天プロダクトジャンル情報API(ProductGenreInfo) 入力パラメーター version:2010-11-18

ID 項目名 パラメーター 型(括弧内は最大バイト数) 必須 デフォルト 備考
区分:共通パラメーター
1 デベロッパーID developerId String Affiliate対応あり - デベロッパーID(こちらで確認できるアプリケーションIDのことです)
2 アフィリエイトID affiliateId String - 指定無し アフィリエイトID
3 操作 operation String Affiliate対応あり - 使用するAPIの操作名:ProductGenreInfo
4 コールバック関数名 callBack String - 指定無し JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上
区分:サービス固有パラメーター
1 ジャンルID genreId long Affiliate対応あり - 楽天市場におけるジャンルを特定するためのID
ジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ジャンル検索API(GenreSearch)」をご利用ください
2 バージョン version String Affiliate対応あり - 2010-11-18
3 1ページあたりのメーカー情報取得件数 makerHits int - 0 0から30までの整数
※0の場合はメーカー情報を取得しない
4 メーカー情報取得ページ makerPage int - 1 1から30までの整数
5 1ページあたりの売れ筋ランキング取得件数 sellerHits int - 0 0以上の整数
PC:0
mobile:1
6 売れ筋ランキング取得ページ sellerPage int - 1 1から30までの整数
7 1ページあたりの満足度ランキング取得件数 satisfiedHits int - 0 0から30までの整数
※0の場合は満足度ランキングを取得しない
8 満足度ランキング取得ページ satisfiedPage int - 1 1から30までの整数
9 1ページあたりの新製品取得件数 newProductHits int - 0 0から30までの整数
※0の場合は新製品を取得しない
10 新製品取得ページ newProductPage int - 1 1から30までの整数

出力パラメーター


楽天プロダクトジャンル情報API(ProductGenreInfo) 出力パラメーター version:2010-11-18

ID 大分類 分類 項目名 パラメーター 備考
区分:共通パラメーター
1 ARG ユーザーエージェント User-Agent Valueにはユーザのユーザエージェントが表示される
2 デベロッパーID developerId ValueにはデベロッパーIDが表示される
3 アフィリエイトID affiliateId ValueにはアフィリエイトIDが表示される
4 操作名 operation Valueにはユーザの指定した操作名が表示される
5 バージョン version Valueにはユーザの指定したバージョンが表示される
6 Status ステータス Status Success / NotFound / ServerError / ClientError / Maintenance のいずれか
7 StatusMsg ステータスメッセージ StatusMsg Statusに特化したメッセージを出力
区分:サービス固有パラメーター
1 ジャンル毎の製品数(全体:<GenreInformation> ~ </GenreInformation> 、個別ジャンル:<parent> ~ </parent>もしくは<current> ~ </current>もしくは<child> ~ </child>) 親ジaャンル 親ジャンル parent 入力したジャンルIDの親ジャンル
2 ジャンルID genreId  
3 ジャンル名 genreName  
4 ジャンル階層 genreLevel  
5 ジャンルページURL(PC) genrePageUrlPC  
6 ジャンルページURL(モバイル) genrePageUrlMobile  
7 自ジャンル 自ジャンル current ユーザの入力したジャンルID
8 ジャンルID genreId  
9 ジャンル名 genreName  
10 ジャンルに紐づく製品数 productCount  
11 ジャンルに紐づく商品数 itemCount  
12 メーカー登録数 makerCount  
13 ジャンル階層 genreLevel  
14 ジャンルページURL(PC) genrePageUrlPC  
15 ジャンルページURL(モバイル) genrePageUrlMobile  
16 子ジャンル 子ジャンル child ユーザの入力したジャンルIDの子ジャンル
複数の子ジャンルがある場合は<child>~</child>が複数生成される
入力が「genreId=0」の時はgenreLevel=1のジャンルが<child>~</child>に表示される
17 ジャンルID genreId  
18 ジャンル名 genreName  
19 ジャンルに紐づく製品数 productCount  
20 ジャンルに紐づく商品数 itemCount  
21 メーカー登録数 makerCount  
22 ジャンル階層 genreLevel  
23 ジャンルページURL(PC) genrePageUrlPC  
24 ジャンルページURL(モバイル) genrePageUrlMobile  
25 関連メーカー情報(全体:<MakerInformation> ~ </MakerInformation> 、個別項目:<maker> ~ </maker>) - maker 関連メーカー情報が複数ある場合は<maker> ~ </maker>が複数生成される
26 表示番号 dispNo  
27 楽天プロダクトメーカーコード makerCode  
28 会社名 makerName  
29 メーカーページURL(PC) makerPageUrlPC ※ジャンルが指定された場合は、入力ジャンルのメーカーページのURLを返す
30 メーカーページURL(モバイル) makerPageUrlMobile ※ジャンルが指定された場合は、入力ジャンルのメーカーページのURLを返す
31 売れ筋ランキング情報(全体:<SellerInformation> ~ </SellerInformation> 、個別項目:<seller> ~ </seller>) - seller 売れ筋ランキング情報が複数ある場合はが複数生成される
32 順位 rank  
33 楽天プロダクト製品ID productId  
34 製品名 productName  
35 製品説明文 productCaption  
36 製品ページURL(PC) productUrlPC  
37 製品ページURL(モバイル) productUrlMobile  
38 アフィリエイトURL affiliateUrl PC/モバイル両対応のURLを返却
39 製品画像64x64URL smallImageUrl (画像サイズ64px*64px)
40 製品画像128x128URL mediumImageUrl (画像サイズ128px*128px)
41 楽天プロダクトメーカーコード makerCode  
42 会社名 makerName  
43 レビュー数 reviewCount  
44 レビュー平均 reviewAverage  
45 レビューページURL(PC) reviewUrlPC  
46 レビューページURL(モバイル) reviewUrlMobile  
47 最低価格 minPrice  
48 発売年月日 releaseDate  
49 満足度ランキング情報(全体:<SatisfiedInformation> ~ </SatisfiedInformation> 、個別項目:<satisfier> ~ </satisfier>) - satisfier 売れ筋ランキング情報が複数ある場合はが複数生成される
50 順位 rank  
51 楽天プロダクト製品ID productId  
52 製品名 productName  
53 製品説明文 productCaption  
54 製品ページURL(PC) productUrlPC  
55 製品ページURL(モバイル) productUrlMobile  
56 アフィリエイトURL affiliateUrl PC/モバイル両対応のURLを返却
57 製品画像64x64URL smallImageUrl (画像サイズ64px*64px)
58 製品画像128x128URL mediumImageUrl (画像サイズ128px*128px)
59 楽天プロダクトメーカーコード makerCode  
60 会社名 makerName  
61 レビュー数 reviewCount  
62 レビュー平均 reviewAverage  
63 レビューページURL(PC) reviewUrlPC  
64 レビューページURL(モバイル) reviewUrlMobile  
65 最低価格 minPrice  
66 発売年月日 releaseDate  
67 新製品情報(全体:<NewProductInformation> ~ </NewProductInformation> 、個別項目:<newProduct> ~ </newProduct>) - newProduct 売れ筋ランキング情報が複数ある場合は<newProduct> ~ </newProduct>が複数生成される
68 順位 rank  
69 楽天プロダクト製品ID productId  
70 製品名 productName  
71 製品説明文 productCaption  
72 製品ページURL(PC) productUrlPC  
73 製品ページURL(モバイル) productUrlMobile  
74 アフィリエイトURL affiliateUrl PC/モバイル両対応のURLを返却
75 製品画像64x64URL smallImageUrl (画像サイズ64px*64px)
76 製品画像128x128URL mediumImageUrl (画像サイズ128px*128px)
77 楽天プロダクトメーカーコード makerCode  
78 会社名 makerName  
79 レビュー数 reviewCount  
80 レビュー平均 reviewAverage  
81 レビューページURL(PC) reviewUrlPC  
82 レビューページURL(モバイル) reviewUrlMobile  
83 最低価格 minPrice  
84 発売年月日 releaseDate  

アフィリエイトに関して


デベロッパーは、楽天プロダクトジャンル情報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 リクエスト回数制限オーバー。
※しばらく時間を空けて、再度ご利用ください