多言語版レストラン検索API


URL:https://api.gnavi.co.jp/ForeignRestSearchAPI/v3/

リクエストパラメータ

※リクエストパラメータがkeyidのみの場合は、パラメータ不足のため、エラーとして値が返ります。

パラメータ名 必須 説明 備考
keyid string アクセスキー ぐるなびより提供されたアクセスキー
id   string 店舗ID 「,」区切りで店舗IDを複数検索可能(10個まで)
lang   string 返却言語 ja: 日本語, zh_cn: 中国語 (簡体字), zh_tw: 中国語 (繁体字), ko: 韓国語, en: 英語
name   string 店舗名 UTF-8でURLエンコードすること
address   string 住所 (都道府県+市町村+番地)の文字列をUTF-8で
URLエンコードすること
area   string 地方コード コードはエリアマスタ取得APIより取得
pref   string 都道府県コード コードは都道府県マスタ取得APIより取得
areacode_l   string エリアLコード コードはエリアLマスタ取得APIより取得
areacode_m   string エリアMコード コードはエリアMマスタ取得APIより取得
areacode_s   string エリアSコード コードはエリアSマスタ取得APIより取得
category_l   string 大業態コード コードは大業態マスタ取得APIより取得
「,」区切りで複数ワードが検索可能 (10個まで)
category_s   string 小業態コード コードは小業態マスタ取得APIより取得
「,」区切りで複数ワードが検索可能 (10個まで)
input_coordinates_mode   integer 入力測地系タイプ 入力する緯度/経度の測地系のタイプを指定
1: 日本測地系
2: 世界測地系 (デフォルト: 世界測地系)
coordinates_mode   integer 測地系タイプ レスポンスに含まれる緯度/経度の測地系を指定
1: 日本測地系
2: 世界測地系 (デフォルト:世界測地系)
latitude   number 緯度 分秒十進式
input_coordinates_mode(入力測地系タイプ)の選択したタイプの値で指定
longitude   number 経度 分秒十進式
input_coordinates_mode(入力測地系タイプ)の選択したタイプの値で指定
range   integer 範囲 緯度/経度から検索範囲(半径)
1:300m, 2:500m, 3:1,000m, 4:2,000m, 5:3,000m
(デフォルト:500m)
sort   integer ソート順 レスポンスデータのソート順
指定なし:ぐるなびソート順
1: 店舗名, 2: 業態
offset   integer 検索開始位置 検索開始レコードの位置 (デフォルト: 1)
hit_per_page   integer ヒット件数 一度リクエストで得るレスポンスデータの最大件数(デフォルト:10、上限:100)
offset_page   integer 検索開始ページ 検索開始ページ位置 (デフォルト: 1)
freeword   string フリーワード検索 検索ワードをUTF-8でURLエンコードすること
「,」区切りで複数ワードが検索可能(10個まで)
freeword_condition   integer フリーワード検索条件タイプ フリーワード検索の条件を指定
1: AND検索, 2: OR検索 (デフォルト: AND検索)
english_speaking_staff integer英語が話せるスタッフがいる0:絞込みなし(デフォルト)、1:絞り込みあり
english_menu integer英語メニューあり0:絞込みなし(デフォルト)、1:絞り込みあり
korean_speaking_staff integer韓国語が話せるスタッフがいる0:絞込みなし(デフォルト)、1:絞り込みあり
korean_menu integer韓国語メニューあり0:絞込みなし(デフォルト)、1:絞り込みあり
chinese_speaking_staff integer中国語が話せるスタッフがいる0:絞込みなし(デフォルト)、1:絞り込みあり
simplified_chinese_menu integer中国語(簡体字)メニューあり0:絞込みなし(デフォルト)、1:絞り込みあり
traditional_chinese_menu integer中国語(繁体字)メニューあり0:絞込みなし(デフォルト)、1:絞り込みあり
vegetarian_menu_options integerベジタリアンメニュー相談可0:絞込みなし(デフォルト)、1:絞り込みあり
religious_menu_options integer国・宗教別メニュー相談可0:絞込みなし(デフォルト)、1:絞り込みあり
wifi integerwifi利用可0:絞込みなし(デフォルト)、1:絞り込みあり
card integerカード利用可0:絞込みなし(デフォルト)、1:絞り込みあり
private_room integer個室あり0:絞込みなし(デフォルト)、1:絞り込みあり
no_smoking integer禁煙席あり0:絞込みなし(デフォルト)、1:絞り込みあり

レスポンス

パラメータ名
(タグ名、@付きは属性名)
出現回数 説明 備考
Response 1 complexType レスポンスルートノード  
@api_version - string APIのバージョン  
total_hit_count 1 integer 該当件数 1000件を超えている場合、上位1000件までのデータが返却される
hit_per_page 1 integer 表示件数  
page_offset 1 integer 表示ページ  
rest 複数回 complexType レストラン情報  
id 1 string 店舗ID  
update_date 1 timestamp 情報更新日時  
name 1 complexType 店舗名称  
name 1 string 店舗名称 lang=ja:日本語
lang=ja以外:英語
name_sub 1 string 店舗名称 (日本語表記) lang=ja以外で返却
name_kana 1 string 店舗名称 (カタカナ) lang=jaのみ返却
business_hour 1 string 営業時間  
holiday 1 string 休業日  
contacts 1 complexType コンタクト  
address 1 string 住所  
tel 1 string 電話番号  
fax 1 string FAX番号  
sales_points 1 complexType PR文  
  pr_short 1 string PR文(短)  
pr_long 1 string PR文(長)  
access 1 string アクセス  
budget 1 string 平均予算  
credit_card 1 string クレジットカード名称  
categories 1 complexType    
category 1 string フリーワードカテゴリー lang=jaのみ返却
category_name_l 複数回 string 大業態名称  
  @order - number オーダー レコード番号
category_name_s 複数回 string 小業態名称  
  @order - number オーダー レコード番号
flags 1 complexType フラグ類  
  mobile_site 1 integer モバイルサイトありフラグ  
mobile_coupon 1 integer モバイルクーポンありフラグ  
pc_coupon 1 integer PCクーポンありフラグ  
location 1 complexType    
  latitude 1 number 緯度 度分秒十進数
longitude 1 number 経度 度分秒十進数
latitude_wgs84 1 number 緯度(世界測地系) 世界測地系緯度
longitude_wgs84 1 number 経度(世界測地系) 世界測地系経度
area 1 complexType    
  district 1 string 地域  
prefname 1 string 都道府県名
areaname_l 1 string エリアL名 lang=ja以外で返却
areaname_m 1 string エリアM名 lang=ja以外で返却
areaname_s 1 string エリアS名  
url 1 string PCサイトURL  
url_mobile 1 string モバイルサイトURL lang=jaのみ返却
image_url 1 complexType 店舗画像  
  thumbnail 1 string サムネイル画像URL ※1
qrcode 1 string QRコード画像URL lang=jaのみ返却

※1 返却値のgパラメータの指定値変更により画像サイズの変更が可能。
g=80 :縦横最大80x80(px)
g=157 :縦横最大157x157(px)
gパラメータなし:縦横最大240x240(px)


エラー仕様

パラメータ名
(タグ名)
出現回数 説明
gnavi 1 complexType ルートノード
@api_version - string APIのバージョン
  error 1 complexType エラー
  code 1 integer エラーコード(詳細は「エラーコード一覧」をご覧ください)
message 1 string エラーメッセージ

エラーコード一覧

エラーコード エラー内容
400 不正なパラメータが指定された
401 不正なアクセス(認証エラー)
404 指定された店舗の情報が存在しない
405 不正なアクセス
429 リクエスト回数上限超過
500 処理中にエラーが発生した

サンプルエラーレスポンス

{
    "@attributes":{
        "api_version":"v3"
    },
    "error":{
        "code":"400",
        "message":"指定されたパラメーターは存在しません"
    }
}
              

データを正しく返却できない際は、上記のようなエラーデータを返却します。

さっそく「ぐるなび API」を使ってみる