ルート沿い検索API

リクエストURL

目次

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

概要

ルート情報から、その近辺の店舗・施設情報を返す機能を提供します。

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

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

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＞

レスポンスフィールド

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

こちらで定義されているレスポンスフィールドはデフォルトのものです。カセットごとに拡張されたレスポンスフィールドを持つ場合があります。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"]
       }
     }
   }]
}

エラー

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