YOLP(地図)

業種マスターAPI

リクエストURL
XML
http://category.search.olp.yahooapis.jp/OpenLocalPlatform/V1/genreCode
JSONP
http://category.search.olp.yahooapis.jp/OpenLocalPlatform/V1/genreCode

目次




概要

業種マスターAPIは、Yahoo! Open Local Platform(YOLP)で使用される業種コードを階層構造状に取得できます。
業種コードは、全3階層で構成されます。




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

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

パラメーター説明
appid
(必須)
string アプリケーションID。詳細はこちらをご覧ください。
gc
業種コード 取得したい業種コードを指定します。
未指定の場合は第1階層の業種コードを取得します。
results integer: 10(デフォルト) 表示件数。
output string
xml(デフォルト),
json
出力形式:
  • xml - XML形式
  • json - JSON形式
callback string
JSONPとして出力する際のコールバック関数名を入力するためのパラメーター。UTF-8でエンコードした文字列を入力する。

API使用上の注意

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

サンプルリクエストURL

業種コード「01(グルメ)」配下の業種情報を取得

http://category.search.olp.yahooapis.jp/OpenLocalPlatform/V1/genreCode?appid=<あなたのアプリケーションID>&gc=01 



レスポンス

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




レスポンスフィールド

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

フィールド 説明
YDF クエリーレスポンスのすべてを含みます。
ResultInfo レスポンスのまとめ情報です。
Count レスポンス情報に含まれる住所情報のデータ件数です。
Total 出力されている住所情報以外も含めた全データ件数です。
Start レスポンス情報に含まれる住所情報の、全データからの取得開始位置です。
Latency レスポンス情報を生成するのに要した時間です。
Status リクエスト元に処理結果を伝えるためのコードです。 正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。
Description APIの説明文です。
Copyright コピーライトです。
Feature 検索結果1件分のデータ群です。
Id 業種コードです。
Name 業種名です。
Property 各種データを格納します。
Genre 業種情報です。
Target(Genreの子要素) 業種情報の参照IDです。
Dictionary配下の業種情報を参照します。
Dictionary 共有情報です。
Genre 業種情報です。
Id(Genreの子要素) 業種情報の参照IDです。
Code(Genreの子要素) 業種コードです。
Name(Genreの子要素) 業種名です。
Level(Genreの子要素) 業種の階層です。



サンプルレスポンス

以下は、業種コード「0106(ラーメン)」のリクエストに対するレスポンスです。

XML形式

<?xml version="1.0" encoding="UTF-8"?>
<YDF firstResultPosition="1" totalResultsAvailable="2" totalResultsReturned="2" xmlns="http://olp.yahooapis.jp/ydf/1.0">
  <ResultInfo>
    <Count>2</Count>
    <Total>2</Total>
    <Start>1</Start>
    <Latency>0</Latency>
    <Status>200</Status>
    <Description>Yahoo! Japan Genre</Description>
    <Copyright>Copyright (C) 2011 Yahoo Japan Corporation. All Rights Reserved.</Copyright>
    <CompressType />
  </ResultInfo>
  <Feature>
    <Id>0106001</Id>
    <Name>ラーメン</Name>
    <Property>
      <Genre>
        <Target>0106001</Target>
      </Genre>
    </Property>
  </Feature>
  <Feature>
    <Id>0106002</Id>
    <Name>つけ麺</Name>
    <Property>
      <Genre>
        <Target>0106002</Target>
      </Genre>
    </Property>
  </Feature>
  <Dictionary>
    <Genre>
      <Id>01</Id>
      <Code>01</Code>
      <Name>グルメ</Name>
      <Level>1</Level>
    </Genre>
    <Genre>
      <Id>0106</Id>
      <Code>0106</Code>
      <Name>ラーメン</Name>
      <Level>2</Level>
    </Genre>
    <Genre>
      <Id>0106001</Id>
      <Code>0106001</Code>
      <Name>ラーメン</Name>
      <Level>3</Level>
    </Genre>
    <Genre>
      <Id>0106002</Id>
      <Code>0106002</Code>
      <Name>つけ麺</Name>
      <Level>3</Level>
    </Genre>
  </Dictionary>
</YDF>

JSON形式

{
  "ResultInfo":{
    "Count":2,
    "Total":2,
    "Start":1,
    "Latency":0,
    "Status":"200",
    "Description":"Yahoo! Japan Genre",
    "Copyright":"Copyright (C) 2011 Yahoo Japan Corporation. All Rights Reserved.",
    "CompressType":""
  },
  "Feature":[
    {
      "Id":"0106001",
      "Name":"\u30e9\u30fc\u30e1\u30f3",
      "Property":{
        "Genre":{
          "Target":"0106001"
        }
      }
    },
    {
      "Id":"0106002",
      "Name":"\u3064\u3051\u9eba",
      "Property":{
        "Genre":{
          "Target":"0106002"
        }
      }
    }
  ],
  "Dictionary":{
    "Genre":[
      {
        "Id":"01",
        "Code":"01",
        "Name":"\u30b0\u30eb\u30e1",
        "Level":1
      },
      {
        "Id":"0106",
        "Code":"0106",
        "Name":"\u30e9\u30fc\u30e1\u30f3",
        "Level":2
      },
      {
        "Id":"0106001",
        "Code":"0106001",
        "Name":"\u30e9\u30fc\u30e1\u30f3",
        "Level":3
      },
      {
        "Id":"0106002",
        "Code":"0106002",
        "Name":"\u3064\u3051\u9eba",
        "Level":3
      }
    ]
  }
}



エラー

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

<Error>
  <Message>業種IDが正しくありません。</Message>
  <Detail>
    <Code>400</Code>
  </Detail>
</Error>