コンテンツジオコーダAPI

リクエストURL

目次

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

---

概要

コンテンツジオコーダAPIは、場所を表すキーワードを検出し、その位置情報（緯度、経度など）を出力します。

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

本APIは、GETメソッドのみサポートしています。「Web APIの使い方#GETとは」をご参照ください。

パラメータ	値	説明
appid （必須）	string	Client ID（アプリケーションID）。詳細はこちらをご覧ください。
query (必須）	string（最大2000バイト）	（UTF-8でエンコードされた）地名を含む検索クエリーです。
ei	string UTF-8（デフォルト）, EUC-JP, SJIS	入力検索文字列のエンコード形式： UTF-8 - UTF-8形式 EUC-JP - EUC-JP形式 SJIS - SJIS形式
category	string address（デフォルト）, landmark, world	検索対象カテゴリ： address - 住所 landmark - ランドマーク world - 世界
results	integer: 10（デフォルト）, 10（最大）	表示件数。
output	string xml（デフォルト）, json	出力形式： xml - XML形式 json - JSON形式
callback	string	JSONPとして出力する際のコールバック関数名を入力するためのパラメータ。UTF-8でエンコードした文字列を入力する。

サンプルリクエストURL

https://map.yahooapis.jp/geocode/cont/V1/contentsGeoCoder?appid=＜あなたのClient ID（アプリケーションID）＞&query=%E5%85%AD%E6%9C%AC%E6%9C%A8&category=address

レスポンスフィールド

フィールド	説明
YDF	クエリーレスポンスのすべてを含みます。
ResultInfo	レスポンスのまとめ情報です。
Count	レスポンス情報に含まれる住所情報のデータ件数です。
Total	出力されている住所情報以外も含めた全データ件数です。
Start	レスポンス情報に含まれる住所情報の、全データからの取得開始位置です。
Latency	レスポンス情報を生成するのに要した時間です。
Status	リクエスト元に処理結果を伝えるためのコードです。 正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。
Description	APIの説明文です。
Feature	検索結果1件分のデータ群です。
Property	各種データを格納します。
Geometry	拠点の場所を表すGeometry要素です。
Type	図形種別です。
Coordinates	座標情報です。
Query	検索したクエリです。
Genre	ジャンルコードです。
Address	1行で表す住所です。
Address_Kana	1行で表す住所の読み仮名です。
AddressElement	部分住所情報です。
Level	住所レベル： prefecture - 都道府県 city - 市区町村 oaza - 大字 aza - 字
Name	部分住所です。
Kana	部分住所の読み仮名です。

サンプルレスポンス

以下は、「六本木」の住所カテゴリ検索のリクエストに対するレスポンスです。

<?xml version="1.0" encoding="UTF-8"?>
<YDF xmlns="http://olp.yahooapis.jp/ydf/1.0" firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1">
<ResultInfo>
<Count>1</Count>
<Total>1</Total>
<Start>1</Start>
<Latency>0.01</Latency>
<Status>200</Status>
<Description>文字列解析結果</Description>
<CompressType/>
</ResultInfo>
<Feature>
<Id>1</Id>
<Name>東京都港区六本木</Name>
<Description>東京都港区六本木</Description>
<Geometry>
<Type>point</Type>
<Coordinates>139.73359257419,35.662886299615</Coordinates>
</Geometry>
<Property>
<Genre>80</Genre>
<Query>六本木</Query>
<Address>東京都港区六本木</Address>
<AddressKana>とうきょうとみなとくろっぽんぎ</AddressKana>
<AddressElement>
<Name>東京都</Name>
<Kana>とうきょうと</Kana>
</AddressElement>
<AddressElement>
<Name>港区</Name>
<Kana>みなとく</Kana>
</AddressElement>
<AddressElement>
<Name>六本木</Name>
<Kana>ろっぽんぎ</Kana>
</AddressElement>
</Property>
</Feature>
</YDF>

エラー

コード	説明
400	渡されたパラメータがWeb APIで期待されたものと一致しない場合に返されます。
503	内部的な問題によってデータを返すことができない場合に返されます。

<YDF firstResultPosition="1" totalResultsAvailable="0" totalResultsReturned="0">
  <Error>
    <Message>URLパラメータが不正です</Message>
    <Code>400</Code>
  </Error>
</YDF>