YOLP(地図)
施設内検索API
【重要】常時SSL(AOSSL)対応にともないリクエストURLが変更されています。詳しくはこちらをご確認ください。リクエストURL
XML
https://map.yahooapis.jp/inner/V1/building
JSONP
https://map.yahooapis.jp/inner/V1/building
目次
概要
建物の形状情報から、含まれる店舗・施設情報を返す機能を提供します。
リクエストパラメーター一覧
「RESTリクエストの構築(GET)」をご参照ください。
パラメーター | 値 | 説明 |
---|---|---|
appid (必須) |
string | アプリケーションIDです。詳細はこちらをご覧ください。 |
lat |
float | 緯度です。(世界測地系で指定してください。) |
lon |
float | 経度です。(世界測地系で指定してください。) |
sort |
string | ソートの方法を指定します。
|
detail |
string | 出力項目数を増減できます(デフォルト:standard)。
|
start | integer: 1(デフォルト) | 取得開始位置を指定します。 |
results | integer: 10(デフォルト) | 取得件数を指定します(最大100)。 |
output | string xml(デフォルト), json |
出力形式:
|
callback | string |
JSONPとして出力する際のコールバック関数名を入力するためのパラメーター。UTF-8でエンコードした文字列を入力します。 |
API使用上の注意
URLの最大の長さは2048バイトです。
URLエンコードを行って指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。
サンプルリクエストURL
緯度、経度を指定して施設内を検索
https://map.yahooapis.jp/inner/V1/building?lat=35.66619&lon=139.73008&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(Countryの子要素) | 国コード(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)です。 |
Building | 店舗が入るビル情報を格納します。 |
Id(Buildingの子要素) | ビルIDです。 |
Name(Buildingの子要素) | ビルの名称です。 |
Floor(Buildingの子要素) | ビルの階数です。 |
Area(Buildingの子要素) | ビルの面積です。 |
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の説明やスキーマの記述を参考にしてください。
サンプルレスポンス
以下は、緯度:35.66619、経度:139.73008を指定した場合のレスポンスです。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.08788800239563</Latency> <Status>200</Status> <Description>建物の形状情報から、含まれる店舗・施設情報を返す機能を提供します。</Description> <Copyright>Copyright (C) 2012 Yahoo Japan Corporation. All Rights Reserved.</Copyright> <CompressType /> </ResultInfo> <Feature> <Id>81304283039901</Id> <Gid>800CKGFVLUg</Gid> <Name>HAL YAMASHITA 東京</Name> <Geometry> <Type>point</Type> <Coordinates>139.73060691,35.666669041301</Coordinates> </Geometry> <Category /> <Description /> <Style /> <Property> <Uid>d379f8bf338b48b15f108a2d7db94fe6fc7350d1</Uid> <CassetteId>f0a6bbe4fd136ad4cfb344b04c045ee7</CassetteId> <Yomi>ハルヤマシタトウキョウ</Yomi> <Country> <Code>JP</Code> <Name>日本</Name> </Country> <Address>東京都港区赤坂9-7-4 </Address> <GovernmentCode>13103</GovernmentCode> <AddressMatchingLevel>6</AddressMatchingLevel> <Tel1>03-5413-0086</Tel1> <Genre> <Code>0101053</Code> <Name>和食(その他)</Name> </Genre> <Area> <Code>000025</Code> <Name>赤坂・六本木</Name> </Area> <Station> <Id>23049</Id> <SubId>2304901</SubId> <Name>六本木</Name> <Railway>都営大江戸線/東京メトロ日比谷線</Railway> <Exit>7</Exit> <ExitId>5423</ExitId> <Distance>483</Distance> <Time>5</Time> </Station> <Station> <Id>22893</Id> <SubId>2289301</SubId> <Name>乃木坂</Name> <Railway>東京メトロ千代田線</Railway> <Exit>2</Exit> <ExitId>4912</ExitId> <Distance>695</Distance> <Time>8</Time> </Station> <Station> <Id>23049</Id> <SubId>2304902</SubId> <Name>六本木</Name> <Railway>東京メトロ日比谷線</Railway> <Exit>2</Exit> <ExitId>5429</ExitId> <Distance>790</Distance> <Time>9</Time> </Station> <KeepCount>98</KeepCount> </Property> </Feature> <Dictionary> <Building> <Id>B@bBpVWA2xL</Id> <Name>ガレリア</Name> <Floor>4</Floor> <Area>5741</Area> </Building> </Dictionary> </YDF>
JSON形式
{ "ResultInfo": { "Count": 1, "Total": 1, "Start": 1, "Latency": 0.095795869827271, "Status": 200, "Description": "建物の形状情報から、含まれる店舗・施設情報を返す機能を提供します。", "Copyright": "Copyright (C) 2012 Yahoo Japan Corporation. All Rights Reserved.", "CompressType": "" }, "Feature": [ [ { "Id": "81304283039901", "Gid": "800CKGFVLUg", "Name": "HAL YAMASHITA 東京", "Geometry": { "Type": "point", "Coordinates": "139.73060691,35.666669041301" }, "Category": "", "Description": "", "Style": "", "Property": { "Uid": "d379f8bf338b48b15f108a2d7db94fe6fc7350d1", "CassetteId": "f0a6bbe4fd136ad4cfb344b04c045ee7", "Yomi": "ハルヤマシタトウキョウ", "Country": { "Code": "JP", "Name": "日本" }, "Address": "東京都港区赤坂9-7-4 ", "GovernmentCode": "13103", "AddressMatchingLevel": "6", "Tel1": "03-5413-0086", "Genre": [ { "Code": "0101053", "Name": "和食(その他)" } ], "Area": [ { "Code": "000025", "Name": "赤坂・六本木" } ], "Station": [ { "Id": "23049", "SubId": "2304901", "Name": "六本木", "Railway": "都営大江戸線/東京メトロ日比谷線", "Exit": "7", "ExitId": "5423", "Distance": "483", "Time": "5" }, { "Id": "22893", "SubId": "2289301", "Name": "乃木坂", "Railway": "東京メトロ千代田線", "Exit": "2", "ExitId": "4912", "Distance": "695", "Time": "8" }, { "Id": "23049", "SubId": "2304902", "Name": "六本木", "Railway": "東京メトロ日比谷線", "Exit": "2", "ExitId": "5429", "Distance": "790", "Time": "9" } ], "KeepCount": "98" } } ] ], "Dictionary": { "Building": [ [ { "Id": "B@bBpVWA2xL", "Name": "ガレリア", "Floor": "4", "Area": "5741", } ] ] } }
エラー
コード | 説明 |
---|---|
400 | 渡されたパラメーターがWeb APIで期待されたものと一致しない場合に返されます。 |
503 | 内部的な問題によってデータを返すことができない場合に返されます。 |
<Error> <Message>パラメーターが不正です。</Message> <Detail> <Code>400</Code> </Detail> </Error>