マルチコンテンツ検索
API名:
概要:
フリーワードや緯度経度、点列など、様々な条件から施設データを検索します。
・利用するコンテンツ、ジャンルはそれぞれ個別契約が必要です。
利用内容については弊社営業までご相談ください。
※一部パラメータを利用するには別途契約が必要です。
URI:
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/multi
<API使用例1. フリーワード検索>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/multi?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&content=ZIDX_ZPOI&word=品川,ラーメン
<API使用例2. ポリライン検索>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/multi?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&content=ZIDX_ZPOI&line=35.6618472,139.76095,35.661605,139.760819,35.661480,139.760747&buffer=20
リクエストパラメータ
コンテンツパラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
content | ○ | - |
コンテンツ区分 コンテンツ区分を指定します。 複数指定できます。 未指定の場合、エラーとなります。 コンテンツ区分についてはコンテンツ一覧のコンテンツ区分名を参照してください。 |
||||||||
datatype | PC |
データ種別
取得したいデータ種別を指定します。
データ種別により、返却データが異なる項目が存在します。
|
フリーワードパラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
word | - |
検索語句 検索語句を指定します。複数指定できます。 複数指定の上限は50件で1語句の上限は1024文字です。 |
|||||||||||||||||||||||||||||||||
srchtype | and |
検索タイプ
wordパラメータを複数指定した場合の検索タイプを指定します。
|
|||||||||||||||||||||||||||||||||
srchtarget |
text_morphological, text_ngram_and |
検索対象項目
通常指定
マルチセット指定
マルチセット(multiset001,multiset002)指定について
フリーワードを構成する文字列の種類に合わせて適切な複数のフィールドに拡張して検索します。 |
期間指定パラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
range_srchtype | and |
検索タイプ
期間指定検索の組み合わせを複数指定した場合の検索タイプを指定します。
|
|||||||||||
range_srchtarget | - |
検索の対象項目 期間を指定して検索する対象の項目を指定します。 open,chargeそれぞれ利用できるcontentが異なります。 利用できるcontentは問い合わせてください。
|
|||||||||||
range_day1~5 | all |
曜日 期間指定検索値 曜日を指定します。複数指定できます。 ハイフン(-)で曜日の範囲を指定する事が出来ます。 範囲/複数指定された曜日はORで検索されます。 ※クエリパラメータrange_srchtargetが指定されている場合のみ有効となります。
指定例) |
|||||||||||
range_time1~5 | - |
時間帯 期間指定検索値-時間帯をhhmm形式で指定します。複数指定できます。 日をまたぐ時間帯を表す場合は接頭辞(N)を付与してください。 例)翌1:00→N0100 ハイフン(-)で時間帯の範囲を指定する事ができます。 範囲/複数指定された曜日はORで検索されます。 hhmmまたはNhhmmの形式以外の場合、パラメータエラーとなります。 ※クエリパラメータrange_srchtargetが指定されている場合のみ有効となります。 ※未指定の場合は時間帯を加味しません。 ※範囲指定の開始は、指定した時間帯を含みます。 ※時間帯の最小単位を区切りとし、半端な時間を切り捨てた指定とみなします。 例)30分単位の場合0945→0930、1時間単位の場合0945→0900 指定例) |
|||||||||||
range_cost1~5 | - |
コスト 期間指定検索値-コストを指定します。 ハイフン(-)で時間帯の範囲を指定する事ができます。 ※未指定の場合はコストを加味しません。 ※範囲指定の開始・終了共に、指定したコストを含みます。 ※range_srchtargetにopenが指定されている場合に本パラメータを指定するとエラーとなります。 指定例) |
期間指定パラメータの組み合わせについて
1. 曜日: 月~金 (範囲指定)
時間帯: 12:00~13:00 (範囲指定)
コスト: 800円以内 (範囲指定)
2. 曜日: 土日祝 (複数指定)
時間帯: 11:30~13:30 (範囲指定)
コスト: 1000円以内 (範囲指定)
上記の条件で検索するには下記のように指定する
・・・&range_srchtype =and&range_srchtarget=charge&range_day1=mon-fri&range_time1=1200-1300&range_cost1=0-800&range_day2=sat,sun,holiday&range_time2=1130-1330&range_cost2=0-1000
最寄り検索パラメータ
パラメータ | 必須 | デフォルト値 | 説明 |
---|---|---|---|
latlon | - |
緯度経度 緯度経度を指定します。 クエリパラメータllboundsまたはmeshcodeと同時指定した場合、エラーとなります。 |
|
radius | 2000 |
検索範囲の半径 検索範囲の半径を0~100000で指定します(単位:m)。 ※クエリパラメータlatonもしくはarea_flag=Tが指定されている場合有効となります。 |
|
angle | - |
絞込み角度 絞込み角度(単位:°)の最小、最大を指定します。複数指定できます。 北(0)を基準方位として時計周りの角度を指定してください。(例:真東=90) ※クエリパラメータlatlonを指定した場合のみ有効となります。 指定方法はangle=0:90,180:270,...(最小角度1,最大角度1,最小角度2,最大角度2,...) 最小角度1:最大角度1で1セットとなります。 指定可能値は0~360です。 |
|
llbounds | - |
矩形範囲 検索する緯度経度矩形範囲を指定します。 本パラメータ指定時は、返却結果にdistance(矩形の中心点からの距離)を返却します。 ※クエリパラメータlatlonまたはmeshcodeと同時指定した場合、エラーとなります。 ※指定された矩形を構成する辺の内、何れかの長さが200kmを超過した場合、当該の辺を200kmとして検索を行います。 |
|
meshcode | - |
標準地域 標準地域メッシュコードを指定します。3次メッシュコードまで指定する事が可能です。 複数指定できます。1次、2次、3次のメッシュコードは混在して指定可能です。 ※クエリパラメータlatlonまたはllboundsと同時指定した場合、エラーとなります。 ・1次メッシュ例 1111 ・2次メッシュ例 1111-11 ・3次メッシュ例 1111-1111 |
コードパラメータ
パラメータ | 必須 | デフォルト値 | 説明 |
---|---|---|---|
addrcode | - |
絞り込み住所コード 検索範囲を指定の住所コードに限定します。 市区町村までのコード(2桁または5桁)を指定できます。 複数指定できますが、市区町村を指定する場合は同一都道府県に限定されます。 |
|
genrecode | - |
絞り込みジャンルコード 検索範囲を指定のジャンルコードに限定します。複数指定できます。 ジャンルコードは英数字の文字列となります。 ジャンルの階層はコロン(:)で区切って指定してください。 特定ジャンルを除外する場合、コードの前方に半角マイナス(-)を付加して指定します。 ※ジャンルコード詳細については弊社営業までお問い合わせください。 |
ソートパラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sort | content |
出力順 出力順を決定します。複数指定できます。 デフォルトは昇順で、降順指定の場合、ソートキーの前方にマイナス(-)を付加します。
|
|||||||||||||||||||||||||
mscore | none |
一致率 入力ワードとの一致率を算出する方法を指定します。 ※ソートパラメータmscoreが指定されている場合のみ有効となります。
|
ファセットパラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
facet | tod,shk,genre |
絞込み件数 返却するファセットを指定します。複数指定できます。
|
フラグパラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
exclude_link | F |
重複施設の除去 重複施設を除去するか指定します。(代表点が大きく異なる場合等)
|
|||||||||
genre_exists | genre_all |
ジャンル設定の絞込み 指定ジャンルパターンにおいて、ジャンルへの関連付けによる検索結果の絞込みを指定します。 ※複数の業種をもつPOIにおいては、どれか1つの業種がジャンルに関連付いている場合、ジャンル設定ありとみなします。
|
|||||||||
area_flag | F |
エリア自動判定検索 エリア自動判定検索を有効にするかを指定します。 エリア自動判定検索が行われると検索ワードからエリアを自動抽出し、その地点を中心とした最寄検索結果を出力パラメータcenter_areaに出力します。
エリア自動判定が行われる条件は下記になります。 |
ポリラインパラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
line | - |
ポリライン 緯度経度を2点以上の点列で指定します。 点列数が多い場合、返却に時間がかかる場合があります。 |
|||||||||
poitype | all |
POI情報検索範囲指定 周辺のPOI情報の検索範囲を指定します。 ※クエリパラメータlineが指定されている場合のみ有効です。
|
|||||||||
buffer | 20 |
検索範囲 クエリパラメータpoitypeにallを指定した場合、ポリラインからどのくらいの範囲を検索対象とするか、片側の幅を指定します。(単位:m) 指定可能な幅は0~200です。 |
|||||||||
cornerradius | 50 |
検索範囲メートル指定 クエリパラメータpoitypeにcornerを指定した場合、検索範囲の半径を指定します。(単位:m) 指定可能な幅は0 ~200です。 ※クエリパラメータlineが指定されている場合のみ有効です。 |
|||||||||
cornerangle | 120 |
検索範囲角度指定 クエリパラメータpoitypeに cornerを指定した場合、角判定を行う角度(単位:°)を指定します。 指定した角度以下の角を「角」とします。 指定可能な範囲は0~180です。 ※クエリパラメータlineが指定されている場合のみ有効です。 |
|||||||||
side | all |
施設対象絞込み 施設対象をlineの左側、右側への絞込みを指定します。 ※lineが指定されている場合のみ有効です。
|
その他パラメータ
パラメータ | 必須 | デフォルト値 | 説明 | ||
---|---|---|---|---|---|
limit | 0,100 |
検索結果取得件数 検索結果取得件数を指定します。 取得開始位置の指定範囲は 0~10000 です。 10001 以上の指定をした場合は10000指定と同様の結果となります。 取得件数の指定範囲は 1~1000 です。 1001以上の指定をした場合は1000指定と同様の結果となります。 |
|||
datum | TOKYO |
測地系 入出力緯度経度の測地系を指定します。 |
|||
llunit | dec |
緯度経度形式 緯度経度形式を指定します。 |
|||
outfield | - |
フィールド 出力フィールドの制御を指定します。複数指定できます。 指定したフィールドのみを結果から除きたい場合は、先頭に半角マイナス(-)を付加して指定します。 先頭以外に半角マイナス(-)を指定した場合はエラーとなります。 対象は出力項目item直下のみ(contentを除く)となります。 |
|||
cutoff | - |
足切りフィルター 足きりする対象とポイントを指定します。 [指定方法]足切りする対象:足切りするポイント
|
|||
vsrch1~30 | - |
任意条件検索 任意返却値条件検索1~30を指定します。複数指定できます。指定の形式についてはこちらをご確認ください。 vsrchパラメータに指定するキー部分は出力項目content_data内のキー名と同じものを指定してください。 |
出力データ
出力フォーマット
{"status":{"code":"0000", "text":"OK"}, "info":{"hit":146, "facet":{"tod":{"13":146}, "shk":{13103:146}, "genre":{00110:{"text":"車・交通", "count":9}}, "content":{string:number}, "upddt":{string:number}}}}, "center_area":[{"word":string, "text":string, "point":LatLon, "addressText":string, "genreText":string, "todcode":string, "shkcode":string, "val01":コンテンツ区分により変化, "val02":コンテンツ区分により変化}, ...], "item":[{"text":新橋駅(JR 山手線), "code":20000000000000003575, "point":{"lat":35.6633583, "lon":139.7613556}, "kana":"シンバシエキ", "addressText":"東京都港区新橋2丁目17-14", "zipcode":"105-0004", "phoneNumber":["050-2016-1600"], "content":"ZIDX_EKI", "genreText":"00260:駅", "todcode":"13", "todname":"東京都", "shkcode":"103", "shkname":"港区", "catId":"01:20401030001", "eki_info":{"name":null, "code":null, "distance":0} "distance":null, "dist_route":null, "angle":null, "fmnmFlg":false, "fmthFlg":false, "smnmFlg":false, "smthFlg":false, "mscore":null, "link01":null, ... "link10":null, "side":"left", "content_data":object}, ...]} -> コンテンツ区分により変化
キー名 | データ型 | 説明 | ||||||
---|---|---|---|---|---|---|---|---|
status | object | ステータス情報が入ります。 | ||||||
code | string |
ステータスコードが入ります。
|
||||||
text | string | ステータス内容に関するテキスト情報が入ります。 | ||||||
info | object | 検索結果の情報が入ります。 | ||||||
hit | number | 入力された条件に対してヒットした件数が入ります。 | ||||||
facet | object | ファセット情報が入ります。 | ||||||
tod | object | {"都道府県コード":件数}の形で都道府県毎の件数が入ります。 | ||||||
shk | object | {"市区町村コード":件数}の形で市区町村毎の件数が入ります。 | ||||||
genre | object |
{"ジャンルコード":{"text:"ジャンル名", "count":件数} の形でジャンルコード毎の件数が入ります。 |
||||||
upddt | object | {"コンテンツ区分:更新時間":件数}の形で更新時間毎の件数が入ります。 | ||||||
content | object | {"コンテンツ区分":件数}の形でコンテンツ区分毎の件数が入ります。 | ||||||
center_area | array | 中心エリアデータの配列となります。 クエリパラメータarea_flag=Fの場合、中心エリアデータ0件の場合は空配列となります。 | ||||||
word | string | 判定対象キーワードが入ります。 | ||||||
text | string | POI名称が入ります。 | ||||||
point | object | 代表点緯度経度が入ります。 | ||||||
addressText | string | 住所テキストが入ります。 | ||||||
genreText | string | 「駅」「役所」「オリジナル」「市区町村」「大字」のいずれかのジャンル名称が入ります。 | ||||||
todcode | string | 都道府県コードが入ります。 | ||||||
shkcode | string | 市区町村コードが入ります。 | ||||||
val01 | - | コンテンツ区分毎の任意返却値1が入ります。 | ||||||
val02 | - | コンテンツ区分毎の任意返却値2が入ります。 | ||||||
item | array | 検索結果の配列となります。 検索結果が0件の場合は空の配列となります。 | ||||||
text | string | POI名称が入ります。 | ||||||
code | string | POIコードが入ります。 | ||||||
point | object | 代表点緯度経度が入ります。 | ||||||
kana | string |
POI名称カナが入ります。 全角/半角カタカナ、ひらがな等の統一性はなく、コンテンツプロバイダのデータ整備仕様により異なります。 |
||||||
addressText | string | 住所テキストが入ります。 | ||||||
zipcode | string | 郵便番号が入ります。 | ||||||
phoneNumber | array |
電話番号の配列となります。 複数電話番号が返却される可能性があります。また、電話番号以外の文字列が格納されている可能性があります。 |
||||||
content | string | コンテンツ区分が入ります。 | ||||||
genreText | string | ジャンル名称が入ります。 | ||||||
todcode | string | 都道府県コードが入ります。 | ||||||
todname | string | 都道府県名が入ります。 | ||||||
shkcode | string | 市区町村コードが入ります。 | ||||||
shkname | string | 市区町村名が入ります。 | ||||||
catId | string |
コンテンツ別分類IDが入ります。 複数返却される場合はセミコロン(;)で区切られます。 IDはコンテンツ提供会社の都合により変わることがあります。 ご利用にあたっては別途ご相談ください。 |
||||||
eki_info | object | 最寄り駅情報が入ります。 | ||||||
name | string | 最寄り駅名が入ります。 | ||||||
code | string | 最寄り駅コードが入ります。 | ||||||
distance | number | 最寄り駅までの距離(単位:m)が入ります。 | ||||||
distance | number |
距離(単位:m)が入ります。 緯度経度パラメータ指定がある場合、またはエリア自動判定検索をフラグ指定し、判定対象となった場合のみ返却します。 緯度経度、エリア自動判定検索の両パラメータが有効な場合、緯度経度パラメータが優先されます。 上記以外、または緯度経度パラメータに指定した緯度経度がPOIの緯度経度と一致する場合nullとなります。 |
||||||
dist_route | number |
指定したlineの出発点(始点)から当該施設までの経路距離(単位:m)が入ります。 line未指定時、またはlineの出発点(始点)に指定した緯度経度がPOIの緯度経度と一致する場合nullとなります。 経路距離は「指定したlineの出発点(始点) ~ 各POI最寄りline開始地点までの距離」 + 「各POI最寄りline開始地点からPOI代表点までの距離」の合計になります。 |
||||||
angle | number |
指定緯度経度からの角度(単位:°)が入ります。 緯度、経度パラメータがある場合のみ返却します。 上記以外、または緯度経度パラメータに指定した緯度経度がPOIの緯度経度と一致する場合nullとなります。 |
||||||
fmnmFlg | boolean |
完全一致フラグが入ります。
|
||||||
fmthFlg | boolean |
シソーラス完全一致フラグが入ります。
|
||||||
smnmFlg | boolean |
前方一致フラグが入ります。
|
||||||
smthFlg | boolean |
シソーラス前方一致フラグが入ります。
|
||||||
mscore | number |
入力ワードとの一致率を示すスコアが入ります。 一致率パラメータにnone以外を指定した場合のみ返却します。 上記以外の場合nullとなります。 |
||||||
link01~10 | object | 名寄せコンテンツリンク情報が入ります。 | ||||||
side | string |
ポリラインに対してPOIが左右どちら側にあるかが入ります。 ポリラインパラメータがある場合のみ返却します。 上記以外の場合nullとなります。
|
||||||
content_data | object |
コンテンツ別出力項目が入ります。 クエリパラメータcontentによりcontent_data内の返却値が異なります。 緯度経度の出力形式は選択したcontentによって異なります。 |
出力例
[通常出力例]
&content=ZIDX_ZPOI&datatype=PC&area_flag=T&exclude_link=F&srchtype=and
&srchtarget=text_morphological,text_ngram_and&word=品川,ラーメン&facet=tod,shk,genre,upddt,content
&sort=content&limit=0,1&genre_exists=genre_all&latlon=&radius=1800
{"status":{"code":"0000",
"text":"OK"},
"info":{"hit":3,
"facet":{"tod":{"13":3},
"shk":{"13103":1},
"genre":{"00240":{"text":"グルメ",
"count":1},
"00240:00130":{"text":"グルメ",
"count":3}},
"upddt":null,
"content":{"ZIDX_ZPOI":3}}}},
"center_area":[{"word":"品川",
"text":"北品川",
"point":{"lat":35.6197306,
"lon":139.74248},
"addressText":"東京都品川区北品川1丁目2",
"genreText":"駅",
"todcode":"13",
"shkcode":"109",
"val01":"京浜急行電鉄",
"val02":"京浜急行本線"}, ->...省略
{"word":"品川",
"text":"東京都品川区西大井",
"point":{"lat":35.595875,
"lon":139.7225917},
"addressText":"東京都品川区西大井",
"genreText":"大字",
"todcode":"13",
"shkcode":"109",
"val01":null,
"val02":null}],
"item":[{"text":"喜多方ラーメン坂内品川シーズンテラス店",
"code":"00000000000003146652",
"point":{"lat":35.62935,
"lon":139.74645},
"kana":"キタカタラーメンバンナイシナガワシーズンテラステン",
"addressText":"東京都港区港南1-2-70",
"zipcode":"108-0075",
"phoneNumber":["03-6433-1162"],
"content":"ZIDX_ZPOI",
"genreText":"00130:ラーメン",
"todcode":"13",
"todname":"東京都",
"shkcode":"103",
"shkname":"港区",
"catId":"01:11601060099",
"eki_info":{"name":"品川",
"code":"2236",
"distance":360},
"distance":1096.1,
"dist_route":null,
"angle":22.43,
"fmnmFlg":false,
"fmthFlg":false,
"smnmFlg":false,
"smthFlg":false,
"mscore":null,
"link01":null,
"link02":null,
"link03":null,
"link04":null,
"link05":null,
"link06":null,
"link07":null,
"link08":null,
"link09":null,
"link10":null,
"side":null,
"content_data":{"prkFlg":"0",
"dtlInfoArrv":{
"arrive_list":{
"arrive":{"arrive_nm":"出入口",
"arrive_kn":"デイリグチ",
"line_nm":"",
"arrive_cd":"99",
"arrive_lat":"128263000",
"arrive_lon":"503088510",
"eae_lat":"128263000",
"eae_lon":"503088510",
"distance":"85"}}},
"aoFlg":"0",
"toiletFlg":"",
"dtlmapFlg":"0",
"oh2to5Flg":"0",
"hcpToiletFlg":"",
"atmFlg":"",
"alcFlg":"",
"tbFlg":"",
"dtFlg":"",
"cmsFlg":"",
"cwFlg":"",
"sgsFlg":"",
"dtlOh":{"opentime":"月曜-土曜 11:00-21:00,
日・祝祭日 11:00-17:00",
"holiday":"年中無休"},
"dtlInfoAPrk":""}}
[検索結果が0件の例]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/multi
{"status":{"code":"0000",
"text":"OK",
"info":{"hit":0,
"facet":null},
"center":[],
"item":[]}