楽天GORAゴルフ場詳細APIは、ゴルフ場の詳細情報を取得することが可能なAPIです。
リクエストURL(REST/JSON形式の場合)
https://app.rakuten.co.jp/services/api/Gora/GoraGolfCourseDetail/20170623?format=xml&[parameter]=[value]… https://app.rakuten.co.jp/services/api/Gora/GoraGolfCourseDetail/20170623?format=json&[parameter]=[value]…
※JSONP形式は、JSON形式で入力パラメーターにcallbackを指定することで出力されます。
たとえば、ゴルフ場IDが「12345」のゴルフ場情報を取得したい場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)
ゴルフ場IDは、楽天GORAゴルフ場検索API(GoraGolfCourseSearch)の出力結果に含まれます。
https://app.rakuten.co.jp/services/api/Gora/GoraGolfCourseDetail/20170623?
format=xml
&applicationId=[Your applicationId]
&golfCourseId=12345
※短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。
入力パラメーター
楽天GORAゴルフ場詳細API(GoraGolfCourseDetail) 入力パラメーター version:2017-06-23
ID | 項目名 | パラメーター | 型(括弧内は最大バイト数) | 必須 | デフォルト | 備考 |
---|---|---|---|---|---|---|
区分:共通パラメーター | ||||||
1 | アプリID | applicationId | String | - | こちらで確認できます | |
2 | アフィリエイトID | affiliateId | String | - | 指定無し | こちらで確認できます |
3 | レスポンス形式 | format | String | - | json | json か xml を選択することができます。 json を選択した場合、 callback パラメーター指定により jsonp 形式にすることもできます。 |
4 | コールバック関数名 | callback | String | - | 指定無し | JSONPとして出力する際のコールバック関数名 (UTF-8でURLエンコードした文字列) 英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
5 | 出力パラメーター指定 | elements | String | - | ALL |
カンマ区切りで、必要な出力パラメータを指定した場合、 指定された出力パラメータのみを返却します。 (例)elements=reviewCount,reviewAverage |
6 | 出力フォーマットバージョン | formatVersion | int | - | 1 |
出力フォーマットのバージョン指定です。 2 を指定すると、JSONの出力方法が改善され以下のようになります。
{"items": [ {"item": { "itemName": "a", "itemPrice": 10 }}, {"item": { "itemName": "b", "itemPrice": 20 }} ]}
{"items": [ { "itemName": "a", "itemPrice": 10 }, { "itemName": "b", "itemPrice": 20 } ]} |
区分:サービス固有パラメーター | ||||||
1 | ゴルフ場ID | golfCourseId | long | - | 楽天GORAゴルフ場検索API(GoraGolfCourceSearch)の出力に含まれる | |
2 | キャリア | carrier | int(1) | - | 0 | PC用の情報を返すのか、モバイル用の情報を返すのかを選択 PC: 0 mobile: 1 |
出力パラメーター
楽天GORAゴルフ場詳細API(GoraGolfCourseDetail) 出力パラメーター version:2017-06-23
ID | 大分類 | 小分類 | 項目名 | パラメーター | 備考 |
---|---|---|---|---|---|
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 | 電話番号 | telephoneNo | |||
16 | FAX番号 | faxNo | |||
17 | 開場日 | openDay | |||
18 | 休場日 | closeDay | |||
19 | 使用可能クレジットカード | creditCard | |||
20 | シューズ指定 | shoes | |||
21 | 服装指定 | dressCode | |||
22 | 付帯施設(練習場) | practiceFacility | |||
23 | 付帯施設(宿泊施設) | lodgingFacility | |||
24 | 付帯施設(その他) | otherFacility | |||
25 | ゴルフ場画像URL1 | golfCourseImageUrl1 | httpsではじまるゴルフ場画像のURL1 | ||
26 | ゴルフ場画像URL2 | golfCourseImageUrl2 | httpsではじまるゴルフ場画像のURL2 | ||
27 | ゴルフ場画像URL3 | golfCourseImageUrl3 | httpsではじまるゴルフ場画像のURL3 | ||
28 | ゴルフ場画像URL4 | golfCourseImageUrl4 | httpsではじまるゴルフ場画像のURL4 | ||
29 | ゴルフ場画像URL5 | golfCourseImageUrl5 | httpsではじまるゴルフ場画像のURL5 | ||
30 | 価格情報 | 表示用平日プラン最安値(総額) | weekdayMinPrice | 平日プランの中で最も安価なプラン料金(総額) (例)5000 |
|
31 | 表示用平日プラン最安値(税抜き) | baseWeekdayMinPrice | 平日プランの中で最も安価なプラン料金(総額)から消費税、ゴルフ場利用税、その他を差し引いた金額 (例)3500 |
||
32 | 表示用休日プラン最安値(総額) | holidayMinPrice | 休日プランの中で最も安価なプラン料金(総額) (例)8000 |
||
33 | 表示用休日プラン安値(税抜き) | baseHolidayMinPrice | 休日プランの中で最も安価なプラン料金(総額)から消費税、ゴルフ場利用税、その他を差し引いた金額 (例)6500 |
||
34 | コース情報 | 設計者 | designer | ||
35 | コース種別 | courseType | |||
36 | コース高低差 | courseVerticalInterval | |||
37 | 面積 | dimension | |||
38 | グリーン | green | |||
39 | グリーン数 | greenCount | |||
40 | ホール数 | holeCount | |||
41 | パー数 | parCount | |||
42 | コース名 | courseName | |||
43 | 距離 | courseDistance | |||
44 | ドラコン推奨ホール | longDrivingContest | |||
45 | ニアピン推奨ホール | nearPin | |||
46 | クチコミ | クチコミ件数 | ratingNum | ||
47 | 総合評価 | evaluation | |||
48 | スタッフ接客 | staff | |||
49 | 設備が充実 | facility | |||
50 | 食事が美味しい | meal | |||
51 | コース/戦略性 | course | |||
52 | コストパフォーマンス | costperformance | |||
53 | 距離が長い | distance | |||
54 | フェアウェイが広い | fairway | |||
55 | URL | 予約カレンダーURL | reserveCalUrl | 入力パラメーターにアフィリエイトIDが含まれていた場合、アフィリエイトURLとなります。 httpsではじまる予約カレンダーのURL |
|
56 | クチコミURL | voiceUrl | httpsではじまるクチコミのURL | ||
57 | コースレイアウトURL | layoutUrl | httpsではじまるコースレイアウトのURL | ||
58 | 交通情報(地図)URL | routeMapUrl | httpsではじまる交通情報(地図)のURL | ||
59 | ゴルフ場最新プラン 全体:<newPlans>~<newPlans> 個別:<plan>~</plan> |
最新プラン対象月 | month | ||
60 | 最新プラン名 | planName | |||
61 | 最新プラン対象日 | planDate | |||
62 | 最新プラン付属サービス | service | |||
63 | プラン料金(総額) | price | 税抜金額、消費税額、ゴルフ場利用税、その他の合計 | ||
64 | プラン料金(税抜き) | basePrice | プレー料金などの課税対象金額 | ||
65 | プラン料金(消費税) | salesTax | 税抜金額に対する消費税額 | ||
66 | プラン料金(ゴルフ場利用税) | courseUseTax | ゴルフ場の所在する都道府県が課する税金(地方税) | ||
67 | プラン料金(その他の税) | otherTax | 入湯税、ゴルファー保険、ゴルフ振興基金などの非課税項目の合計 | ||
68 | ゴルファーからの評価 全体:<ratings>~<ratings> 個別:<rating>~</rating> |
タイトル | title | ||
69 | 評価者のニックネーム | nickName | |||
70 | 評価者の都道府県 | prefecture | |||
71 | 評価者の年齢 | age | |||
72 | 評価者の性別 | sex | |||
73 | 評価者のGORA利用回数 | times | |||
74 | 評価者の評価(総合) | evaluation | |||
75 | 評価者の評価(スタッフ接客) | staff | |||
76 | 評価者の評価(設備) | facility | |||
77 | 評価者の評価(食事) | meal | |||
78 | 評価者の評価(コース) | course | |||
79 | 評価者の評価(コストパフォーマンス) | costperformance | |||
80 | 評価者の評価(距離) | distance | |||
81 | 評価者の評価(フェアウェイの広さ) | fairway | |||
82 | 評価者のコメント | comment |
アフィリエイトに関して
デベロッパーは、楽天GORAゴルフ場詳細APIからアフィリエイトURLを取得することが可能です。リンク先にそのアフィリエイトURLを指定することで、楽天アフィリエイト経由の成果報酬を獲得することができます。
アフィリエイトURLを作るには、APIの入力パラメーターに「アフィリエイトID」を含めてリクエストしてください。
入力パラメーターcarrierでPCが指定された場合でもモバイルが指定された場合でも同様の方法でアフィリエイトURLを作成することができます。(2010年06月現在)
エラー
エラー内容はHTTPステータスコードとレスポンスボディから判断できます。
HTTPステータスコード | 意味 | レスポンスボディ例 (JSON) |
---|---|---|
400 | パラメーターエラー (必須パラメータ不足) |
applicationId を指定しなかった場合
keyword が正しい値でなかった時。(半角1文字のみ指定など)
|
404 | 対象のデータが存在しなかった場合 |
|
429 | リクエスト過多 (各ユーザ制限値超過) |
APIリクエスト数が上限に達した場合のエラーです。しばらく時間を空けてから、ご利用ください。
|
500 | 楽天ウェブサービス内のエラー | システムエラー。長時間続くようであれば、こちらよりごお問い合わせください。
|
503 | メンテナンス・リクエスト過多 (全ユーザ制限値超過) |
メンテナンス (XXX/XXX にはAPI名が入る)
|
レスポンスボディの形式は format に従います。
format | エラー出力例 |
---|---|
json |
|
xml |
|