楽天プロダクトメーカー情報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]部分を個別にエンコードしてください。）
たとえば、「123456789」という楽天プロダクトメーカーコードから検索し、売れ筋ランキングの情報を1ページ3件ずつ取得し、かつ、その2ページ目の情報を取得、またジャンルごとの製品数の情報を取得したい場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。）
http://api.rakuten.co.jp/rws/3.0/rest?
developerId=[YOUR_developerID]
&operation=ProductMakerInfo
&version=2010-11-18
&makerCode=123456789
&sellerHits=3
&sellerPage=2
&genreInformationFlag=1
※短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。
入力パラメーター
楽天プロダクトメーカー情報API（ProductMakerInfo) 入力パラメーター version:2010-11-18
| ID | 項目名 | パラメーター | 型(括弧内は最大バイト数) | 必須 | デフォルト | 備考 |
|---|---|---|---|---|---|---|
| 区分:共通パラメーター | ||||||
| 1 | デベロッパーID | developerId | String |  |
- | デベロッパーID（こちらで確認できるアプリケーションIDのことです） |
| 2 | アフィリエイトID | affiliateId | String | - | 指定無し | アフィリエイトID |
| 3 | 操作 | operation | String | |
- | 使用するAPIの操作名：ProductMakerInfo |
| 4 | コールバック関数名 | callBack | String | - | 指定無し | JSONPとして出力する際のコールバック関数名 （UTF-8でURLエンコードした文字列） 英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
| 区分:サービス固有パラメーター | ||||||
| 1 | 楽天プロダクトメーカーコード | makerCode | int | |
- | 楽天プロダクト用のメーカーコード 楽天プロダクト製品検索API(ProductSearch)や楽天プロダクト製品詳細API(ProductDetail)、楽天プロダクトジャンル情報API(ProductGenreInfo)の出力に含まれる。 |
| 2 | バージョン | version | String | |
- | 2010-11-18 |
| 3 | ジャンルID | genreId | long | - | 0 | 楽天市場におけるジャンルを特定するためのID ジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ジャンル検索API(GenreSearch)」をご利用ください |
| 4 | 1ページあたりの売れ筋ランキング取得件数 | sellerHits | int | - | 0 | 0以上の整数 PC:0 mobile:1 |
| 5 | 売れ筋ランキング取得ページ | sellerPage | int | - | 1 | 1から30までの整数 |
| 6 | 1ページあたりの満足度ランキング取得件数 | satisfiedHits | int | - | 0 | 0から30までの整数 ※0の場合は満足度ランキングを取得しない |
| 7 | 満足度ランキング取得ページ | satisfiedPage | int | - | 1 | 1から30までの整数 |
| 8 | 1ページあたりの新製品取得件数 | newProductHits | int | - | 0 | 0から30までの整数 ※0の場合は新製品を取得しない |
| 9 | 新製品取得ページ | newProductPage | int | - | 1 | 1から30までの整数 |
| 10 | ジャンル毎の製品数取得フラグ | genreInformationFlag | int(1) | - | 1 | 0 :ジャンルごとの製品数の情報を取得しない 1 :ジャンルごとの製品数の情報を取得する |
出力パラメーター
楽天プロダクトメーカー情報API（ProductMakerInfo) 出力パラメーター 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に特化したメッセージを出力 | |
| 区分:サービス固有パラメーター | |||||
| 13 | ジャンル毎の製品数（全体：<GenreInformation> ～ </GenreInformation> 、個別ジャンル：<parent> ～ </parent>もしくは<current> ～ </current>もしくは<child> ～ </child>） | 親ジャンル | 親ジャンル | parent | 入力したジャンルIDの親ジャンル |
| 14 | ジャンルID | genreId | |||
| 15 | ジャンル名 | genreName | |||
| 16 | ジャンル階層 | genreLevel | |||
| 17 | ジャンルページURL(PC) | genrePageUrlPC | |||
| 18 | ジャンルページURL(モバイル) | genrePageUrlMobile | |||
| 19 | 自ジャンル | 自ジャンル | current | ユーザの入力したジャンルID | |
| 20 | ジャンルID | genreId | |||
| 21 | ジャンル名 | genreName | |||
| 22 | ジャンルに紐づく製品数 | productCount | |||
| 23 | ジャンルに紐づく商品数 | itemCount | |||
| 24 | ジャンル階層 | genreLevel | |||
| 25 | ジャンルページURL(PC) | genrePageUrlPC | |||
| 26 | ジャンルページURL(モバイル) | genrePageUrlMobile | |||
| 27 | 子ジャンル | 子ジャンル | child | ユーザの入力したジャンルIDの子ジャンル 複数の子ジャンルがある場合は<child>～</child>が複数生成される 入力が「genreId=0」の時はgenreLevel=1のジャンルが<child>～</child>に表示される |
|
| 28 | ジャンルID | genreId | |||
| 29 | ジャンル名 | genreName | |||
| 30 | ジャンルに紐づく製品数 | productCount | |||
| 31 | ジャンルに紐づく商品数 | itemCount | |||
| 32 | ジャンル階層 | genreLevel | |||
| 33 | ジャンルページURL(PC) | genrePageUrlPC | |||
| 34 | ジャンルページURL(モバイル) | genrePageUrlMobile | |||
| 35 | 売れ筋ランキング情報（全体：<SellerInformation> ～ </SellerInformation> 、個別項目：<seller> ～ </seller>） | - | seller | 売れ筋ランキング情報が複数ある場合は<seller> ～ </seller>が複数生成される | |
| 36 | 順位 | rank | |||
| 37 | 楽天プロダクト製品ID | productId | |||
| 38 | 製品名 | productName | |||
| 39 | 製品説明文 | productCaption | |||
| 40 | 製品ページURL(PC) | productUrlPC | |||
| 41 | 製品ページURL(モバイル) | productUrlMobile | |||
| 42 | アフィリエイトURL | affiliateUrl | PC/モバイル両対応のURLを返却 | ||
| 43 | 製品画像64x64URL | smallImageUrl | （画像サイズ64px*64px） | ||
| 44 | 製品画像128x128URL | mediumImageUrl | （画像サイズ128px*128px） | ||
| 45 | 楽天プロダクトメーカーコード | makerCode | |||
| 46 | 会社名 | makerName | |||
| 47 | レビュー数 | reviewCount | |||
| 48 | レビュー平均 | reviewAverage | |||
| 49 | レビューページURL(PC) | reviewUrlPC | |||
| 50 | レビューページURL(モバイル) | reviewUrlMobile | |||
| 51 | 最低価格 | minPrice | ※中古品、売り切れ商品も含む | ||
| 52 | 発売年月日 | releaseDate | |||
| 53 | 満足度ランキング情報（全体：<SatisfiedInformation> ～ </SatisfiedInformation> 、個別項目：<satisfier> ～ </satisfier>） | - | satisfier | 売れ筋ランキング情報が複数ある場合は<satisfier> ～ </satisfier>が複数生成される | |
| 54 | 順位 | rank | |||
| 55 | 楽天プロダクト製品ID | productId | |||
| 56 | 製品名 | productName | |||
| 57 | 製品説明文 | productCaption | |||
| 58 | 製品ページURL(PC) | productUrlPC | |||
| 59 | 製品ページURL(モバイル) | productUrlMobile | |||
| 60 | アフィリエイトURL | affiliateUrl | PC/モバイル両対応のURLを返却 | ||
| 61 | 製品画像64x64URL | smallImageUrl | （画像サイズ64px*64px） | ||
| 62 | 製品画像128x128URL | mediumImageUrl | （画像サイズ128px*128px） | ||
| 63 | 楽天プロダクトメーカーコード | makerCode | |||
| 64 | 会社名 | makerName | |||
| 65 | レビュー数 | reviewCount | |||
| 66 | レビュー平均 | reviewAverage | |||
| 67 | レビューページURL(PC) | reviewUrlPC | |||
| 68 | レビューページURL(モバイル) | reviewUrlMobile | |||
| 69 | 最低価格 | minPrice | ※中古品、売り切れ商品も含む | ||
| 70 | 発売年月日 | releaseDate | |||
| 71 | 新製品情報（全体：<NewProductInformation> ～ </NewProductInformation> 、個別項目：<newProduct> ～ </newProduct>） | - | newProduct | 売れ筋ランキング情報が複数ある場合は<newProduct> ～ </newProduct>が複数生成される | |
| 72 | 順位 | rank | |||
| 73 | 楽天プロダクト製品ID | productId | |||
| 74 | 製品名 | productName | |||
| 75 | 製品説明文 | productCaption | |||
| 76 | 製品ページURL(PC) | productUrlPC | |||
| 77 | 製品ページURL(モバイル) | productUrlMobile | |||
| 78 | アフィリエイトURL | affiliateUrl | PC/モバイル両対応のURLを返却 | ||
| 79 | 製品画像64x64URL | smallImageUrl | （画像サイズ64px*64px） | ||
| 80 | 製品画像128x128URL | mediumImageUrl | （画像サイズ128px*128px） | ||
| 81 | 楽天プロダクトメーカーコード | makerCode | |||
| 82 | 会社名 | makerName | |||
| 83 | レビュー数 | reviewCount | |||
| 84 | レビュー平均 | reviewAverage | |||
| 85 | レビューページURL(PC) | reviewUrlPC | |||
| 86 | レビューページURL(モバイル) | reviewUrlMobile | |||
| 87 | 最低価格 | minPrice | |||
| 88 | 発売年月日 | 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 | リクエスト回数制限オーバー。 ※しばらく時間を空けて、再度ご利用ください |