応援口コミAPI


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

リクエストパラメータ

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

パラメータ名 必須 説明 備考
keyid String アクセスキー ぐるなびより提供されたアクセスキー
shop_id   String 店舗ID 「,」区切りで店舗IDを複数検索可能(10個まで)
latitude △※1 number 緯度 分秒十進式
世界測地系で指定
longitude △※1 number 経度 分秒十進式
世界測地系で指定
range ※2 integer 範囲 GPS検索対象半径を設定する。単位はm。
緯度/経度からの検索範囲(半径)
1:300m、2:500m、3:1000m、
4:2000m、5:3000m
shop_name   String 店舗名 UTF-8でエンコードすること
area   String 場所(フリーワード) UTF-8でエンコードすること
comment   String コメント UTF-8でエンコードすること
first_shop_message   String 店舗からの最初のメッセージ UTF-8でエンコードすること
menu_name   integer メニュー名 UTF-8でエンコードすること
photo_scene_id   integer シーン 「,」区切りでシーンIDを9個まで指定可能
1:友人・同僚と,2:宴会,3:パーティー,4:女子会,5:デート,6:誕生日・記念日,7:お一人様,8:ママ会,9:その他
hit_per_page   integer ヒット件数 1回のリクエストで得る最大投稿件数(デフォルト:15、上限:50)
offset_page   integer 検索開始ページ 検索開始ページ位置(デフォルト:1)
offset   integer 検索開始位置 検索開始レコード位置(デフォルト:1)
order ※3 String ソートキー ソートキー(デフォルト:vote_date)
vote_date:投稿日時(緯度、経度を設定した場合、昇順のみ有効)
distance:現在地からの距離(緯度、経度を設定した場合のみ有効)
sort ※3 integer ソート順 ソート順
0:昇順
1:降順(デフォルト:昇順)
vote_date   integer 投稿日で絞込み 現在日より過去何日間の投稿を抽出対象とするかを設定
photo_genre_id   integer 写真ジャンルで絞込み 「,」区切りで3個まで写真ジャンルIDを指定可能
1:料理・ドリンク,2:店内・外観,3:人物・その他

レスポンス

パラメータ名 出現回数 説明 備考
Response 1 ComplexType レスポンスルート  
@api_version - string APIのバージョン  
  total_hit_count 1 integer 該当件数 1000件を超えている場合、上位1000件までのデータが返却される
  hit_per_page 1 integer 表示件数  
  photo 複数回 ComplexType 応援口コミ情報  
   vote_id   1 integer 投稿ID  
   photo_genre_id   1 integer 写真ジャンルID  
   photo_genre_name  1 string 写真ジャンル名称  
   photo_scene_id  1 integer シーンID  
   photo_scene_name  1 string シーン名称  
   nickname   1 string ニックネーム  
   shop_id   1 string 店舗ID  
   shop_name   1 string 店舗名称  
   shop_url   1 string PCサイトURL  
   prefname   1 string 都道府県  
   menu_id   1 integer メニューID  
   menu_name   1 string メニュー名  
   menu_finish_flag  1 integer メニュー終了フラグ 当該のメニューが終了しているかを示す
0:提供中、1:終了
   areaname_l   1 string 大エリア名  
   areaname_m   1 string 中エリア名  
   areaname_s   1 string 小エリア名  
   image_url   1 ComplexType    
    url_1024  1 stirng 画像URL(1024px)  
    url_320  1 stirng 画像URL(320px)  
    url_250  1 stirng 画像URL(250px)  
    url_200  1 stirng 画像URL(200px)  
   comment   1 string コメント  
   total_score   1 number 総合評価  
   category   1 string 11文字業態  
   distance   1 integer 距離 緯度、経度が設定されている場合のみ返却される
単位はメートル
   latitude   1 string 緯度  
   longitude   1 string 経度  
   umaso_count   1 integer うまそ数  
   update_date   1 timestamp 投稿日時  
   messages   1 ComplexType    
    user_message_count 1 integer メッセージ返信件数(ユーザー)  
    shop_messege_count 1 integer メッセージ返信件数(店舗)  
    first_shop_message 1 ComplexType 店舗からの最初のメッセージ  
     message_body 1 string メッセージ本文  
  send_date 1 string メッセージ送信日時  

※1店舗IDまたは検索ワードが設定されている場合は無視される。どちらか一方しか設定されない場合はエラー返却。設定された地点から近い順にソートされる。
※2店舗IDまたは検索ワードが設定されている場合は無視される。緯度、経度を設定した場合のみ有効。
※3緯度、経度が設定されている場合は無視される。


エラー仕様

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

エラーコード一覧

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

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

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

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

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