YOLP(地図)
ルート沿い検索API
【重要】常時SSL(AOSSL)対応にともないリクエストURLが変更されています。詳しくはこちらをご確認ください。リクエストURL
XML
https://map.yahooapis.jp/spatial/V1/shapeSearch
JSONP
https://map.yahooapis.jp/spatial/V1/shapeSearch
目次
概要
ルート情報から、その近辺の店舗・施設情報を返す機能を提供します。
リクエストパラメーター一覧
「RESTリクエストの構築(GET)」をご参照ください。
パラメーター | 値 | 説明 |
---|---|---|
appid (必須) |
string | アプリケーションIDです。詳細はこちらをご覧ください。 |
query |
string | (UTF-8でエンコードされた)検索クエリーです。 |
coordinates |
string | 緯度経度(経度・緯度をコンマ区切りで指定、スペースで複数点指定)です。 |
precision |
integer:10(デフォルト) | 検索精度を指定します。1~25まで指定でき、数が大きい方が精度が高くなります。 |
z |
integer:16 (デフォルト) | 縮尺を指定します。詳細はこちらをご覧ください。 |
mode |
string auto(デフォルト) line circle |
検索モードです。
|
sort |
string mix(デフォルト) box |
並べ替え順です。
|
results | integer: 10(デフォルト) | 取得件数を指定します(最大100)。 |
output | string xml(デフォルト), json |
出力形式:
|
callback | string |
JSONPとして出力する際のコールバック関数名を入力するためのパラメーターです。UTF-8でエンコードした文字列を入力します。 |
API使用上の注意
URLの最大の長さは2048バイトです。
URLエンコードを行って指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。
サンプルリクエストURL
緯度経度による指定
https://map.yahooapis.jp/spatial/V1/shapeSearch?query=%E3%83%A9%E3%83%BC%E3%83%A1%E3%83%B3&coordinates=139.7297801,35.6646985 139.7297801,35.6659623 139.7312115,35.6659623 139.7312115,35.6646985&appid=<あなたのアプリケーションID>
レスポンス
出力形式にXMLを指定(output=xml)した場合、XMLを返します。レスポンスフィールドをご参照ください。
レスポンスフィールド
ルート沿い検索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です。 |
ReviewUrl1 | レビューのURLです。 |
Image1 | 画像情報です。 |
Style | Style情報です。 |
こちらで定義されているレスポンスフィールドはデフォルトのものです。カセットごとに拡張されたレスポンスフィールドを持つ場合があります。YDFの説明やスキーマの記述を参考にしてください。
サンプルレスポンス
以下は、queryにラーメンを指定した場合のレスポンスです。XML形式
<?xml version="1.0" encoding="UTF-8"?> <YDF firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1" xmlns="http://olp.yahooapis.jp/ydf/1.0"> <ResultInfo> <Count>1</Count> <Total>1</Total> <Start>1</Start> <Latency>0.046</Latency> <Status>200</Status> <Description /> <Copyright>Copyright (C) 2011 Yahoo Japan Corporation. All Rights Reserved</Copyright> <CompressType /> </ResultInfo> <Feature> <Id>fee370cffcae93d9461f19966fc31c4c</Id> <Name>GMフーズ 店舗情報</Name> <Description>らぁめん「伝丸」や中華料理「天下一」などの店舗情報です。澄んだ鶏ガラスープとこだわりの味噌が自慢の味噌らーめんを主軸とした「伝丸」や、ホイコーローやチンジャオロースなどの一品料理から定食まで揃っている「天下一」など、こだわりのらーめんや一品料理、ボリュームたっぷりの定食メニューなどを提供しています。</Description> <Property> <AdultFlag>0</AdultFlag> <Licence /> <PublishStart>1289546220</PublishStart> <UpdateDate>1291688851</UpdateDate> <Detail> <Tags>ラーメン,中華料理,レストラン</Tags> <ImageUrl1>http://olp.c.yimg.jp/olp/fee370cffcae93d9461f19966fc31c4c/info/thumbnail/image.png</ImageUrl1> <OfficialWebsiteUrl>http://www.gmfoods.co.jp/</OfficialWebsiteUrl> <ReferenceUrl /> <Copyright>Copyright (C) 2010 ZENSHO Co., Ltd. All Rights Reserved.</Copyright> <UseCondition /> <SupportEmail /> <SupportUrl /> <CassetteOwner>株式会社ゼンショー</CassetteOwner> <CassetteType>poi_yolp</CassetteType> <CassetteVersion>0</CassetteVersion> <CassetteCategory>place_official</CassetteCategory> <DownloadCount>1</DownloadCount> <PoiCount>106</PoiCount> </Detail> </Property> </Feature> </YDF>
JSON形式
{"ResultInfo": {"Count":1, "Total":1, "Start":1, "Latency":0.037, "Status":"200", "Description":"", "Copyright":"Copyright (C) 2011 Yahoo Japan Corporation. All Rights Reserved", "CompressType":"" }, "Feature":[ {"Id":"fee370cffcae93d9461f19966fc31c4c", "Name":"GMフーズ 店舗情報", "Description":"らぁめん「伝丸」や中華料理「天下一」などの店舗情報です。澄んだ鶏ガラスープとこだわりの味噌が自慢の味噌らーめんを主軸とした「伝丸」や、ホイコーローやチンジャオロースなどの一品料理から定食まで揃っている「天下一」など、こだわりのらーめんや一品料理、ボリュームたっぷりの定食メニューなどを提供しています。", "Property": {"AdultFlag":"0", "Licence":"", "PublishStart":"1289546220", "UpdateDate":"1291688851", "Detail":{ "Tags":["ラーメン,中華料理,レストラン"], "ImageUrl1":["http://olp.c.yimg.jp/olp/fee370cffcae93d9461f19966fc31c4c/info/thumbnail/image.png"], "OfficialWebsiteUrl":["http://www.gmfoods.co.jp/"], "ReferenceUrl":[""], "Copyright":["Copyright (C) 2010 ZENSHO Co., Ltd. All Rights Reserved."], "UseCondition":[""], "SupportEmail":[""], "SupportUrl":[""], "CassetteOwner":["株式会社ゼンショー"], "CassetteType":["poi_yolp"], "CassetteVersion":["0"], "CassetteCategory":["place_official"], "DownloadCount":["1"], "PoiCount":["106"] } } }] }
エラー
コード | 説明 |
---|---|
400 | 渡されたパラメーターがWeb APIで期待されたものと一致しない場合に返されます。 |
503 | 内部的な問題によってデータを返すことができない場合に返されます。 |
<Error> <Message>パラメーターが不正です。</Message> <Detail> <Code>400</Code> </Detail> </Error>