|
楽天トラベルランキングAPIとは
楽天トラベルランキングAPIは、楽天トラベル内のコンテンツ「ホテル・旅館ランキング」の一部の情報を取得することが可能なAPIです。
デベロッパーは総合・温泉宿・高級ホテル/旅館という3つのジャンル別にお客様の評価の高いランキングを取得することができます。
>> サンプルコードはこちら（楽天トラベルへ） |
|
|
■リクエストURL（REST／JSON形式の場合）
http://api.rakuten.co.jp/rws/2.0/rest?[parameter]=[value]...
http://api.rakuten.co.jp/rws/2.0/json?[parameter]=[value]...
※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。
たとえば、以下の3つのような場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。）
(1)総合ランキングの情報を取得する場合
http://api.rakuten.co.jp/rws/2.0/rest?
developerId=[YOUR_developerID]
&operation=HotelRanking
&version=2009-06-25
&genre=all
(2)「温泉宿」のランキング情報を取得する場合
http://api.rakuten.co.jp/rws/2.0/rest?
developerId=[YOUR_developerID]
&operation=HotelRanking
&version=2009-06-25
&genre=onsen
(3)「総合」「温泉宿」のランキング情報を2種類同時に取得する場合
http://api.rakuten.co.jp/rws/2.0/rest?
developerId=[YOUR_developerID]
&operation=HotelRanking
&version=2009-06-25
&genre=all,onsen
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■利用上の注意
※ランキング順位と総数が「ホテル・旅館ランキング」と一部異なる場合があります。
■入力パラメーター
| 楽天トラベルランキングAPI（HotelRanking) 入力パラメーター version:2009-06-25 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数） |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパーID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名：
HotelRanking |
| 4 |
コールバック関数名 |
callBack |
String |
- |
指定無し |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
バージョン |
version |
String |
○ |
--- |
2009-06-25 |
| 2 |
ジャンル |
genre |
String |
○ |
all |
all : 総合ランキング
onsen : 温泉宿ランキング
premium : 高級ホテル/旅館ランキング
このフィールドはCSV形式で複数指定することができます。
例） &genre=all,onsen
上記を指定した場合、
総合ランキングと温泉宿ランキングの2種類のランキングを返却します。 |
| 3 |
キャリア |
carrier | int(1) |
- |
0 |
PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC:0
mobile:1 |
|
■出力パラメーター
| 楽天トラベルランキングAPI（HotelRanking) 出力パラメーター version:2009-06-25 |
| 区分 |
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 |
ランキング |
--- |
ranking |
genre属性を持ちます |
| 2 |
タイトル |
title |
|
| 3 |
最終更新時間 |
lastBuildDate |
|
| 4 |
施設ランク情報(*1) |
--- |
hotelRankInfo |
(*1)ランキングの子になり、ランク数分存在します。 |
| 5 |
順位 |
rank |
1〜10 |
| 6 |
施設番号 |
hotelNo |
|
| 7 |
施設名 |
hotelName |
|
| 8 |
地区中区分名称 |
middleClassName |
施設の所在都道府県 |
| 9 |
お客さまの声 |
userReview |
集計時点での最新のお客さまの声情報となります。 |
| 10 |
お客さまの声件数 |
reviewCount |
集計時点での最新のお客さまの声件数となります。 |
| 11 |
施設情報ページURL |
hotelInformationUrl |
アフィリエイトIDが設定されている場合、アフィリエイトURLとなります。 |
| 12 |
宿泊プラン一覧URLページURL |
planListUrl |
アフィリエイトIDが設定されている場合、アフィリエイトURLとなります。 |
| 13 |
空室検索URL |
checkAvailableUrl |
アフィリエイトIDが設定されている場合、アフィリエイトURLとなります。 |
| 14 |
お客様の声ページURL |
reviewUrl |
アフィリエイトIDが設定されている場合、アフィリエイトURLとなります。 |
| 15 |
施設画像URL |
hotelImageUrl |
|
| 16 |
施設画像サムネイルURL |
hotelThumbnailUrl |
|
| 17 |
星の数 |
reviewAverage |
|
| 18 |
キャリア |
carrier |
0:PC
1:モバイル |
|
■アフィリエイトに関して
デベロッパーは、楽天トラベルランキングAPIからアフィリエイトURLを取得することが可能です。リンク先にそのアフィリエイトURLを指定することで、楽天アフィリエイト経由の成果報酬を獲得することができます。
アフィリエイトURLを作るには、APIの入力パラメーターに「アフィリエイトID」を含めてリクエストしてください。APIの出力に「アフィリエイトURL」が含まれます。
入力パラメーターcarrierでPCが指定された場合でもモバイルが指定された場合でも同様の方法でアフィリエイトURLを作成することができます。（2008年11月現在）
|
