ヤフー株式会社は、2023年10月1日にLINEヤフー株式会社になりました。LINEヤフー株式会社の新しいブログはこちらです。LINEヤフー Tech Blog

テクノロジー

カセットサーチAPI をリリースしました

はじめまして、R&D統括本部フロントエンド開発1本部開発3部に勤める格闘家の西です。

Yahoo!デベロッパーネットワークにて、カセットサーチAPIを公開しましたので、ご紹介させていただきます。

カセットサーチAPIとは、YOLPカセットギャラリーにアップロードされたカセットを、キーワード、カセットIDなどから検索できるAPIです。このAPIにより、カセットの情報を動的に取得することができます。
(※)Yahoo! Open Local Platform では、地域情報・拠点情報のかたまりを「カセット」と呼んでいます。詳しくはこちら(提供終了)をご覧ください 。

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

今回はカセット検索APIから「牛丼」に関するカセットを取得して、YOLPローカルサーチで検索するまでの利用例を説明します。

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

(※)先日公開しました「業種マスターAPI 」と非常によく似た利用手法となります。業種マスターAPIの利用例については、こちらをご覧ください。

カセット検索APIリクエスト例

以下の例で出てくるカセットサーチAPIのリクエストパラメータの説明はこちら
また、レスポンスフィールドの説明についてはこちらになります。

キーワード「牛丼」で検索してカセットを取得する例
リクエストパラメータにアプリケーションIDのみを指定してください。

http://cassette.search.olp.yahooapis.jp/OpenLocalPlatform/V1/cassetteSearch?query=%E7%89%9B%E4%B8%BC&category=place_official?appid=<あなたのアプリケーションID>

レスポンスをみると、「なか卯 店舗情報」「すき家 店舗情報」カセットが取得てきており、カセットIDが「508c00c69133da7dfd69a99a9cb1ef54」、「8cfa8ed3d825ba896fa8d7cffd28cd67」であることが分かります。

<Feature>
<Id>508c00c69133da7dfd69a99a9cb1ef54</Id>
<Name>なか卯 店舗情報</Name>
<Description>
「なか卯」の店舗情報です。「こだわり卵の親子丼・牛丼・京風うどん」を中心としたメニューをご提供します。
</Description>
<Property>
<AdultFlag>0</AdultFlag>
<Licence/>
<PublishStart>1289546220</PublishStart>
<UpdateDate>1305714768</UpdateDate>
<Detail>
<Tags>親子丼,牛丼,うどん,カレー,定食</Tags>
<ImageUrl1>
http://olp.c.yimg.jp/olp/508c00c69133da7dfd69a99a9cb1ef54/info/thumbnail/image.png
</ImageUrl1>
<OfficialWebsiteUrl>http://www.nakau.co.jp/</OfficialWebsiteUrl>
<ReferenceUrl/>
<Copyright>
Copyright (C) 2005 Nakau Co., Ltd. All Rights Reserved.
</Copyright>
<UseCondition/>
<SupportEmail/>
<SupportUrl/>
<CassetteOwner>株式会社なか卯</CassetteOwner>
<CassetteType>poi_yolp</CassetteType>
<CassetteVersion>0</CassetteVersion>
<CassetteCategory>place_official</CassetteCategory>
<DownloadCount>11</DownloadCount>
<PoiCount>493</PoiCount>
</Detail>
</Property>
</Feature>
-
<Feature>
<Id>8cfa8ed3d825ba896fa8d7cffd28cd67</Id>
<Name>すき家 店舗情報</Name>
<Description>
ファミリー牛丼店「すき家」の店舗情報です。ミニからメガまで選べるサイズと、牛丼やカレーなど種類豊富なメニューをご提供しています。
</Description>
<Property>
<AdultFlag>0</AdultFlag>
<Licence/>
<PublishStart>1289546220</PublishStart>
<UpdateDate>1305714538</UpdateDate>
<Detail>
<Tags>牛丼,カレー,定食,サイズ,テイクアウト</Tags>
<ImageUrl1>
http://olp.c.yimg.jp/olp/8cfa8ed3d825ba896fa8d7cffd28cd67/info/thumbnail/image.png
</ImageUrl1>
<OfficialWebsiteUrl>http://www.sukiya.jp/</OfficialWebsiteUrl>
<ReferenceUrl/>
<Copyright>
Copyright (C) 2010 ZENSHO Co., Ltd. All Rights Reserved.
</Copyright>
<UseCondition/>
<SupportEmail/>
<SupportUrl/>
<CassetteOwner>株式会社ゼンショー</CassetteOwner>
<CassetteType>poi_yolp</CassetteType>
<CassetteVersion>0</CassetteVersion>
<CassetteCategory>place_official</CassetteCategory>
<DownloadCount>22</DownloadCount>
<PoiCount>1497</PoiCount>
</Detail>
</Property>
</Feature>

カセットIDを利用したローカルサーチAPIリクエスト例

以下の例で出てくるローカルサーチAPIのリクエストパラメータの説明はこちら
また、レスポンスフィールドの説明についてはこちらになります。

リクエストパラメータにアプリケーションIDと先ほど取得した「牛丼」で検索したカセットのカセットID(cid=508c00c69133da7dfd69a99a9cb1ef54,8cfa8ed3d825ba896fa8d7cffd28cd67)を指定することによって、牛丼のカセットに絞った検索ができます。

http://search.olp.yahooapis.jp/OpenLocalPlatform/V1/localSearch?appid=<あなたのアプリケーションID>&cid=508c00c69133da7dfd69a99a9cb1ef54,8cfa8ed3d825ba896fa8d7cffd28cd67

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

さらには、JavaScriptマップAPIと組み合わせることで、検索結果を地図やリストに簡単に表示するビューを作成することも可能です。以下のサンプルコードはこちらになります。

おわりに

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

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

こちらの記事のご感想を聞かせください。

  • 学びがある
  • わかりやすい
  • 新しい視点

ご感想ありがとうございました

このページの先頭へ