施設内検索API

リクエストURL

目次

• 概要
• リクエストパラメーター一覧
• レスポンスフィールド
• サンプルレスポンス
• エラー

概要

建物の形状情報から、含まれる店舗・施設情報を返す機能を提供します。

リクエストパラメーター一覧

「RESTリクエストの構築（GET）」をご参照ください。

API使用上の注意

URLの最大の長さは2048バイトです。
URLエンコードを行って指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。

サンプルリクエストURL

緯度、経度を指定して施設内を検索

https://map.yahooapis.jp/inner/V1/building?lat=35.66619&lon=139.73008&appid=＜あなたのアプリケーションID＞

レスポンスフィールド

施設内検索APIのスキーマの記述は、以下のURLをご覧ください。
http://olp.yahooapis.jp/OpenLocalPlatform/V1/YDF.xsd

こちらで定義されているレスポンスフィールドはデフォルトのものです。カセットごとに拡張されたレスポンスフィールドを持つ場合があります。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>ＨＡＬ　ＹＡＭＡＳＨＩＴＡ　東京</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>東京都港区赤坂９－７－４　</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": "ＨＡＬ　ＹＡＭＡＳＨＩＴＡ　東京",
                "Geometry": {
                    "Type": "point",
                    "Coordinates": "139.73060691,35.666669041301"
                },
                "Category": "",
                "Description": "",
                "Style": "",
                "Property": {
                    "Uid": "d379f8bf338b48b15f108a2d7db94fe6fc7350d1",
                    "CassetteId": "f0a6bbe4fd136ad4cfb344b04c045ee7",
                    "Yomi": "ハルヤマシタトウキョウ",
                    "Country": {
                        "Code": "JP",
                        "Name": "日本"
                    },
                    "Address": "東京都港区赤坂９－７－４　",
                    "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",
                }
            ]
        ]
    }
}

エラー

<Error>
  <Message>パラメーターが不正です。</Message>
  <Detail>
    <Code>400</Code>
  </Detail>
</Error>