カセットサーチAPI
リクエストURL
XML
https://map.yahooapis.jp/cassette/V1/cassetteSearch
JSONP
https://map.yahooapis.jp/cassette/V1/cassetteSearch
目次
概要
カセットサーチAPIは、YOLPにアップロードされたカセットを検索するためのAPIです。
カセットID、キーワード、カテゴリからカセットを検索することができます。
リクエストパラメーター一覧
「Web APIの使い方#GETとは」をご参照ください。
パラメーター | 値 | 説明 |
---|---|---|
appid (必須) |
string | アプリケーションID。詳細はこちらをご覧ください。 |
cid |
string | カセットIDです。 |
query |
string | (UTF-8でエンコードされた)検索クエリーです。 |
category |
string | カテゴリを指定します:
|
sort |
string | ソートの方法を指定します:
|
start | integer: 1(デフォルト) | 取得開始位置を指定します。 |
results | integer: 10(デフォルト) | 取得件数を指定します(最大100)。 |
output | string xml(デフォルト), json |
出力形式:
|
callback | string |
JSONPとして出力する際のコールバック関数名を入力するためのパラメーター。UTF-8でエンコードした文字列を入力します。 |
API使用上の注意
URLの最大の長さは2048バイトです。
URLエンコードを行って指定するパラメーターもありますが、エンコード後のURLの長さが2048バイトを超えないようにしてください。
サンプルリクエストURL
場所、施設 カテゴリのカセットを取得
https://map.yahooapis.jp/cassette/V1/cassetteSearch?appid=<あなたのアプリケーションID>&category=place
レスポンスフィールド
カセットサーチAPIのスキーマの記述は、以下のURLをご覧ください。
http://olp.yahooapis.jp/OpenLocalPlatform/V1/YDF.xsd
フィールド | 説明 |
---|---|
YDF | クエリーレスポンスのすべてを含みます。 |
ResultInfo | レスポンスのまとめ情報です。 |
Count | レスポンス情報に含まれる住所情報のデータ件数です。 |
Total | 出力されている住所情報以外も含めた全データ件数です。 |
Start | レスポンス情報に含まれる住所情報の、全データからの取得開始位置です。 |
Latency | レスポンス情報を生成するのに要した時間です。 |
Status | リクエスト元に処理結果を伝えるためのコードです。 正常終了の場合、200を出力します。エラー時は、下記エラー項目を参照してください。 |
Description | APIの説明文です。 |
Copyright | コピーライトです。 |
Feature | 検索結果1件分のデータ群です。 |
Id | カセットIDです。 |
Name | カセット名です。 |
Description | カセットの説明です。 |
Property | 各種データを格納します。 |
AdultFlag | アダルトフラグです。 |
Licence | ライセンス情報です。 |
PublishStart | 公開日時です。 |
UpdateDate | 更新日時です。 |
Detail | 詳細情報です。 |
Tags | タグです。 |
ImageUrl1 | サムネイル画像のURLです。 |
OfficialWebsiteUrl | オフィシャルURLです。 |
ReferenceUrl | リファレンスURLです。 |
Copyright | カセットのコピーライトです。 |
UseCondition | 利用規約です。 |
SupportEmail | サポートメールアドレスです。 |
SupportUrl | サポートURLです。 |
CassetteOwner | 提供者名です。 |
CassetteType | カセット種別です。 |
CassetteVersion | バージョンです。 |
CassetteCategory | カテゴリです。 |
DownloadCount | ダウンロード数です。 |
PoiCount | 拠点数です。 |
サンプルレスポンス
以下は、queryにラーメンを指定した場合のレスポンスです。
XML形式
<?xml version="1.0" encoding="UTF-8"?>
<YDF firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1" xmlns="http://olp.yahooapis.jp/ydf/1.0">
<ResultInfo>
<Count>1</Count>
<Total>1</Total>
<Start>1</Start>
<Latency>0.046</Latency>
<Status>200</Status>
<Description />
<Copyright>Copyright (C) 2011 Yahoo Japan Corporation. All Rights Reserved</Copyright>
<CompressType />
</ResultInfo>
<Feature>
<Id>fee370cffcae93d9461f19966fc31c4c</Id>
<Name>GMフーズ 店舗情報</Name>
<Description>らぁめん「伝丸」や中華料理「天下一」などの店舗情報です。澄んだ鶏ガラスープとこだわりの味噌が自慢の味噌らーめんを主軸とした「伝丸」や、ホイコーローやチンジャオロースなどの一品料理から定食まで揃っている「天下一」など、こだわりのらーめんや一品料理、ボリュームたっぷりの定食メニューなどを提供しています。</Description>
<Property>
<AdultFlag>0</AdultFlag>
<Licence />
<PublishStart>1289546220</PublishStart>
<UpdateDate>1291688851</UpdateDate>
<Detail>
<Tags>ラーメン,中華料理,レストラン</Tags>
<ImageUrl1>http://olp.c.yimg.jp/olp/fee370cffcae93d9461f19966fc31c4c/info/thumbnail/image.png</ImageUrl1>
<OfficialWebsiteUrl>http://www.gmfoods.co.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>1</DownloadCount>
<PoiCount>106</PoiCount>
</Detail>
</Property>
</Feature>
</YDF>
JSON形式
{"ResultInfo":
{"Count":1,
"Total":1,
"Start":1,
"Latency":0.037,
"Status":"200",
"Description":"",
"Copyright":"Copyright (C) 2011 Yahoo Japan Corporation. All Rights Reserved",
"CompressType":""
},
"Feature":[
{"Id":"fee370cffcae93d9461f19966fc31c4c",
"Name":"GM\u30d5\u30fc\u30ba\u3000\u5e97\u8217\u60c5\u5831",
"Description":"\u3089\u3041\u3081\u3093\u300c\u4f1d\u4e38\u300d\u3084\u4e2d\u83ef\u6599\u7406\u300c\u5929\u4e0b\u4e00\u300d\u306a\u3069\u306e\u5e97\u8217\u60c5\u5831\u3067\u3059\u3002\u6f84\u3093\u3060\u9d8f\u30ac\u30e9\u30b9\u30fc\u30d7\u3068\u3053\u3060\u308f\u308a\u306e\u5473\u564c\u304c\u81ea\u6162\u306e\u5473\u564c\u3089\u30fc\u3081\u3093\u3092\u4e3b\u8ef8\u3068\u3057\u305f\u300c\u4f1d\u4e38\u300d\u3084\u3001\u30db\u30a4\u30b3\u30fc\u30ed\u30fc\u3084\u30c1\u30f3\u30b8\u30e3\u30aa\u30ed\u30fc\u30b9\u306a\u3069\u306e\u4e00\u54c1\u6599\u7406\u304b\u3089\u5b9a\u98df\u307e\u3067\u63c3\u3063\u3066\u3044\u308b\u300c\u5929\u4e0b\u4e00\u300d\u306a\u3069\u3001\u3053\u3060\u308f\u308a\u306e\u3089\u30fc\u3081\u3093\u3084\u4e00\u54c1\u6599\u7406\u3001\u30dc\u30ea\u30e5\u30fc\u30e0\u305f\u3063\u3077\u308a\u306e\u5b9a\u98df\u30e1\u30cb\u30e5\u30fc\u306a\u3069\u3092\u63d0\u4f9b\u3057\u3066\u3044\u307e\u3059\u3002",
"Property":
{"AdultFlag":"0",
"Licence":"",
"PublishStart":"1289546220",
"UpdateDate":"1291688851",
"Detail":{
"Tags":["\u30e9\u30fc\u30e1\u30f3,\u4e2d\u83ef\u6599\u7406,\u30ec\u30b9\u30c8\u30e9\u30f3"],
"ImageUrl1":["http:\/\/olp.c.yimg.jp\/olp\/fee370cffcae93d9461f19966fc31c4c\/info\/thumbnail\/image.png"],
"OfficialWebsiteUrl":["http:\/\/www.gmfoods.co.jp\/"],
"ReferenceUrl":[""],
"Copyright":["Copyright (C) 2010 ZENSHO Co., Ltd. All Rights Reserved."],
"UseCondition":[""],
"SupportEmail":[""],
"SupportUrl":[""],
"CassetteOwner":["\u682a\u5f0f\u4f1a\u793e\u30bc\u30f3\u30b7\u30e7\u30fc"],
"CassetteType":["poi_yolp"],
"CassetteVersion":["0"],
"CassetteCategory":["place_official"],
"DownloadCount":["1"],
"PoiCount":["106"]
}
}
}]
}
エラー
コード | 説明 |
---|---|
400 | 渡されたパラメーターがWeb APIで期待されたものと一致しない場合に返されます。 |
503 | 内部的な問題によってデータを返すことができない場合に返されます。 |
<Error>
<Message>パラメータが不正です。</Message>
<Detail>
<Code>400</Code>
</Detail>
</Error>
目次
- Yahoo!ローカルサーチAPI
- Yahoo!ジオコーダAPI
- Yahoo!リバースジオコーダAPI
- カセットサーチAPI
- 気象情報API
- 郵便番号検索API
- クチコミ検索API
- 場所情報API
- 住所ディレクトリAPI
- 施設内検索API
- コンテンツジオコーダAPI
- ルート沿い検索API
- 2点間距離API
- 測地系変換API
- 標高API
- YDF
- よくある質問(FAQ)