YOLP(地図)

リファレンス

目次




ResultInfo

YDFデータのレスポンス情報全体に関する情報を設定する要素です。検索結果として複数の拠点情報を出力する場合には必須ですが、拠点情報が常に1件の場合等は省略可能です。下表の子要素は、データがない場合でも必ず出力してください。

子要素名 説明 備考
Count データ件数 レスポンス情報に含まれる拠点情報(Feature)として出力されたデータ件数です。
Total 総データ件数 出力されている拠点情報以外も含めた全データ件数です。
Start 取得開始件数(1以上) レスポンス情報に含まれる拠点情報の全データからの取得開始位置です。
Latency 処理時間(秒) レスポンス情報を生成するのに要した時間です。
Status 終了ステータスコード リクエスト元に処理結果を伝えるためのコードです。正常終了時は、200を設定します。
Description データの説明 レスポンス情報全体の説明です。
Copyright コピーライト レスポンス情報提供元等のコピーライト表示です。
  • Statusは、HTTP/1.1(RFC 2616)で定義されているステータスコードだけでなく、独自コードも設定可能です。HTTPヘッダーで返すHTTPステータスコードと異なっていても問題ありません。
  • Statusが正常終了(200)以外の場合は、Error要素にエラーメッセージを表示します。
  • DescriptionとCopyrightは、HTMLで企業ロゴなどの画像を組み合わせることも可能です(HTMLをXML形式で出力する場合は、CDATAとします)。

出力例

JSON(JSONP)
"ResultInfo":{"Count":10,"Total":78,"Start":1,"Latency":0.024,"Status":200,
"Description":"Yahoo!\u30b0\u30eb\u30e1\u304c\u63d0\u4f9b\u3059\u308b\u5168\u56fd\u306e\u98f2\u98df\u5e97\u60c5\u5831",
"Copyright":"<b>&copy; Yahoo Japan</b>"}

XML
<ResultInfo>
 <Count>10</Count>
 <Total>78</Total>
 <Start>1</Start>
 <Latency>0.021</Latency>
 <Status>200</Status>
 <Description>Yahoo!グルメが提供する全国の飲食店情報</Description>
 <Copyright><![CDATA[<b>&copy; Yahoo Japan</b>]]></Copyright>
</ResultInfo>



Feature

地図上のアイコンや検索結果リストの1行に表示される拠点情報を表す要素です。
detailパラメータで指定する出力レベルにより出力項目が異なります。
標準モードのPropertyは、APIでの出力処理で出力項目を設定します。

子要素名 説明 簡易 標準 詳細
Id 要素を特定するための識別子
Gid 複数のカセット間で共有する店舗識別子(店舗を扱わない場合はなし)
Name 拠点名称
Category カテゴリ(複数指定可能) ×
Description 拠点の説明(HTML指定可能) ×
Geometry 拠点の場所を表すGeometry要素
Property 拠点の各種データを表すProperty要素 ×
Style 拠点の表示スタイルを表すStyle要素 ×
RouteInfo 経路の情報を表すRouteInfo要素 ×

出力例

JSON(JSONP)
"Feature":[{"Id":"c9663446e499890051040b9c7cfbaf29",
 "Name":"\u6771\u4eac\u30df\u30c3\u30c9\u30bf\u30a6\u30f3",
 "Category":"\u5546\u696d\u65bd\u8a2d",
 "Geometry":{"Type":"point","Coordinates":"139.7308854869,35.665615661963"},
 "Property":{"Address":"\u6771\u4eac\u90fd\u6e2f\u533a\u8d64\u57429-7-1\u4ed6",
  "Tel1":"03-0000-0000"}}]

XML
<Feature>

 <Id>c9663446e499890051040b9c7cfbaf29</Id>
 <Name>東京ミッドタウン</Name>
 <Category>商業施設</Category>
 <Geometry>

  <Type>point</Type>
  <Coordinates>139.7308854869,35.665615661963</Coordinates>
 </Geometry>
 <Property>
  <Address>東京都港区赤坂9-7-1他</Address>

  <Tel1>03-0000-0000</Tel1>
 </Property>
</Feature>



Description

拠点の説明を表す要素です。住所、電話番号、画像を合わせたHTMLで表現することも可能です。
HTMLをXML形式で出力する場合は、CDATAにします。
スクロール地図の吹き出しや検索結果リストで、最低限表示したい項目を設定することを推奨します。




Geometry

拠点の場所を表す要素です。点だけでなく線や多角形でも指定できます。
Targetがある場合は、指定されたIdを持つDictionary要素内のGeometryへの参照となります。

子要素名 説明 備考
Id 要素を特定するための識別子  
Target 参照するGeometry要素の識別子  
Type 図形種別 point、linestring、polygon、circle、ellipse、multigeometryのいずれかを指定します。
Coordinates 座標 「経度,緯度」形式の十進度で指定します。複数ある場合はスペース(0x20)で区切ります。
BoundingBox 表示範囲 図形を囲う矩形領域の左下座標と右上座標をスペースで区切って、「経度,緯度」形式の十進度で指定します。
Compress 圧縮座標 座標データが非常に多い場合、圧縮して指定します。
CompressType 圧縮仕様 Compress要素の圧縮仕様を指定します。
Datum 座標測地系 wgs、tkyのいずれかで指定します。
Exterior polygonの外側座標 子要素に1個のCoordinatesを持ちます。
Interior polygonの内側座標 子要素に1個のCoordinatesを持ちます。
Radius 半径(メートル) 図形種別がcircleの場合は1個、ellipseの場合は「横半径,縦半径」形式で指定します。
GeodesicFlag 測地系の有無 Geometryがpolylineの場合、測地系を考慮した線かどうかを表します。trueまたはfalseで指定します。
Distance 距離(キロメートル) Geometryがpolylineの場合、始点から終点までの距離をkm単位で表します。
  • 図形種別がmultigeometryの場合は、子要素として複数のGeometryを指定して、図形をグループ化できます。multigeometryのCoordinatesは指定できません。
  • 図形種別がpolygonの場合、ExteriorとInteriorを使って、穴あきの図形を表現できます。外側座標だけの場合は、Coordinatesだけの指定も可能です。
  • 測地系が、wgs(デフォルト)の場合は、Coordinates、BoundingBox、Compressの座標は世界測地系データとなります。tkyの場合は、日本測地系データです。
図形種別 Type要素 Coordinates XML type属性
linestring linestring
多角形 polygon polygon
point point
circle
楕円 ellipse

出力例

JSON(JSONP)
"Geometry":{"Type":"linestring","Coordinates":"139.69902,35.53503 139.69899,35.53531 139.69903,35.5356"}

XML
<Geometry>
 <Type>linestring</Type>
 <Coordinates format="dec" order="lon,lat" type="linestring">139.69902,35.53503 139.69899,35.53531 139.69903,35.5356</Coordinates>
</Geometry>



Property

拠点のもつ各種データを表す要素で、データ名と値が一対となったデータ形式または一つのデータ名に対し値が複数含まれる配列形式となります。Targetがある場合は、指定されたIdを持つDictionary要素内の同じデータ名のProperty要素への参照となります。

出力例

XML
<Property>
  <Uid>8b8b8989f11b1990c66a7a042ddde5d2</Uid>
  <CassetteId>d8a23e9e64a4c817227ab09858bc1330</CassetteId>
  <Yomi>ツクバエクスプレスミナミセンジュエキ</Yomi>
  <Address>東京都荒川区南千住4丁目4−1</Address>
  <GovernmentCode>13118</GovernmentCode>
  <Tel1>03-3806-5222</Tel1>
  <CatchCopy></CatchCopy>
  <ReviewCount></ReviewCount>
  <Rating></Rating>
</Property>


Property - 子要素名について

Property要素には、さまざまな名称の要素を出力できますが、住所や電話番号など多くのWeb APIで持っていると思われる要素については、要素名を統一させてください。
共通化することによりYDFを解釈するAPIの処理も共通化させることができます。

子要素名 説明 備考
Uid ユニークID 拠点に紐づくユニークなIDです。
Yomi 名前の読み 拠点名称の読み方(カタカナ)です。
Country 国データ 詳細は、「国データの出力について」を参照してください。
Address 住所 住所文字列です。
AddressElement 住所構造データ 詳細は、「住所構造データの出力について」を参照してください。
Genre ジャンルデータ 詳細は、「ジャンルデータの出力について」を参照してください。
Station 駅データ 詳細は、「駅データの出力について」を参照してください。
Tel[1-1000] 電話番号 一つだけの場合、要素名は Tel1 となります。複数ある場合は、Tel2、Tel3・・・のように連番で続きます。
CatchCopy キャッチコピー 拠点の説明を短い文字列で説明します。
Price 値段 拠点に紐づく代表的な値段です。宿泊料金やメニュー料金などを整数型で指定します。
AveragePriceComment 平均予算 拠点に紐づく平均予算です。(例:10,000円)
LeadImage 代表画像 拠点の代表画像です。
CreditcardFlag クレジットカード利用可否 拠点(お店など)での支払時にクレジットカードが使えるかどうかをTrue(可)、False(不可)で指定します。
ParkingFlag 駐車場の有無 拠点(お店など)に駐車場が併設されているかどうかをTrue(有)、False(無)で指定します。
StampFlag スタンプの有無 拠点(お店など)がYahoo!ロコ プレイスのスタンプに対応しているかどうかをTrue(有)、False(無)で指定します。
CouponFlag クーポンの有無 拠点(お店など)のクーポン有無をTrue(有)、False(無)で指定します。
Coupon クーポンデータ 詳細は、「クーポンデータの出力について」を参照してください。
Push プッシュデータ 詳細は、「プッシュデータの出力について」を参照してください。
Ppc コール課金用電話番号 コール課金用の電話番号です。
PpcDescription コール課金用電話番号補足説明 コール課金用の電話番号の説明文字列です。
GovernmentCode 行政コード 最も詳細なレベルの行政コードです。部分住所レベルごとの行政コードは、AddressElementを利用します。
Access[1-1000] アクセス方法 文字列による説明です。(例:本庄駅北口から徒歩15分 本庄東高校そば)
Rating 評価 5点満点評価です。(例:3.3)
ReviewCount 投稿数 評価(Rating)の基となるデータ件数です。
PublishStart 掲載開始日 YYYY-MM-DD形式で指定します。(例:2010-01-01)
PublishEnd 掲載終了日 YYYY-MM-DD形式で指定します。(例:2010-01-11)
EventStart イベント開始日 YYYY-MM-DD形式で指定します。(例:2010-01-09)
EventEnd イベント終了日 YYYY-MM-DD形式で指定します。(例:2010-01-11)
BusinessOpen 営業開始時間 24H:mm形式で指定します。(例:10:30)
BusinessClose 営業終了時間 24H:mm形式で指定します。(例:21:00)
MondayBusinessHour 月曜日の営業時間 月曜日の開店時間/閉店時間です。hh:mm/hh:mm、hh:mm/hh:mm,hh:mm/hh:mm形式で指定します。(例:10:00/18:00)
TuesdayBusinessHour 火曜日の営業時間 火曜日の開店時間/閉店時間です。hh:mm/hh:mm、hh:mm/hh:mm,hh:mm/hh:mm形式で指定します。(例:10:00/18:00)
WednesdayBusinessHour 水曜日の営業時間 水曜日の開店時間/閉店時間です。hh:mm/hh:mm、hh:mm/hh:mm,hh:mm/hh:mm形式で指定します。(例:10:00/18:00)
ThursdayBusinessHour 木曜日の営業時間 木曜日の開店時間/閉店時間です。hh:mm/hh:mm、hh:mm/hh:mm,hh:mm/hh:mm形式で指定します。(例:10:00/18:00)
FridayBusinessHour 金曜日の営業時間 金曜日の開店時間/閉店時間です。hh:mm/hh:mm、hh:mm/hh:mm,hh:mm/hh:mm形式で指定します。(例:10:00/18:00)
SaturdayBusinessHour 土曜日の営業時間 土曜日の開店時間/閉店時間です。hh:mm/hh:mm、hh:mm/hh:mm,hh:mm/hh:mm形式で指定します。(例:10:00/18:00)
SundayBusinessHour 日曜日の営業時間 日曜日の開店時間/閉店時間です。hh:mm/hh:mm、hh:mm/hh:mm,hh:mm/hh:mm形式で指定します。(例:10:00/18:00)
HolidayBusinessHour 祝日の営業時間 祝日の開店時間/閉店時間です。hh:mm/hh:mm、hh:mm/hh:mm,hh:mm/hh:mm形式で指定します。(例:10:00/18:00)
DayBeforeHolidayBusinessHour 祝前日の営業時間 祝前日の開店時間/閉店時間です。hh:mm/hh:mm、hh:mm/hh:mm,hh:mm/hh:mm形式で指定します。(例:10:00/18:00)
Holiday 休日 文字列で指定します。(例:木曜定休日)
CreateDate 作成日時 YYYY-MM-DD 24H:mm形式で指定します。(例:2009-12-11 14:30)
UpdateDate 更新日時 YYYY-MM-DD 24H:mm形式で指定します。(例:2010-02-11 18:43)
CassetteId カセットID カセットIDは、YOLPカセットギャラリーで各カセットの詳細情報ページに記載されています。
CassetteOwner カセットオーナー カセットの提供者名です。
CassetteHeader カセットヘッダー カセットのヘッダー情報です。
CassetteFooter カセットフッター カセットのフッター情報です。
CassetteOwnerUrl カセットオーナーURL  カセット提供者のページURLです。
AdultFlag アダルトフラグ アダルト情報の有無をTrue(有)、False(無)で指定します。
LandmarkCode ランドマークコード 拠点のランドマークコードです。
StorageUrl 詳細なデータがある位置のURL  
Detail 拠点詳細データ 詳細は、「拠点詳細データの出力について」を参照してください。


Property - 国データの出力について

国コードと国名をセットで持ちます。

子要素名 説明 備考
Code 国コード
Name 国名

出力例

XML
<Country>
  <Code>JP</Code>
  <Name>日本</Name>
</Country>


Property - 住所構造データの出力について

住所を1行で表す場合は、Property/Address要素を使用しますが、町字だけを表示させる等、拠点住所を都道府県や市区町村などで分割して表現する場合は、Property/AddressElement要素を使用します。
AddressElementは、以下の子要素を持ち、住所レベルごとの行政コードなども保持させることができます。

子要素名 説明 必須 備考
Code 行政コード   部分住所のレベルごとに、けた数が異なります。
Name 住所文字列  
Kana 住所読み仮名   azaレベルまで
WoeID Where On Earth ID   詳細は、「Yahoo! GeoPlanet(英語)(外部サイト)」を参照してください。
Level 住所レベル   ※下記を参照してください。

※住所レベルは、国ごとに異なります。日本の場合は下表の通りです。住所レベルが、Accuracy要素に出力されている場合は、住所データの精度を表します。

<Property>
 <Address>神奈川県横浜市青葉区藤が丘2丁目1-1</Address>
 <Accuracy>detail2</Accuracy>
 <GovernmentCode>14117</GovernmentCode>

 <Country>
  <Code>JP</Code>
  <Name>日本</Name>
 </Country>
 <AddressElement>

  <Level>prefecture</Level>
  <Code>14</Code>
  <Name>神奈川県</Name>
  <Kana>かながわけん</Kana>

 </AddressElement>
 <AddressElement>
  <Level>city</Level>
  <Code>14117</Code>
  <Name>横浜市青葉区</Name>

  <Kana>よこはましあおばく</Kana>
 </AddressElement>
 <AddressElement>
  <Level>oaza</Level>

  <Name>藤が丘</Name>
  <Kana>ふじがおか</Kana>
 </AddressElement>
 <AddressElement>
  <Level>aza</Level>

  <Name>2丁目</Name>
  <Kana>2ちょうめ</Kana>
 </AddressElement>

 <AddressElement>
  <Level>detail1</Level>
  <Name>1</Name>

 </AddressElement>
 <AddressElement>
  <Level>detail2</Level>
  <Name>1</Name>

 </AddressElement>
</Property>
住所レベル 説明 例1:東京都港区赤坂9丁目7-1 例2:福岡県福岡市博多区中洲3丁目1-180 例3:北海道池田町(中川郡)東二条2-252
prefecture 都道府県(行政コード2けた) 東京都 福岡県 北海道
city 市区町村(行政コード5けた) 港区 福岡市博多区 池田町(中川郡)
major_city 政令指定都市の市部(行政コード5けた、下2けたは00)   福岡市  
ward 政令指定都市の区(行政コード5けた、cityと同じ)   博多区 池田町
county 郡名(行政コードなし)     中川郡
oaza 大字(行政コードなし) 赤坂 中洲 東二条
aza 字(行政コードなし) 9丁目 3丁目  
detail1 番地以降(行政コードなし)
※detailは、連番で複数設定可能です。
7 1 2
detail2 1 180 252

出力例

JSON(JSONP)
"Property":{
 "Address":"\u795e\u5948\u5ddd\u770c\u6a2a\u6d5c\u5e02\u9752\u8449\u533a\u85e4\u304c\u4e182\u4e01\u76ee1-1",
 "Accuracy":"detail2",
 "GovernmentCode":"14117",
 "Country":{"Code":"JP", "Name":"\u65e5\u672c"},
 "AddressElement":[
  {"Code":"14", "Name":"\u795e\u5948\u5ddd\u770c",
  	"Kana":"\u304b\u306a\u304c\u308f\u3051\u3093", "Level":"prefecture"},
  {"Code":"14117", "Name":"\u6a2a\u6d5c\u5e02\u9752\u8449\u533a",
  	"Kana":"\u3088\u3053\u306f\u307e\u3057\u3042\u304a\u3070\u304f", "Level":"city"},
  {"Code":"", "Name":"\u85e4\u304c\u4e18",
  	"Kana":"\u3075\u3058\u304c\u304a\u304b", "Level":"oaza"},
  {"Code":"", "Name":"2\u4e01\u76ee",
  	"Kana":"2\u3061\u3087\u3046\u3081", "Level":"aza"},
  {"Code":"", "Name":"1", "Kana":"1", "Level":"detail1"},
  {"Code":"", "Name":"1", "Kana":"1", "Level":"detail2"}]
 }

XML(政令指定都市の市と区を分割した場合。分割するかどうかは、パラメータ制御する等、各API仕様に依存)
<Property>

 <AddressElement>
  <Level>prefecture</Level>
  <Code>14</Code>
  <Name>神奈川県</Name>

  <Kana>かながわけん</Kana>
 </AddressElement>
 <AddressElement>
  <Level>major_city</Level>
  <Code>14100</Code>

  <Name>横浜市</Name>
  <Kana>よこはまし</Kana>
 </AddressElement>
 <AddressElement>
  <Level>ward</Level>

  <Code>14117</Code>
  <Name>青葉区</Name>
  <Kana>あおばく</Kana>
 </AddressElement>

 <AddressElement>
  <Level>oaza</Level>
  <Name>藤が丘</Name>

  <Kana>ふじがおか</Kana>
 </AddressElement>
 <AddressElement>
  <Level>aza</Level>

  <Name>2丁目</Name>
  <Kana>2ちょうめ</Kana>
 </AddressElement>
</Property>


Property - ジャンルデータの出力について

拠点の業種(駅、飲食店、公園など)を扱います。ジャンルタイプを指定して、Yahoo!ロコの業種、オリジナルの業種など様々なタイプの業種データを保持できます。

子要素名 説明 備考
Name ジャンル名 業種名を文字列で指定します。(例:駅、飲食店、公園)
Level ジャンルレベル 業種が階層構造になっている場合はレベルを指定します。
Code ジャンルコード 業種のコードを整数型で指定します。
Type ジャンルタイプ 業種のタイプを指定します。(例:loco)

出力例

XML
<Genre>
  <Name>和風居酒屋</Name>
  <Level>3</Lavel>
  <Code>0110001</Code>
  <Type>loco</Type>
</Genre>


Property - 駅データの出力について

駅関連の情報です。

子要素名 説明 備考
Id 駅ID
SubId 駅サブID
Name 駅名
StaitionHiragana 駅名読み(ひらがな)
ExitId 駅出口ID
Exit 駅出口
ExitName 駅出口名称
Railway 路線名
Distance 距離 駅までの距離を指定します。
Time 時間(分) 駅までの時間(分)を指定します。
StationComment 駅備考

出力例

XML
<Station>
  <Id>2299501</Id>
  <Name>南千住</Name>
  <Railway></Railway>
  <Exit>TX西口</Exit>
  <ExitviewId></ExitviewId>
  <Distance>151</Distance>
  <Time></Time>
</Station>


Property - クーポンデータの出力について

お店のクーポン情報です。

子要素名 説明 備考
Name クーポン名 クーポンのタイトル文字列です。
Comment クーポン内容 クーポンの詳細情報です。
Setting クーポン設定 クーポンの利用期間を設定します。1(自動更新)または2(期間を指定)を指定します。
StartDay クーポン開始日 YYYY-MM-DD形式で指定します。(例:2012-01-01)
EndDay クーポン終了日 YYYY-MM-DD形式で指定します。(例:2012-03-31)
MobileFlag クーポンモバイルフラグ True(モバイルで表示)、False(モバイルで非表示)を指定します。
OtherMediaFlag 他媒体のクーポンプラグ True(他の媒体で表示)、False(他の媒体で非表示)を指定します。
ParentPcUrl クーポン一覧URL(PC) クーポンが複数ある場合、複数クーポンの一覧ページのURL(PC向け)を指定します。
ParentSmartPhoneUrl クーポン一覧URL(スマートフォン) クーポンが複数ある場合、複数クーポンの一覧ページのURL(スマートフォン向け)を指定します。
ParentMobileUrl クーポン一覧URL(モバイル) クーポンが複数ある場合、複数クーポンの一覧ページのURL(モバイル向け)を指定します。

出力例

XML
<Coupon>
  <Name>結婚式二次会☆新郎・新婦無料</Name>
  <Comment>他券併用不可</Comment>
  <Setting>2</Setting>
  <StartDay>2012-01-01</StartDay>
  <EndDay>2012-03-31</EndDay>
  <MobileFlag>True</MobileFlag>
  <OtherMediaFlag>False</OtherMediaFlag>
  <ParentPcUrl>http://locoplace.jp/</ParentPcUrl>
  <ParentMobileUrl>http://m.locoplace.jp/</ParentMobileUrl>
</Coupon>


Property - プッシュデータの出力について

お店からのプッシュ配信情報です。

子要素名 説明 備考
Id プッシュID
Title プッシュタイトル プッシュ配信情報のタイトル文字列です。
Description プッシュ本文 プッシュ配信情報の詳細ないようです。
Image[1-1000] プッシュ画像 画像のパスを指定します。
ImageFlag プッシュ画像有無 True(あり)または False(なし)または(Null)が入ります。
UpdateDate プッシュ更新日付 YYYY-MM-DD形式で指定します。(例:2011-03-31)

出力例

XML
<Push>
  <Id>7c30a04e9e574bfefc5d1cf2f2f7d2ds</Id>
  <Title>忘・新年会・各種宴会・結婚式二次会ご予約承り中♪</Title>
  <Description>忘年会のご予約はお早めに!!(12月・団体様最大70名様迄の個室平日空きあり)</Description>
  <Image1></Image1>
  <UpdateDate>2011-11-16</UpdateDate>
</Push>



Property - 拠点詳細データの出力について

拠点詳細データは、Property/Detail要素を使用します。Detail要素は多くの子要素を持ちます。Detail要素にはそのまま表示で使えるように編集済みのテキストを入れます。ただし、要素名がFlagで終わるものについては True、False、Null のいずれかの値をとり、主に分類用タグ用途として使います。Detail要素のみで拠点詳細ページが構成できるよう、Property以下にある住所や交通アクセスなどの項目も重複して持っています。以下にDetailの子要素の例を示します。

子要素名 説明 備考
BusinessHour 営業時間 文字列で指定します。(例:月火水金土 9:00~18:00、日・祝 9:00~12:00)
Fax[1-1000] FAX番号 一つだけの場合、要素名は Fax1 となります。複数ある場合は、Fax2、Fax3・・・のように連番で続きます。
ZipCode 郵便番号  
DisplayAddress 住所 文字列で指定します。
Payment 支払い方法 文字列による説明です。(例:クレジットカードOK、VISA、MASTER)
KaraokeFlag カラオケがあるお店 True(あり)または False(なし)または(Null)が入ります。

出力例

JSON(JSONP)
"Property":{
 "Address":"\u6771\u4eac\u90fd \u6e2f\u533a \u516d\u672c\u672810-14-7",
 "Tel1":"03-1234-5678",
 "Detail":[
  {"DisplayAddress":"\u6771\u4eac\u90fd\u6e2f\u533a\u516d\u672c\u672810-14-7",
   "Fax1":"03-1234-5679",
   "KaraokeFlag":"True"}]
}

XML
<Property>
 <Address>東京都 港区 六本木10-14-7</Address>
 <Tel1>03-1234-5678</Tel1>

 <Detail>
  <DisplayAddress>東京都港区六本木10-14-7</DisplayAddress>
  <Fax1>03-1234-5679</Fax1>
  <KaraokeFlag>True</KaraokeFlag>
</Property>



Style

拠点を可視化する表示形式を表す要素です。アイコンと線および塗りつぶしで指定されます。
Targetがある場合は、指定されたIdを持つDictionary要素内のStyleへの参照となります。

子要素名 説明 備考
Id 要素を特定するための識別子  
Target 参照するStyle要素の識別子  
Type 種別 icon、line、fillのいずれかを指定します。
Image アイコン画像 iconの場合、アイコンとして使用する画像URLを指定します。
Size サイズ アイコン画像のサイズまたは線幅をピクセル値で指定します。iconの場合、コンマ区切りで横幅と縦幅を指定可能です。
Anchor 表示位置 アイコン画像左上を基点とする表示位置です。コンマ区切りで横方向と縦方向の差分をピクセル値で指定します。
Opacity 透過度 パーセントで指定します。
Color RGBの16進表記で指定
EndLine 終点スタイル 図形種別linestringの場合、arrow(矢印)を指定可能です。
StartLine 始点スタイル 図形種別linestringの場合、arrow(矢印)を指定可能です。

出力例

JSON(JSONP)
"Feature" : [
 {"Id" : "202700017827d1ec626c891d4b61a15c9dff296e",
  "Name" : "\u30b6\u30fb\u30ea\u30c3\u30c4\u30fb\u30ab\u30fc\u30eb\u30c8\u30f3\u6771\u4eac",
  "Geometry" : { "Type" : "point", "Coordinates" : "139.73123376272,35.666201166237" },
  "Style" : {"Target" : "iconHotel"}
 },
 {"Id" : "4b56689569652c3a01b59b4409157b76",
  "Name" : "\u30bb\u30d6\u30f3-\u30a4\u30ec\u30d6\u30f3\u6771\u4eac\u30df\u30c3\u30c9\u30bf\u30a6\u30f3\u5e97",
  "Geometry" : { "Type" : "point", "Coordinates" : "139.73126879797,35.665232102265" },
      "Style" : {"Type":"icon","Image":"http:\/\/i.yimg.jp\/i\/icon\/maps.gif"}
 }
],
"Dictionary":{
 "Style":[{"Id":"iconHotel","Type":"icon","Image":"http:\/\/i.yimg.jp\/i\/icon\/travel.gif"},
 {"Id":"transYellowPoly","Type":"fill","Opacity":49,"Color":"ffff00"}]
}

XML
<Feature>
 <Id>48cc6af179bba4c837cae3ba6cb2a53e</Id>

 <Name>ザ・リッツ・カールトン東京</Name>
 <Geometry>
  <Type>point</Type>
  <Coordinates>139.73053395334,35.665738140732</Coordinates>

 </Geometry>
 <Style>
  <Target>iconHotel</Target>
 </Style>
</Feature>
<Feature>

 <Id>4b56689569652c3a01b59b4409157b76</Id>
 <Name>セブン-イレブン東京ミッドタウン店</Name>
 <Geometry>
  <Type>point</Type>

  <Coordinates>139.73126879797,35.665232102265</Coordinates>
 </Geometry>
 <Style>
  <Type>icon</Type>
  <Image>http://i.yimg.jp/i/icon/maps.gif</Image>

 </Style>
</Feature>
<Dictionary>
 <Style>
  <Id>iconHotel</Id>
  <Type>icon</Type>

  <Image>http://i.yimg.jp/i/icon/travel.gif</Image>
 </Style>
 <Style>
  <Id>transYellowPoly</Id>
  <Type>fill</Type>

  <Opacity>49</Opacity>
  <Color>ffff00</Color>
 </Style>
</Dictionary>



RouteInfo

ルート検索結果の経路詳細情報を含める要素です。

子要素名 説明
Edge 経路のリンクデータを表すEdge要素
Property 経路の各種データを表すProperty要素



Edge

ルート検索結果の経路を構成するリンクデータを含める要素です。

子要素名 説明
Id 要素を特定するための識別子
Vertex リンクを構成する拠点を表すVertex要素
Property 経路の各種データを表すProperty要素

出力例

JSON(JSONP)
"RouteInfo":{
 "Edge":[
  {
   "Vertex":[{"Type":"Start","Property":{"Station":{"Target":"23049"}}},
    {"Type":"End","Property":{"Station":{"Target":"22855"}}}],
   "Property":{"Distance":42,
    "Railname":"\u6771\u4eac\u30e1\u30c8\u30ed\u65e5\u6bd4\u8c37\u7dda"}
  },
  {
   "Vertex":[{"Type":"Start","Property":{"Station":{"Target":"22855"}}},
    {"Type":"End","Property":{"Station":{"Target":"23368"}}}],
   "Property":{"Distance":220,
    "Railname":"\u6771\u6025\u6771\u6a2a\u7dda"}
  }
 ]
}

XML
<RouteInfo>

 <Edge>
  <Vertex>
   <Type>Start</Type>
   <Property>
    <Station><Target>23049</Target></Station>

   </Property>
  </Vertex>
  <Vertex>
   <Type>End</Type>
   <Property>

    <Station><Target>22855</Target></Station>
   </Property>
  </Vertex>
  <Property>
   <Distance>42</Distance>

   <Railname>東京メトロ日比谷線</Railname>
  </Property>
 </Edge>
 <Edge>
  <Vertex>

   <Type>Start</Type>
   <Property>
    <Station><Target>22855</Target></Station>
   </Property>

  </Vertex>
  <Vertex>
   <Type>End</Type>
   <Property>
    <Station><Target>23368</Target></Station>

   </Property>
  </Vertex>
  <Property>
   <Distance>220</Distance>
   <Railname>東急東横線</Railname>

  </Property>
 </Edge>
</RouteInfo>



Vertex

ルート検索結果の経路のリンクデータを構成する拠点データを含める要素です。

子要素名 説明
Type 拠点種別。StartまたはEnd
Station 駅情報(拠点が駅の場合のみ)
Property 拠点の各種データを表すProperty要素

出力例

JSON(JSONP)
"Vertex":[
 {"Type":"Start","Property":{"Station":{"Name":"\u4e2d\u76ee\u9ed2","Code":"22855"}}},
 {"Type":"End","Property":{"Station":{"Name":"\u6a2a\u6d5c","Code":"23368"}}}
 ]

XML
<Vertex>
 <Type>Start</Type>
 <Property>
  <Station>

   <Name>中目黒</Name>
   <Code>22855</Code>
  </Station>
 </Property>
</Vertex>

<Vertex>
 <Type>End</Type>
 </Property>
  <Station>
   <Name>横浜</Name>

   <Code>23368</Code>
  </Station>
 </Property>
</Vertex>



Dictionary

複数の項目間で共有できる情報を収める要素です。Dictionary内に収めた情報にはIdを必ず設定して、参照するFeature側で、Targetで共有する情報のIdを指定します。
要素名は特に規定されず、Propertyで使用する要素でも使用できます。

出力例

JSON(JSONP)
"Feature":{
 "Name":"\u65b0\u5343\u6b73\u7a7a\u6e2f\u2192\u90a3\u8987\u7a7a\u6e2f",
 "Property":{
  "Departure":{"Name":"\u51fa\u767a\u5730","Airport":{"Target":"23049"}},
  "Arrival":{"Name":"\u5230\u7740\u5730","Airport":{"Target":"23368"}}
 }
},
"Dictionary":{
 "Airport":[
  {"Id":"20274","Name":"\u65b0\u5343\u6b73\u7a7a\u6e2f",
   "Geometry":{"Type":"point","Coordinates":"141.68157440272,42.787486840531"}},
  {"Id":"22827","Name":"\u6771\u4eac\u56fd\u969b\u7a7a\u6e2f\uff08\u7fbd\u7530\u7a7a\u6e2f\uff09",
   "Geometry":{"Type":"point","Coordinates":"139.78452839866,35.54903787508"}},
  {"Id":"29031","Name":"\u90a3\u8987\u7a7a\u6e2f",
   "Geometry":{"Type":"point","Coordinates":"127.65175562506,26.206420381123"}}
 ]
}

XML
<Feature>
 <Name>新千歳空港→那覇空港</Name>

 <Property>
  <Departure>
   <Name>出発地</Name>
   <Airport>
    <Target>23049</Target>

   </Airport>
  </Departure>
  <Arrival>
   <Name>到着地</Name>
   <Airport>

    <Target>23368</Target>
   </Airport>
  </Arrival>
 </Property>
</Feature>
<Dictionary>

 <Airport>
  <Id>20274</Id>
  <Name>新千歳空港</Name>
  <Geometry>
   <Type>point</Type>

   <Coordinates>141.68157440272,42.787486840531</Coordinates>
  </Geometry>
 </Airport>
 <Airport>
  <Id>22827</Id>

  <Name>東京国際空港(羽田空港)</Name>
  <Geometry>
   <Type>point</Type>
   <Coordinates>139.78452839866,35.54903787508</Coordinates>

  </Geometry>
 </Airport>
 <Airport>
  <Id>29031</Id>
  <Name>那覇空港</Name>

  <Geometry>
   <Type>point</Type>
   <Coordinates>127.65175562506,26.206420381123</Coordinates>
  </Geometry>
 </Airport>

</Dictionary>



Error

エラー発生時のみ存在する要素です。エラーメッセージとエラーコードを設定します。

子要素名 説明
Message エラーメッセージ
Detail エラー詳細

※Error/Detailは、さらに子要素を持ち、エラーコードなどを設定可能。

子要素名 説明
Code エラーコード

出力例

JSON(JSONP)
"Error":{"Message":"Web API\u304c\u898b\u3064\u304b\u308a\u307e\u305b\u3093\u3002",
	"Detail":{"Code":404}}

XML
<Error>
 <Message>Web APIが見つかりません。</Message>
  <Detail>
   <Code>404</Code>

  </Detail>
</Error>