YOLP（地図）
Yahoo!ジオコーダAPI
Version 1
リクエストURL
XML
http://geo.search.olp.yahooapis.jp/OpenLocalPlatform/V1/geoCoder
JSONP
http://geo.search.olp.yahooapis.jp/OpenLocalPlatform/V1/geoCoder
リクエストパラメータ一覧
「RESTリクエストの構築（GET）」をご参照ください。
| パラメータ | 値 | 説明 |
|---|---|---|
| appid（必須） | string | アプリケーションID。詳細はこちらをご覧ください。 |
| query | string | 住所文字列。 |
| ei | string | 入力検索文字列のエンコード形式：
|
| lat | float | 中心の緯度。 |
| lon | float | 中心の経度。 |
| bbox | float | 矩形範囲の左下経度、左下緯度、右上経度、右上緯度を世界測地系十進形式で指定（コンマ区切り）。 |
| datum | string | 指定した緯度経度の測地系：
|
| ac | string | 住所コード（JIS X 0401）です。 住所コードは都道府県（2桁）と市町村(5桁）を指定可能です。 ex) 北海道:01, 札幌市中央区:01101 |
| al | integer | 住所検索レベルです。arオプションと組み合わせて指定されたレベルの住所を検索します。
|
| ar | string | 住所レベルの範囲です。alオプションと組み合わせて指定されたレベルの住所を検索します。
|
| recursive | boolean | trueを指定すると、指定した住所レベルでマッチしなかった場合、上位のレベルで再検索を行います。 |
| sort | string | ソート順：
|
| start | integer | 表示開始位置（デフォルト: 1）。最終位置（start ＋ results － 1）は、100を超えられません。 |
| page | integer | ページ数の指定。startと同時に使用することはできません。 |
| results | integer | 表示件数（デフォルト: 10、最大：100）。 |
| output | string | 出力形式：
|
| callback | string |
JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力する。 |
| detail | string | 出力項目数を増減できます（デフォルト：standard）。 詳細はこちらをご覧ください。 |
API使用上の注意
URLの最大の長さは2048バイトです。
URLをエンコードして指定するパラメータもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。
サンプルリクエスト
東京都港区六本木の住所検索
http://geo.search.olp.yahooapis.jp/OpenLocalPlatform/V1/geoCoder?appid=<あなたのアプリケーションID>&query=%e6%9d%b1%e4%ba%ac%e9%83%bd%e6%b8%af%e5%8c%ba%e5%85%ad%e6%9c%ac%e6%9c%a8
レスポンスフィールド
ジオコーダAPIのスキーマの記述は、以下のURLをご覧ください。
http://olp.yahooapis.jp/OpenLocalPlatform/V1/YDF.xsd
| フィールド | 説明 |
|---|---|
| YDF | クエリーレスポンスのすべてを含みます。 |
| ResultInfo | レスポンスのまとめ情報です。 |
| Count | レスポンス情報に含まれる住所情報のデータ件数です。 |
| Total | 出力されている住所情報以外も含めた全データ件数です。 |
| Start | レスポンス情報に含まれる住所情報の、全データからの取得開始位置です。 |
| Status | リクエスト元に処理結果を伝えるためのコードです。正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。 |
| Description | APIの説明文です。 |
| Copyright | コピーライトです。 |
| Latency | レスポンス情報を生成するのに要した時間です。 |
| Feature | 検索結果1件分のデータ群です。 |
| Id | 住所IDです。 |
| Gid | グループIDです。 |
| Name | 地域・拠点情報名です。 |
| Geometry | 拠点の場所を表すGeometry要素です。 |
| Type | 図形種別です。 |
| Coordinates | 座標情報です。 |
| Property | 各種データを格納します。 |
| Uid | Yahoo! Open Local Platform（YOLP）内部での識別IDです。 |
| CassetteId | カセットIDです。 ※「b22fee69b0dcaf2c2fe2d6a27906dafc」固定。 |
| Yomi | 地域・拠点情報名の読み(カタカナ)です。 |
| Country | 国情報です。 |
| Code | 国コード（ISO 3166-1）です。 |
| Name | 国名です。 |
| Address | 1行であらわす住所です。 |
| AddressElement | 住所構造のデータ群です。 |
| Level | 住所構造のレベルです。 |
| GovernmentCode | 住所コード（JIS X 0402）です。 |
| AddressMatchingLevel | 住所レベルです。 |
| Detail | 詳細データを格納します。 |
| NameHiragana | 地域・拠点情報名の読み(ひらがな)です。 |
| Approximation | 住所とクエリーの一致度です。 |
エラー
| コード | 説明 |
|---|---|
| 400 | 渡されたパラメータがWeb APIで期待されたものと一致しない場合に返されます。 |
| 204 | 指定された場所の住所情報が見つからない場合に返されます。 |
以下は、リクエストに対するエラーレスポンスです。
