【楽天ウェブサービス】RAKUTEN WEBSERVICE

・	オンラインドキュメント
・	楽天ウェブサービス規約
・	FAQ
・	APIステータス
・	クレジット表示
・	ウェブサービスチームブログ
・	旧ブログ

・	楽天商品検索API
・	楽天ジャンル検索API
・	楽天商品コード検索API
・	楽天商品ランキングAPI
・	楽天プロダクト製品検索API
・	楽天プロダクト製品詳細API
・	楽天プロダクトジャンル情報API
・	楽天プロダクトメーカー情報API

・	楽天ブックス総合検索API
・	楽天ブックス書籍API
・	楽天ブックスCD検索API
・	楽天ブックスDVD/Blu-ray検索API
・	楽天ブックス洋書検索API
・	楽天ブックス雑誌検索API
・	楽天ブックスゲーム検索API
・	楽天ブックスソフトウェア検索API
・	楽天ブックスジャンル検索API

・	楽天オークション商品検索API
・	楽天オークション商品コード検索API
・	楽天オークションジャンル検索API

・	楽天トラベル施設検索API
・	楽天トラベル施設情報API
・	楽天トラベル空室検索API
・	楽天トラベル地区コードAPI
・	楽天トラベルキーワード検索API
・	楽天トラベルホテルチェーンAPI
・	楽天トラベルランキングAPI
	>> 楽天トラベル系APIサンプル集

・	楽天GORAゴルフ場検索API
・	楽天GORAゴルフ場詳細API
・	楽天GORAプラン検索API
・	楽天ダイナミックアドAPI
・	楽天ダイナミックアドAPI トラベル
・	楽天アフィリエイト高料率ショップAPI

楽天ブックスゲーム検索API (version:2011-12-01)

楽天ブックスゲーム検索APIとは

楽天ブックスゲーム検索APIは、楽天ブックスで販売されているゲームの情報を取得することが可能なAPIです。デベロッパーはゲームのタイトルや発売元などでの商品検索をはじめ、ジャンル別や在庫状態などでの絞り込み検索も可能となります。
（楽天ブックス総合検索APIよりも詳細な検索が可能となっています。）

アカウント情報
・	デベロッパーIDの確認
・	アフィリエイトIDの確認

・リクエストURL
・入力パラメーター
・出力パラメーター
・アフィリエイトに関して
・エラー
・過去のバージョン

■リクエストURL

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を指定することで出力されます。

フィールド名title, label, sortに対応する[value]はUTF-8でURLエンコードされている必要があります。（リクエストURL全体をエンコードするのではなく、[value]部分を個別にエンコードしてください。）
たとえば、「バイオハザード」というタイトルで検索し、対応機種を「Wii」で絞込み、結果を価格の安い順に並べたい（sort=+itemPrice）場合のリクエストURLは下記になります。（実際には改行せず1行につなげてリクエストしてください。）

http://api.rakuten.co.jp/rws/3.0/rest?
developerId=[YOUR_developerID]
&operation=BooksGameSearch
&version=2011-12-01
&title=%E3%83%90%E3%82%A4%E3%82%AA%E3%83%8F%E3%82%B6%E3%83%BC%E3%83%89
&hardware=Wii
&sort=%2BitemPrice

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

■入力パラメーター

楽天ブックスゲーム検索API（BooksGameSearch) 入力パラメーター version:2011-12-01
区分	ID	項目名	フィールド名	型 (括弧内は最大バイト数）	必須	デフォルト	備考
共通パラメ \| タ \|	1	デベロッパーID	developerId	String	○	---	デベロッパーID
	2	アフィリエイトID	affiliateId	String	-	指定無し	アフィリエイトID
	3	操作	operation	String	○	---	使用するAPIの操作名:BooksGameSearch
	4	コールバック関数名	callBack	String	-	---	JSONPとして出力する際のコールバック関数名（UTF-8でURLエンコードした文字列）英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上
サ \| ビス固有パラメ \| タ \|	1	ゲームタイトル	title	String	○ (*1)	---	ゲームのタイトルから検索 UTF-8でURLエンコードした文字列複数キーワードから検索したい場合は、半角スペースで区切って下さい (*1)タイトル、対応機種、メーカー品番、発売元名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です
	2	対応機種	hardware	String	○ (*1)	---	対応機種から検索 UTF-8でURLエンコードした文字列 (*1)タイトル、対応機種、メーカー品番、発売元名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です
	3	メーカー品番	makerCode	String	○ (*1)	---	メーカー品番から検索 UTF-8でURLエンコードした文字列 (*1)タイトル、対応機種、メーカー品番、発売元名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です
	4	発売元名	label	String	○ (*1)	---	発売元名から検索 UTF-8でURLエンコードした文字列複数キーワードから検索したい場合は、半角スペースで区切って下さい (*1)タイトル、対応機種、メーカー品番、発売元名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です
	5	ゲームのJANコード	jan	long	○ (*1)	---	ゲームに付与されているJANコードから検索 (*1)タイトル、対応機種、メーカー品番、発売元名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です
	6	楽天ブックスジャンルID	booksGenreId	String	○(*1)	006	楽天ブックスにおけるジャンルを特定するためのID （楽天市場のジャンルIDとは違うので注意してください） booksGenreId=006（ゲーム）に所属するジャンルのみが指定できます。ジャンルのIDやジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ブックスジャンル検索API(BooksGenreSearch)」をご利用ください。 (*1)タイトル、対応機種、メーカー品番、発売元名、JANコード、楽天ブックスジャンルIDのいずれかが指定されていることが必須です
	7	バージョン	version	String	○	---	2011-12-01
	8	1ページあたりの取得件数	hits	int	-	30	1から30までの整数
	9	取得ページ	page	int	-	1	1から100までの整数
	10	在庫状況	availability	int(1)	-	0	0：すべての商品 1：在庫あり 2：3～5日以内に発送予定 3：3～7日以内に発送予定 4：メーカー取り寄せ 5：予約受付中 6：メーカーに在庫確認
	11	品切れ等購入不可商品表示フラグ	outOfStockFlag	int(1)	-	0	0：品切れや販売終了など購入不可の商品は結果に表示させない 1：品切れや販売終了など購入不可の商品を結果に表示させる
	12	ソート	sort	String	-	standard	standard:標準 sales:売れている +releaseDate:発売日(古い) -releaseDate:発売日(新しい) +itemPrice:価格が安い -itemPrice:価格が高い reviewCount:レビューの件数が多い reviewAverage:レビューの評価(平均)が高い ※UTF-8でURLエンコードされている必要があります。
	13	限定フラグ	limitedFlag	int(1)	-	0	0:すべての商品 1:限定版商品のみ ※限定版商品には期間限定・数量限定・予約限定などの商品が含まれます。
	14	キャリア	carrier	int(1)	-	0	PC用の情報を返すのか、モバイル用の情報を返すのかを選択 PC: 0 mobile: 1
	15	ジャンルごとの商品数取得フラグ	genreInformationFlag	int(1)	-	0	0 :ジャンルごとの商品数の情報を取得しない 1 :ジャンルごとの商品数の情報を取得する

▲上へ

■出力パラメーター

楽天ブックスゲーム検索API（BooksGameSearch) 出力パラメーター version:2011-12-01
区分	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	商品情報（全体：<Items> ～ </Items> 、個別商品：<Item> ～ </Item>）	商品情報詳細	ゲームタイトル	title
	9			ゲームタイトルカナ	titleKana
	10			対応機種	hardware
	11			発売元名	label
	12			JANコード	jan
	13			メーカー品番	makerCode
	14			商品説明文	itemCaption
	15			発売日【NEW】	salesDate	表示例：「YYYY年」「YYYY年MM月」「YYYY年MM月DD日」 ※発売日が確定されていない商品については、「上旬/中旬/下旬」や「頃」「以降」などが付加
	16			税込み販売価格	itemPrice
	17			定価	listPrice	商品の元の値段
	18			割引率	discountRate	通常価格から何パーセント割引きされたか
	19			割引額	discountPrice	通常価格からいくら値引きされたか
	20			商品URL	itemUrl
	21			アフィリエイトURL	affiliateUrl	（入力パラメーターにアフィリエイトIDが含まれていた時のみ） ※carrierパラメーターの指定に関わらずPC/mobile両対応のURLを返却
	22			商品画像 64x64URL	smallImageUrl	(画像サイズ　64px*64px)
	23			商品画像 128x128URL	mediumImageUrl	(画像サイズ　128px*128px)
	24			商品画像 200x200URL	largeImageUrl	(画像サイズ　200px*200px)
	25			在庫状況	availability	1：在庫あり 2：3～5日以内に発送予定 3：3～7日以内に発送予定 4：メーカー取り寄せ 5：予約受付中 6：メーカーに在庫確認
	26			送料フラグ	postageFlag	0:送料別 1:宅配送料無料 2:送料無料(コンビニ送料含む) ※キャンペーンなどで実際の送料の扱いは、出力内容と異なることがあります
	27			限定フラグ	limitedFlag	0:通常商品 1:限定版商品 ※限定版商品には期間限定・数量限定・予約限定などの商品が含まれます。
	28			レビュー件数	reviewCount
	29			レビュー平均	reviewAverage
	30		ジャンル情報	楽天ブックスジャンルID	booksGenreId	所属する最下位のジャンルIDを表示該当商品が複数ジャンルに所属している場合は、「/」で区切ってそれぞれのジャンルIDを表示
	31	ジャンルごとの商品数（全体：<GenreInformation> ～ </GenreInformation> 、個別ジャンル：<parent> ～ </parent> もしくは<current> ～ </current> もしくは<child> ～ </child>）	親ジャンル	---	parent	入力したジャンルIDの親ジャンル
	32			楽天ブックスジャンルID	booksGenreId
	33			楽天ブックスジャンル名	booksGenreName
	34			ジャンル階層	genreLevel
	35		自ジャンル	---	current	ユーザの入力したジャンルID
	36			楽天ブックスジャンルID	booksGenreId
	37			楽天ブックスジャンル名	booksGenreName
	38			ジャンルに紐づく商品数	itemCount
	39			ジャンル階層	genreLevel
	40		子ジャンル	---	child	ユーザの入力したジャンルIDの子ジャンル複数の子ジャンルがある場合は<child> ～ </child>が複数生成される
	41			楽天ブックスジャンルID	booksGenreId
	42			楽天ブックスジャンル名	booksGenreName
	43			ジャンルに紐づく商品数	itemCount
	44			ジャンル階層	genreLevel

▲上へ

■アフィリエイトに関して

デベロッパーは、楽天ブックスゲーム検索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	メンテナンス。

▲上へ

■過去のバージョン

本APIの過去のバージョンは下記からご覧いただけます。

・楽天ブックスゲーム検索API（2009-03-26）

・楽天ブックスゲーム検索API（2009-04-15）

・楽天ブックスゲーム検索API（2010-03-18）

・楽天ブックスゲーム検索API（2011-07-07）

▲上へ