YOLP（地図）
Yahoo!ローカルサーチAPI
Version 1
リクエストURL
XML
http://search.olp.yahooapis.jp/OpenLocalPlatform/V1/localSearch
JSONP
http://search.olp.yahooapis.jp/OpenLocalPlatform/V1/localSearch
概要
Yahoo!ローカルサーチAPI（以下、ローカルサーチAPI）は、店舗、イベント、クチコミ情報などの地域・拠点情報（POI)を検索するためのAPIです。
検索対象は、全国の店舗を網羅した電話帳データおよび店舗オーナーやユーザーからの投稿データです。
自分のデータもアップロードして検索対象とすることができます。アップロード方法についてはYOLPカセットギャラリー ご利用ガイドを参照してください。
ローカルサーチAPIの主な機能は以下となります。
・地域・拠点情報の名称および業種をキーワードで検索できます。
・中心位置を指定して円範囲で絞り込めます。
・矩形範囲を指定して絞り込めます。
リクエストパラメータ一覧
「RESTリクエストの構築（GET）」をご参照ください。
| パラメータ | 値 | 説明 |
|---|---|---|
| appid （必須） |
string | アプリケーションID。詳細はこちらをご覧ください。 |
| device | string | APIの結果をモバイル端末に掲載する場合は「mobile」を指定してください。モバイル端末で掲載できない情報が非表示になります。 |
| query | string | （UTF-8でエンコードされた）検索クエリーです。検索対象は、地域・拠点情報名称および業種（カセットによってはない場合があります）です。 |
| cid | string | カセットIDです。カセットIDを用いてYOLPカセットギャラリーのカセットや電話帳の店舗データを検索することができます。 コンマ「,」区切りで複数指定が可能です。 指定しない場合は、ギャラリーで公開されているカセット全体が検索対象となります。 カセットIDは、YOLPカセットギャラリーで利用したいカセットの詳細情報ページに記載されています。 |
| uid | string | ユニークIDです。 コンマ「,」区切りで複数指定できます。 |
| gid | string | GID（店舗ID）を検索することができます。 コンマ「,」区切りで複数指定が可能です。 GID（店舗ID）は、店舗名寄せAPIからも検索することができます。 |
| group | string | gidを指定すると名寄せされた同一店舗をまとめて表示します。 ※名寄せされた店舗の中でsortで指定した並び順の上位一件のみ表示されます。 ※すべての店舗が必要な場合はdistinct=falseを指定してください。 |
| distinct | boolean | group=gid時に重複レコードの表示を指定します。 デフォルトはtrueです。 名寄せされた店舗すべてが必要な場合にfalseをセットしてください。 ※false の場合、リクエストパラメータのresultsは店舗のユニークの件数となるため、リクエストパラメータのresultsとレスポンスの<Count>の件数が異なります。 |
| sort | string rating（デフォルト）, score hybrid review kana price dist geo |
ソートの方法を指定します:
|
| start | int | 取得開始位置を指定します（最大3000）。 |
| results | int | 取得件数を指定します（最大100）。 |
| detail | string simple, standard（デフォルト）, full |
出力項目数を増減できます。詳細はこちらをご覧ください。 |
| output | string xml（デフォルト）, json |
出力形式を指定します：
|
| callback | string | JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力します。 |
| lat | float | 中心の緯度。 |
| lon | float | 中心の経度。 |
| dist | int | 検索距離（km）です。 最大50km、小数点も指定できます。 中心の緯度、中心の経度のパラメータが必須です。 |
| bbox | string | 矩形範囲の左下経度、左下緯度、右上経度、右上緯度を世界測地系十進形式で指定（コンマ区切り）。 |
| ac | string | 住所コード（JIS X 0401）または国コード(ISO 3166-1 alpha-2)です。 住所コードは都道府県（2けた）と市町村(5けた）を指定可能です。 ex) 北海道:01, 札幌市中央区:01101 国コードは、2文字を指定してください。 ex) 日本:JP、アメリカ：US |
| gc | string | 業種コードを指定します。 業種マスターAPI |
| coupon | boolean | trueを指定すると、クーポンが利用できる店舗データを対象に検索します。falseは無効です。 ※モバイル向けサイトでは掲載不可なクーポンがあります。APIの結果をモバイル端末に掲載する場合は、リクエストパラメータ「device」をセットし「mobile」を指定してください。モバイル端末で掲載不可なクーポンが非表示になります。 ※クーポンの利用についてはクーポン提供元サイトの利用条件（画面を印刷して提示など）に準じます。 |
| parking | boolean | trueを指定すると、駐車場がある店舗データを対象に検索します。falseは無効です |
| creditcard | boolean | trueを指定すると、クレジットカードが利用できる店舗データを対象に検索します。falseは無効です。 |
| loco_mode | boolean |
Yahoo!ロコと同等の検索機能を有効にします。 ・3文字以下のひらがなまたはカタカナでのクエリのロジックが変更になります。より絞り込まれた結果が返ってくるようになります。 ・「ランチ」「飲み放題」「食べ放題」「女子会」「個室」で検索した場合、自動的にフラグ検索に切り替わります。
|
| maxprice | int | Priceタグの最大値を指定します。 |
| minprice | int | Priceタグの最小値を指定します。 |
API使用上の注意
appid以外に緯度経度(lat,lon),uid,cid,query,acのいずれかのパラメータが必須となります。
URLの最大の長さは2048バイトです。エンコード後のURLの長さが2048バイトを超えないようにしてください。
サンプルリクエストURL
「電話帳」カセットを指定して、「六本木周辺2km以内のラーメン」を検索する場合の例です。
レスポンスフィールド
ローカルサーチAPIのスキーマの記述は、以下のURLをご覧ください。
http://olp.yahooapis.jp/OpenLocalPlatform/V1/YDF.xsd
| フィールド | 説明 |
|---|---|
| YDF | クエリーレスポンスのすべてを含みます。 |
| ResultInfo | レスポンスのまとめ情報です。 |
| Count | レスポンス情報に含まれる住所情報のデータ件数です。 |
| Total | 出力されている住所情報以外も含めた全データ件数です。 |
| Start | レスポンス情報に含まれる住所情報の、全データからの取得開始位置です。 |
| Latency | レスポンス情報を生成するのに要した時間です。 |
| Status | リクエスト元に処理結果を伝えるためのコードです。正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。 |
| Feature | 検索結果1件分のデータ群です。 |
| Id | カセット内部のIDです。 |
| Gid | 拠点ごとに割り当てられた拠点の管理IDです。 |
| Name | 地域・拠点情報名です。 |
| Geometry | 拠点の場所を表すGeometry要素です(世界測地系）。 |
| Type | 図形種別です。 |
| Coordinates | 座標情報です。 |
| Property | 地域・拠点情報の詳細要素です。 |
| Uid | Yahoo! Open Local Platform（YOLP）内部での識別IDです。 |
| CassetteId | カセットIDです。 |
| Yomi | 地域・拠点情報名の読みです。 |
| Country | 国情報です。 |
| Code | 国コード（ISO 3166-1）です。 |
| Name（Countryの子要素） | 国名です。 |
| Address | 1行で表す住所です。 |
| GovernmentCode | 住所コード（JIS X 0401 5けた）です。 |
| Station | 最寄駅情報です。 最大3件です。 |
| Id（Stationの子要素） | 駅IDです。 |
| Name（Stationの子要素） | 駅名です。 |
| Railway（Stationの子要素） | 代表路線名です。 |
| Exit（Stationの子要素） | 最寄りの駅出口名です。 |
| ExitviewId （Stationの子要素） | 最寄りの駅出口IDです。 |
| Distance（Stationの子要素） | 最寄駅出口からの距離（m）です。 |
| BuildingInfo | 店舗が入るビル情報を格納します。 |
| Id（BuildingInfoの子要素） | ビルIDです。 |
| Name（BuildingInfoの子要素） | ビル名称です。 |
| Floor（BuildingInfoの子要素） | 階数です。 |
| PlaceInfo | 店舗が入る場所情報を格納します。 |
| FloorName（PlaceInfoの子要素） | フロア名です。 |
| MapType（PlaceInfoの子要素） | 最適な地図の種別です。 |
| MapScale（PlaceInfoの子要素） | この地域・拠点名を表示するのに適切な地図の縮尺です。 |
| Time | 最寄駅出口からの徒歩時間です。 |
| Tel1 | 電話番号です。 |
| Genre | 店舗のジャンルです（※複数あり）。 |
| Code（Genreの子要素） | 業種コードです。 |
| Name（Genreの子要素） | ジャンル名です。 |
| CatchCopy | キャッチコピーです。 |
| Coupon | クーポン情報です。 |
| ReviewCount | レビュー数です。 |
| Detail | 詳細情報です。 |
| ZipCode | 郵便番号です。 |
| Fax1 | Fax番号です。 |
| Access1 | アクセス方法です。 |
| Copyright | コピーライトです。 |
| PcUrl1 | パソコンサイトのURLです。 |
| MobileUrl1 | モバイルサイトのURLです。 |
| ReviewUrl | レビューのURLです。 |
| Image1 | 画像情報です。 |
| Style | Style情報です。 |
こちらで定義されているレスポンスフィールドはデフォルトのものです。各カセットごとに拡張されたレスポンスフィールドを持つ場合があります。YDFの説明やスキーマの記述を参考にしてください。
