|
楽天GORAゴルフ場詳細APIとは
| 楽天GORAゴルフ場詳細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を指定することで出力されます。
たとえば、ゴルフ場IDが「12345」のゴルフ場情報を取得したい場合のリクエストURLは下記になります。（実際には改行せずに1行につなげてリクエストしてください。）
ゴルフ場IDは、楽天GORAゴルフ場検索API（GoraGolfCourseSearch）の出力結果に含まれます。
http://api.rakuten.co.jp/rws/3.0/rest?
developerId=[YOUR_developerID]
&operation=GoraGolfCourseDetail
&version=2010-06-30
&golfCourseId=12345
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■入力パラメーター
| 楽天GORAゴルフ場詳細API（GoraGolfCourseDetail) 入力パラメーター version:2010-06-30 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数） |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名：
GoraGolfCourseDetail |
| 4 |
コールバック関数名 |
callBack |
String |
- |
指定無し |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
ゴルフ場ID |
golfCourseId |
long |
○ |
--- |
楽天GORAゴルフ場検索API（GoraGolfCourceSearch）の出力に含まれる |
| 2 |
バージョン |
version |
String |
○ |
--- |
2010-06-30 |
| 3 |
キャリア |
carrier |
int(1) |
- |
0 |
PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC: 0
mobile: 1 |
|
■出力パラメーター
| 楽天GORAゴルフ場詳細API（GoraGolfCourseDetail) 出力パラメーター version:2010-06-30 |
| 区分 |
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 |
全体情報 |
キャリア情報 |
carrier |
PC=0 or mobile=1 |
| 2 |
ゴルフ場情報 |
ゴルフ場名/ID |
ゴルフ場ID |
golfCourseId |
|
| 3 |
ゴルフ場名 |
golfCourseName |
|
| 4 |
ゴルフ場名(略称) |
golfCourseAbbr |
|
| 5 |
ゴルフ場名(カナ) |
golfCourseNameKana |
|
| 6 |
ゴルフ場説明文 |
golfCourseCaption |
|
| 7 |
お知らせ |
ゴルフ場からのお知らせ |
information |
|
| 8 |
ゴルフ場基本情報 |
最寄高速道路 |
highway |
|
| 9 |
最寄IC |
ic |
|
| 10 |
ICからの距離 |
icDistance |
|
| 11 |
緯度 |
latitude |
世界測地系 |
| 12 |
経度 |
longitude |
世界測地系 |
| 13 |
郵便番号 |
postalCode |
|
| 14 |
所在地 |
address |
|
| 15 |
電話番号 |
telNo |
|
| 16 |
FAX番号 |
faxNo |
|
| 17 |
開場日 |
openDay |
|
| 18 |
休場日 |
closeDay |
|
| 19 |
使用可能クレジットカード |
creditCard |
|
| 20 |
シューズ指定 |
shoes |
|
| 21 |
服装指定 |
dressCode |
|
| 22 |
付帯施設(練習場) |
practiceFacility |
|
| 23 |
付帯施設(宿泊施設) |
lodgingFacility |
|
| 24 |
付帯施設(その他) |
otherFacility |
|
| 25 |
ゴルフ場画像URL1 |
golfCourseImageUrl1 |
|
| 26 |
ゴルフ場画像URL2 |
golfCourseImageUrl2 |
|
| 27 |
ゴルフ場画像URL3 |
golfCourseImageUrl3 |
|
| 28 |
ゴルフ場画像URL4 |
golfCourseImageUrl4 |
|
| 29 |
ゴルフ場画像URL5 |
golfCourseImageUrl5 |
|
| 30 |
コース情報 |
設計者 |
designer |
|
| 31 |
コース種別 |
courseType |
|
| 32 |
コース高低差 |
courseVerticalInterval |
|
| 33 |
面積 |
dimension |
|
| 34 |
グリーン |
green |
|
| 35 |
グリーン数 |
greenCount |
|
| 36 |
ホール数 |
holeCount |
|
| 37 |
パー数 |
parCount |
|
| 38 |
コース名 |
courseName |
|
| 39 |
距離 |
courseDistance |
|
| 40 |
ドラコン推奨ホール |
longDrivingContest |
|
| 41 |
ニアピン推奨ホール |
nearPin |
|
| 42 |
クチコミ |
クチコミ件数 |
ratingNum |
|
| 43 |
総合評価 |
evaluation |
|
| 44 |
スタッフ接客 |
staff |
|
| 45 |
設備が充実 |
facility |
|
| 46 |
食事が美味しい |
meal |
|
| 47 |
コース/戦略性 |
course |
|
| 48 |
コストパフォーマンス |
costperformance |
|
| 49 |
距離が長い |
distance |
|
| 50 |
フェアウェイが広い |
fairway |
|
| 51 |
URL |
予約カレンダーURL |
reserveCalUrl |
入力パラメーターにアフィリエイトIDが含まれていた場合、アフィリエイトURLとなります。 |
| 52 |
クチコミURL |
voiceUrl |
|
| 53 |
コースレイアウトURL |
layoutUrl |
|
| 54 |
交通情報(地図)URL |
routeMapUrl |
|
| 55 |
ゴルフ場最新プラン
全体：<newPlans>〜<newPlans>
個別：<plan>〜</plan> |
最新プラン対象月 |
month |
|
| 56 |
最新プラン名 |
planName |
|
| 57 |
最新プラン対象日 |
planDate |
|
| 58 |
最新プラン付属サービス |
service |
|
| 59 |
最新プラン料金 |
price |
|
| 60 |
ゴルファーからの評価
全体：<ratings>〜<ratings>
個別：<rating>〜</rating>
|
タイトル |
title |
|
| 61 |
評価者のニックネーム |
nickName |
|
| 62 |
評価者の都道府県 |
prefecture |
|
| 63 |
評価者の年齢 |
age |
|
| 64 |
評価者の性別 |
sex |
|
| 65 |
評価者のGORA利用回数 |
times |
|
| 66 |
評価者の評価(総合) |
evaluation |
|
| 67 |
評価者の評価(スタッフ接客) |
staff |
|
| 68 |
評価者の評価(設備) |
facility |
|
| 69 |
評価者の評価(食事) |
meal |
|
| 70 |
評価者の評価(コース) |
course |
|
| 71 |
評価者の評価(コストパフォーマンス) |
costperformance |
|
| 72 |
評価者の評価(距離) |
distance |
|
| 73 |
評価者の評価(フェアウェイの広さ) |
fairway |
|
| 74 |
評価者のコメント |
comment |
|
|
■アフィリエイトに関して
デベロッパーは、楽天GORAゴルフ場詳細APIからアフィリエイトURLを取得することが可能です。リンク先にそのアフィリエイトURLを指定することで、楽天アフィリエイト経由の成果報酬を獲得することができます。
アフィリエイトURLを作るには、APIの入力パラメーターに「アフィリエイトID」を含めてリクエストしてください。
入力パラメーターcarrierでPCが指定された場合でもモバイルが指定された場合でも同様の方法でアフィリエイトURLを作成することができます。（2010年06月現在）
■エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 |
内容 |
| NotFound |
検索結果が存在しない。 |
| ServerError |
楽天ウェブサービス側のエラー。 |
| ClientError |
デベロッパーの入力に起因するエラー。 |
| Maintenance |
メンテナンス。 |
| AccessForbidden |
リクエスト回数制限オーバー。
※しばらく時間を空けて、再度ご利用ください |
|
|
