業種マスターAPI をリリースしました

はじめまして、R&D統括本部プラットフォーム開発本部西日本開発部に勤める格闘家の西です。

Yahoo!デベロッパーネットワークにて、業種マスターAPIを公開しましたので、ご紹介させていただきます。
業種マスターAPIとは、Yahoo! Open Local Platform（略称：YOLP）で使用される業種コードや業種名を階層構造状に取得できるAPIです。このAPIにより、Yahoo! JAPAN で利用されている業種名のリストを取得して表示できます。

さらに、業種マスターAPIは、YOLP ローカルサーチAPIと組み合わせたときに、その真価を発揮します。つまり、このAPIで取得できる業種コードを利用して、業種を絞り込んだ検索をYOLP ローカルサーチAPIで実現できます。

今回は業種マスターAPIからドイツ料理の業種コードを取得し、YOLPローカルサーチで検索するまでの利用例を説明します。

図. 利用例処理フロー概要

業種マスターAPIリクエスト例

以下の例で出てくる業種マスターAPIのリクエストパラメータの説明はこちら。
また、レスポンスフィールドの説明についてはこちらになります。
第１階層の業種を取得する例
リクエストパラメータにアプリケーションIDのみを指定してください。

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

レスポンスをみると、グルメの業種コードは01であることがわかります。

<Feature>
  <Id>01<Id>
  <Name>グルメ<Name>
  <Property>
    <Genre>
      <Target>01<Target>
    <Genre>
  <Property>
<Feature>

第２階層の業種一覧を取得する例
先ほど取得したグルメの業種コード(gc=01)以下にある業種一覧を取得するには
アプリケーションIDに加えて、業種コードを付与してください。

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

レスポンスをみると、洋食の業種コードは0102であることがわかります。

<Feature>
  <Id>0102<Id>
  <Name>洋食<Name>
  <Property>
    <Genre>
      <Target>0102<Target>
    <Genre>
  <Property>
<Feature>

第３階層の業種一覧を取得する例
さらに洋食の業種コード(gc=0102)以下にある業種一覧を取得するには以下のようになります。

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

レスポンスをみると、目的のドイツ料理の業種コードは0102010であることがわかります。
次にこちらの業種コードをローカルサーチAPIを使って検索してみたいと思います。

<Feature>
  <Id>0102010<Id>
  <Name>ドイツ料理<Name>
  <Property>
    <Genre>
      <Target>0102010<Target>
    <Genre>
  <Property>
<Feature>

業種コードを利用したローカルサーチAPIリクエスト例

以下の例で出てくるローカルサーチAPIのリクエストパラメータの説明はこちら。
また、レスポンスフィールドの説明についてはこちらになります。
リクエストパラメータにアプリケーションIDと先ほど取得したドイツ料理の業種コード(gc=0102010)を指定することによって、ドイツ料理の業種に絞った検索ができます。

http://search.olp.yahooapis.jp/OpenLocalPlatform/V1/localSearch?appid=＜あなたのアプリケーションID＞&gc=0102010

また、ローカルサーチAPIの緯度経度を指定した検索や、住所コードでの検索と組み合わせることも可能となっていますので、ジオコーダAPIで取得した緯度経度をもとに検索といった使い方もできます。

おわりに

今回紹介した業種コードAPIはローカルサーチAPIや他のAPIとマッシュアップすることによって可能性が広がります。ぜひ、こちらのAPIを利用してデベロッパー皆様のアプリケーションに役立てていただけたらと思います。

今後ともYahoo! Open Local Platformをよろしくお願いします。