Yahoo!デベロッパーネットワーク - YOLP（地図）

概要

名称や緯度経度などの拠点情報をキーワードとして検索を行い、同一と思われる拠点のGID（店舗ID）を出力します。

GIDについて

Yahoo! JAPANで管理されている日本全国のお店に割り当てられた一意でユニークなIDです。

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

パラメータ	値	説明
appid（必須）	string	アプリケーションID。詳細はこちらをご覧ください。
name（必須）	string	拠点の名称（文字コードはUTF-8）。
lat（必須）	float	拠点の緯度（単位は度、測地系は世界測地系）。
lon（必須）	float	拠点の経度（単位は度、測地系は世界測地系）。
address	string	拠点の住所。
zip	string	拠点の郵便番号。数字と-（ハイフン）のみ指定可能。
phone	string	拠点の電話番号。数字と-（ハイフン）のみ指定可能。
output	string	出力形式。 xml：XML形式（デフォルト） json：JSON形式
callback	string	JSON（JSONP）として出力する際のコールバック関数名。

API使用上の注意

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

サンプルリクエストURL

東京ミッドタウンの検索
http://api.olp.yahooapis.jp/OpenLocalPlatform/V1/getGid?appid=<あなたのアプリケーションID>&name=%E6%9D%B1%E4%BA%AC%E3%83%9F%E3%83%83%E3%83%89%E3%82%BF%E3%82%A6%E3%83%B3&lat=35.6657214&lon=139.7310058&address=%E6%9D%B1%E4%BA%AC%E9%83%BD%E6%B8%AF%E5%8C%BA%E8%B5%A4%E5%9D%82%EF%BC%99%E4%B8%81%E7%9B%AE%EF%BC%97%EF%BC%8D%EF%BC%91

このページのトップへ

レスポンス

出力形式にXMLを指定（output=xml）した場合、XMLを返します。レスポンスフィールドをご参照ください。

レスポンスフィールド

店舗IDAPIのスキーマの記述は、以下のURLをご覧ください。
http://olp.yahooapis.jp/OpenLocalPlatform/V1/YDF.xsd

フィールド	説明
YDF	クエリーレスポンスのすべてを含みます。
ResultInfo	レスポンスのまとめ情報です。
Count	レスポンス情報に含まれる拠点情報のデータ件数です。
Total	出力されている拠点情報以外も含めた全データ件数です。
Start	レスポンス情報に含まれる拠点情報の、全データからの取得開始位置です。
Latency	レスポンス情報を生成するのに要した時間です。
Status	リクエスト元に処理結果を伝えるためのコードです。正常終了の場合、200を出力します。
Description	APIの説明文です。
Copyright	コピーライトです。
Feature	検索結果1件分のデータ群です。
Id	レンスポンスデータの連番です。
Gid	拠点の管理IDです。
Name	拠点の名称です。
Property	拠点の各種データを表すProperty要素です。
MatchingScore	検索結果の一致度を示す数値です。相対的な一致度に応じて1以下の値が割り当てられます。
Address	拠点の住所です。
Tel	拠点の電話番号です。
ZipCode	拠点の郵便番号です。
Geometry	拠点の場所を表すGeometry要素です。
Type	図形種別です。
Coordinates	座標情報です。

このページのトップへ

サンプルレスポンス

以下は、東京ミッドタウンの検索に対するレスポンスです。

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.061</Latency>
<Status>200</Status>
<Description></Description>
<Copyright>(C) Yahoo Japan Corporation.</Copyright>
</ResultInfo>
<Feature>
<Id>1</Id>
<Gid>ZQeSyUNHqY6</Gid>
<Name>東京ミッドタウン</Name>
<Property>
<MatchingScore>1</MatchingScore>
<Address>東京都港区赤坂９丁目７－１</Address>
<Tel />
<ZipCode />
</Property>
<Geometry>
<Type>point</Type>
<Coordinates>139.7310058,35.6657214</Coordinates>
</Geometry>
</Feature>
</YDF>

JSON形式

{
  "ResultInfo":{
    "Count":1,
    "Total":1,
    "Start":1,
    "Latency":"0.061",
    "Status":200,
    "Description":"",
    "Copyright":"(C) Yahoo Japan Corporation."
  },
  "Feature":[
    {
      "Id":"1",
      "Gid":"ZQeSyUNHqY6",
      "Name":"\u6771\u4eac\u30df\u30c3\u30c9\u30bf\u30a6\u30f3",
      "Property":{
        "MatchingScore":1,
        "Address":"\u6771\u4eac\u90fd\u6e2f\u533a\u8d64\u5742\uff19\u4e01\u76ee\uff17\uff0d\uff11",
        "Tel":"",
        "ZipCode":""
      }
      "Geometry":{
        "Type":"point",
        "Coordinates":"139.7310058,35.6657214"
      }
    }
  ]
}

このページのトップへ

エラー

コード	説明
400	渡されたパラメータがWeb APIで期待されたものと一致しない場合に返されます。

XML形式

<?xml version="1.0" encoding="UTF-8"?>
<Error>
<Message>パラメータが不正です。</Message>
<Detail>
<Code>400</Code>
</Detail>
</Error>

JSON形式

{
  "Error":{
    "Message":"\u30d1\u30e9\u30e1\u30fc\u30bf\u304c\u4e0d\u6b63\u3067\u3059\u3002",
    "Detail":{
      "Code":400
    }
  }
}

このページのトップへ

店舗名寄せAPI

リクエストURL

目次

概要

GIDについて

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

レスポンス

レスポンスフィールド

サンプルレスポンス

エラー

Web APIとその他のサービス

API

その他

スタッフブログ

開発者コミュニティ

開発のヒント

法人デベロッパー専用お問い合わせ