API名称 レストラン検索API 20151130仕様追加 URL http://api.gnavi.co

API名称
URL
レストラン検索API
http://api.gnavi.co.jp/RestSearchAPI/20150630/
20151130仕様追加
リクエストパラメータ
パラメータ名
型
説明
備考
string
string
アクセスキー
店舗ID
ぐるなびより提供されたアクセスキー
「,」区切りで店舗IDを複数検索可能(10個まで)
format
string
レスポンス形式
callback
name
string
string
コールバック関数
店舗名
xmlまたはjson(callback関数指定時にJSONP形式で出力)
formatが「json」の場合のみ
店名を指定※UTF-8エンコード必須
name_kana
tel
address
area
pref
areacode_l
arecode_m
areacode_s
category_l
category_s
string
string
string
string
string
string
string
string
string
string
店舗名読み
電話番号
住所
エリアコード
都道府県コード
エリアLコード
エリアMコード
エリアSコード
大業態コード
小業態コード
カタカナで指定
UTF-8でURLエンコードすること
ハイフン必須
(都道府県+市町村+番地)の文字列をUTF-8でURLエンコードすること
コードはエリアマスタ取得APIより取得
コードは都道府県マスタ取得APIより取得
コードはエリアLマスタ取得APIより取得
コードはエリアMマスタ取得APIより取得
コードはエリアSマスタ取得APIより取得
コードは大業態マスタ取得APIより取得
コードは小業態マスタ取得APIより取得
input_coordinates_mode
integer
入力測地系タイプ
入力する緯度/経度の測地系のタイプを指定
1:日本測地系、 2:世界測地系
(デフォルト:日本測地系)
coordinates_mode
integer
測地系タイプ
latitude
number
緯度
keyid
id
必須
○
レスポンスに含まれる緯度/経度の測地系を指定
1:日本測地系、2:世界測地系(デフォルト:日本測地系)
分秒十進式
input_coordinates_mode(入力測地系タイプ)の選択したタイプの値で指定
分秒十進式
input_coordinates_mode(入力測地系タイプ)の選択したタイプの値で指定
longitude
number
経度
緯度/経度からの検索範囲(半径)
1:300m,2:500m,3:1000m,4:2000m,5:3000m
(デフォルト:500m)
range
integer
範囲
sort
offset
hit_per_page
offset_page
freeword
integer
integer
integer
integer
string
ソート順
検索開始位置
ヒット件数
検索開始ページ
フリーワード検索
freeword_condition
lunch
no_smoking
card
mobilephone
bottomless_cup
sunday_open
takeout
private_room
midnight
parking
memorial_service
birthday_privilege
betrothal_present
kids_menu
outret
wifi
microphone
buffet
late_lunch
sports
until_morning
lunch_desert
projecter_screen
with_pet
deliverly
special_holiday_lunch
e_money
caterling
breakfast
desert_buffet
lunch_buffet
bento
lunch_salad_buffet
darts
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
integer
フリーワード検索条件タイプ
ランチ営業あり
禁煙席あり
カード利用可
携帯の電波が入る
飲み放題あり
日曜営業あり
テイクアウトあり
個室あり
深夜営業あり
駐車場あり
法事利用可
誕生日特典あり
結納利用可
キッズメニューあり
電源あり
wifiあり
マイクあり
食べ放題あり
14時以降のランチあり
スポーツ観戦可
朝まで営業あり
ランチデザートあり
プロジェクター・スクリーンあり
ペット同伴可
デリバリーあり
土日特別ランチあり
電子マネー利用可
ケータリングあり
モーニング・朝ごはんあり
デザートビュッフェあり
ランチビュッフェあり
お弁当あり
ランチサラダバーあり
ダーツあり
レスポンスデータのソート順
指定なし:ぐるなびソート順 ,1:店舗名,2:業態
検索開始レコードの位置(デフォルト:1)
一度のリクエストで得るレスポンスデータの最大件数(デフォルト:10)
検索開始ページ位置(デフォルト:1)
検索ワードをUTF-8でURLエンコードすること「,」区切りで複数ワードが検索可能(10個
まで)
フリーワード検索の条件を指定
1:AND検索、2:OR検索
(デフォルト:AND検索)
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
レスポンスデータ
パラメータ名(タグ名、@付きは属性名)
Response
@api_version
total_hit_count
hit_per_page
page_offset
rest
id
update_date
name
name_kana
latitude
longitude
category
url
url_mobile
coupon_url
pc
mobile
image_url
shop_image1
shop_image2
qrcode
address
tel
tel_sub
fax
opentime
holiday
access
line
station
station_exit
walk
note
parking_lots
pr
pr_short
pr_long
code
areacode
areaname
prefcode
prefname
areacode_s
areaname_s
category_code_l
@order
category_name_l
@order
category_code_s
@order
category_name_s
@order
budget
party
lunch
credit_card
e_money
flags
mobile_site
mobile_coupon
pc_coupon
出現回数 型
1
complexType
1
string
1
integer
1
integer
1
integer
複数回 complexType
1
string
1
timestamp
1
string
1
string
1
number
1
number
1
string
1
string
1
string
1
complexType
1
string
1
string
1
complexType
1
string
1
string
1
string
1
string
1
string
1
string
1
string
1
string
1
string
1
complexType
1
string
1
string
1
string
1
integer
1
string
1
integer
1
complexType
1
string
1
string
1
complexType
1
string
1
string
1
string
1
string
1
string
1
string
複数回 string
number
複数回 string
number
複数回 string
number
複数回 string
number
1
integer
1
integer
1
integer
1
string
1
string
1
complexType
1
integer
1
integer
1
integer
説明
レスポンスルートノード
APIのバージョン
該当件数
表示件数
表示ページ
レストラン情報
店舗ID
情報更新日時
店舗名称
店舗名称(カタカナ)
緯度
経度
フリーワードカテゴリー
PCサイトURL
携帯サイトURL
クーポンURL
PC用URL
携帯用URL
店舗画像
店舗画像1のURL
店舗画像2のURL
QRコードの画像URL
住所
電話番号
電話番号(サブ)
FAX番号
営業時間
休業日
アクセス
路線名
駅名
駅出口
徒歩(分)
備考
駐車場台数
PR文
PR文(短:最大50文字)
PR文(長:最大200文字)
コード類
エリアコード
エリア名称
都道府県コード
都道府県名称
エリアSコード
エリアS名称
大業態コード
オーダー
大業態名称
オーダー
小業態コード
オーダー
小業態名称
オーダー
平均予算
宴会・パーティ平均予算
ランチタイム平均予算
クレジットカード名称
電子マネー名称
フラグ類
モバイルサイトありフラグ
モバイルクーポンありフラグ
PCクーポンありフラグ
備考
十進数
十進数
レコード番号
レコード番号
レコード番号
レコード番号
API名称
URL
多言語版レストラン検索API
http://api.gnavi.co.jp/ForeignRestSearchAPI/20150630/
20151130仕様追加
リクエストパラメータ
パラメータ名
keyid
id
format
callback
必須
○
型
説明
備考
string
string
アクセスキー
店舗ID
ぐるなびより提供されたアクセスキー
「,」区切りで店舗IDを複数検索可能(10個まで)
string
string
レスポンス形式
コールバック関数
lang
name
string
返却言語
店舗名
xmlまたはjson(callback関数指定時にJSONP形式で出力)
formatが「json」の場合のみ
ja: 日本語, zh_cn: 中国語 (簡体字), zh_tw: 中国語 (繁体字), ko: 韓国語, en: 英語
UTF-8でURLエンコードすること
name_kana
address
area
pref
areacode_l
arecode_m
areacode_s
category_l
category_s
string
string
string
string
string
string
string
string
string
店舗名読み
住所
エリアコード
都道府県コード
エリアLコード
エリアMコード
エリアSコード
大業態コード
小業態コード
カタカナで指定
UTF-8でURLエンコードすること
lang=jaの場合のみ指定可能
(都道府県+市町村+番地)の文字列をUTF-8で URLエンコードすること
コードはエリアマスタ取得APIより取得
コードは都道府県マスタ取得APIより取得
コードはエリアLマスタ取得APIより取得
コードはエリアMマスタ取得APIより取得
コードはエリアSマスタ取得APIより取得
コードは大業態マスタ取得APIより取得
コードは小業態マスタ取得APIより取得
input_coordinates_mode
integer
入力測地系タイプ
入力する緯度/経度の測地系のタイプを指定
1:日本測地系、 2:世界測地系
(デフォルト:日本測地系)
coordinates_mode
integer
測地系タイプ
latitude
number
緯度
レスポンスに含まれる緯度/経度の測地系を指定
1:日本測地系、2:世界測地系(デフォルト:日本測地系)
分秒十進式
input_coordinates_mode(入力測地系タイプ)の選択したタイプの値で指定
分秒十進式
input_coordinates_mode(入力測地系タイプ)の選択したタイプの値で指定
longitude
number
経度
緯度/経度からの検索範囲(半径)
1:300m、2:500m、3:1000m、4:2000m、5:3000m
(デフォルト:500m)
range
integer
範囲
sort
offset
hit_per_page
offset_page
freeword
integer
integer
integer
integer
string
ソート順
検索開始位置
ヒット件数
検索開始ページ
フリーワード検索
freeword_condition
english_speaking_staff
integer
フリーワード検索条件タイプ
integer
英語が話せるスタッフがいる
integer
英語メニューあり
integer
韓国語が話せるスタッフがいる
0:絞込みなし(デフォルト)、1:絞込みあり
korean_menu
integer
韓国語メニューあり
0:絞込みなし(デフォルト)、1:絞込みあり
chinese_speaking_staff
integer
中国語が話せるスタッフがいる
0:絞込みなし(デフォルト)、1:絞込みあり
simplified_chinese_menu
integer
中国語(簡体字)メニューあり
traditional_chinese_menu
integer
integer
中国語(繁体字)メニューあり
ベジタリアンメニュー相談可
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
integer
国・宗教別メニュー相談可
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
integer
integer
integer
integer
wifi利用可
カード利用可
個室あり
禁煙席あり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
english_menu
korean_speaking_staff
vegetarian_menu_options
religious_menu_options
wifi
card
private_room
no_smoking
レスポンスデータのソート順
指定なし:ぐるなびソート順
1:店舗名、2:業態
検索開始レコードの位置(デフォルト:1)
一度のリクエストで得るレスポンスデータの最大件数(デフォルト:10)
検索開始ページ位置(デフォルト:1)
「,」区切りで複数フリーワード検索可能
(10個まで)
フリーワード検索の条件を指定
1:AND検索、2:OR検索
(デフォルト:AND検索)
0:絞込みなし(デフォルト)、1:絞込みあり
0:絞込みなし(デフォルト)、1:絞込みあり
レスポンスデータ
パラメータ名(タグ名、@付きは属性名)
Response
@api_version
total_hit_count
hit_per_page
page_offset
rest
id
update_date
name
name
name_sub
name_kana
business_hour
holiday
contacts
address
tel
fax
sales_points
pr_short
pr_long
access
budget
credit_card
categories
category
category_name_l
@order
category_name_s
@order
flags
mobile_site
mobile_coupon
pc_coupon
location
latitude
longitude
latitude_wgs84
longitude_wgs84
area
district
prefname
areaname_l
areaname_m
areaname_s
url
url_mobile
image_url
thumbnail
qrcode
※1返却値のgパラメータの指定値変更により画像サイズの変更が可能。
g=80 :縦横最大80x80(px)
g=157 :縦横最大157x157(px)
gパラメータなし:縦横最大240x240
出現回数 型
1
complexType
1
string
1
integer
1
integer
1
integer
複数回 complexType
1
string
1
timestamp
1
complexType
1
string
1
string
1
string
1
number
1
number
1
string
1
string
1
complexType
1
string
1
complexType
1
string
1
string
1
string
1
string
1
string
1
complexType
1
string
複数回 string
-
number
複数回 string
-
number
1
string
1
string
1
string
1
integer
複数回 complexType
1
integer
1
complexType
1
string
1
string
1
complexType
1
string
1
string
1
string
1
string
1
string
1
number
1
string
1
complexType
1
string
1
number
説明
レスポンスルートノード
APIのバージョン
該当件数
表示件数
表示ページ
レストラン情報
店舗ID
情報更新日時
店舗名称
店舗名称(日本語表記)
店舗名称(カタカナ)
営業時間
休業日
コンタクト
住所
電話番号
FAX番号
備考
lang=ja以外
lang=jaのみ
十進数
十進数
PR文(短:最大50文字)
PR文(長:最大200文字)
アクセス
平均予算
クレジットカード名称
フリーワードガテゴリー
大業態名称
オーダー
小業態名称
オーダー
フラグ類
モバイルサイトありフラグ
モバイルクーポンありフラグ
PCクーポンありフラグ
備考
緯度
経度
緯度(世界測地系)
経度(世界測地系)
エリア名称
都道府県名称
エリアL名称
エリアM名称
エリアS名称
PCサイトURL
携帯サイトURL
サムネイル画像URL
QRコード画像URL
lang=jaのみ
lang=ja以外
lang=ja以外
レコード番号
レコード番号
※1
lang=jaのみ