地図
コンテンツジオコーダ
Version 1
リクエストURL
XML
http://contents.search.olp.yahooapis.jp/OpenLocalPlatform/V1/contentsGeoCoder
JSONP
http://contents.search.olp.yahooapis.jp/OpenLocalPlatform/V1/contentsGeoCoder
コンテンツジオコーダAPIは、場所を表すキーワードを検出し、その位置情報(緯度、経度など)を出力します。
リクエストパラメータ一覧
「RESTリクエストの構築(GET)」をご参照ください。
| パラメータ | 値 | 説明 |
|---|---|---|
| appid (必須) |
string | アプリケーションID。詳細はこちらをご覧ください。 |
| query (必須) |
string(最大2000バイト) | 地名を含む検索クエリーです。 |
| ei | string EUC-JP, SJIS |
入力検索文字列のエンコード形式:
|
| category | string landmark, world |
検索対象カテゴリ:
|
| results | integer: 10(デフォルト), 10(最大) | 表示件数。 |
| output | string xml(デフォルト), json |
出力形式:
|
| callback | string |
JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力する。 |
サンプルリクエストURL
http://contents.search.olp.yahooapis.jp/OpenLocalPlatform/V1/contentsGeoCoder?レスポンスフィールド
コンテンツジオコーダAPIのスキーマの記述は、以下のURLをご覧ください。
http://olp.yahooapis.jp/OpenLocalPlatform/V1/YDF.xsd
| フィールド | 説明 |
|---|---|
| YDF | クエリーレスポンスのすべてを含みます。 |
| ResultInfo | レスポンスのまとめ情報です。 |
| Count | レスポンス情報に含まれる住所情報のデータ件数です。 |
| Total | 出力されている住所情報以外も含めた全データ件数です。 |
| Start | レスポンス情報に含まれる住所情報の、全データからの取得開始位置です。 |
| Latency | レスポンス情報を生成するのに要した時間です。 |
| Status | リクエスト元に処理結果を伝えるためのコードです。 正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。 |
| Description | APIの説明文です。 |
| Copyright | コピーライトです。 |
| Feature | 検索結果1件分のデータ群です。 |
| Property | 各種データを格納します。 |
| Geometry | 拠点の場所を表すGeometry要素です。 |
| Type | 図形種別です。 |
| Coordinates | 座標情報です。 |
| Query | 検索したクエリです。 |
| Genre | ジャンルコードです。 |
| Address | 1行で表す住所です。 |
| Address_Kana | 1行で表す住所の読み仮名です。 |
| AddressElement | 部分住所情報です。 |
| Level | 住所レベル:
|
| Name | 部分住所です。 |
| Kana | 部分住所の読み仮名です。 |
サンプルレスポンス
以下は、「六本木」の住所カテゴリ検索のリクエストに対するレスポンスです。エラー
| コード | 説明 |
|---|---|
| 400 | 渡されたパラメータがWeb APIで期待されたものと一致しない場合に返されます。 |
| 503 | 内部的な問題によってデータを返すことができない場合に返されます。 |