マルチコンテンツ検索

API名: 
poi/multi
概要: 
様々な条件から施設データを検索します。

※一部パラメータを利用するには別途契約が必要です。
※一部開発中の機能があります。

URI: 

http://core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/multi

<API使用例>
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/multi?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&content=ZIDX_ZPOI&ganre_pattern=API001&word=品川,ラーメン

リクエストパラメータ
コンテンツパラメータ
パラメータ 必須 デフォルト値 説明
content - コンテンツ区分
コンテンツ区分を指定します。
複数値指定ができます。
コンテンツ区分についてはコンテンツ一覧のコンテンツ区分名を参照してください。
datatype   PC データ種別
取得したいデータ種別を指定します。
データ種別により、返却データが異なる項目が存在します。
種別 説明
PC PC用データ
MOBILE 携帯用データ
ANDROID アンドロイド用データ
フリーワードパラメータ
パラメータ 必須 デフォルト値 説明
word   - 検索語句
検索語句を指定します。複数検索できます。
複数指定の上限は30件で1語句の上限は1024文字です。
srchtype   and 検索タイプ
wordパラメータを複数指定した場合の検索タイプを指定します。
説明
and AND検索
or OR検索
srchtarget   text_morphological,
text_ngram_and
検索対象項目
wordパラメータ指定した場合の検索対象項目を指定します。
複数検索できます。ただし、マルチセットを指定した場合は複数指定できません。
各項目のカッコ内は検索方式を表します。
通常指定
説明
code_full POIコード(前方一致)
phone_forward 電話番号(前方一致)
text_morphological POI名称(形態素解析)
text_ngram_and POI名称(N-GRAM:N=2AND検索)
text_ngram_or POI名称(N-GRAM:N=2OR検索)
text_full POI名称(完全一致)
text_forward POI名称(前方一致)
kana_ngram_and POI名称カナ(N-GRAM:N=2AND検索)
address_ngram_and 住所(N-GRAM:N=2AND検索)
address_forward 住所(前方一致)
genre_ngram_and ジャンル名称(N-GRAM:N=2AND検索)
genre_forward ジャンル名称(前方一致)

マルチセット指定

説明
multiset001 マルチセット指定1。
下記対象データのあいまい検索
・POI名称(N-GRAM:N=2 OR検索)
・POI名称(形態素解析)
・POI名称(完全一致)
                        +
・POI設名カナ
(N-GRAM:N=2 フレーズ検索)
※フレーズ検索とは、トークンの出現位置順を加味した検索になります。
multiset002 マルチセット指定2。
下記対象データの検索
・POI名称(N-GRAM:N=2 OR検索)
・POI名称(形態素解析)
・POI名称(完全一致)
                        +
・POI設名カナ
(N-GRAM:N=2 フレーズ検索)
※フレーズ検索とは、トークンの出現位置を加味した検索になります。

マルチセット(multiset001,multiset002)指定について
フリーワードを構成する文字列の種類に合わせて適切な複数のフィールドに拡張して検索します。

期間指定パラメータ
パラメータ 必須 デフォルト値 説明
range_srchtype   and 検索タイプ
期間指定検索の組み合わせを複数指定した場合の検索タイプを指定します。
説明
and AND検索
or OR検索
range_srchtarget   - 検索の対象項目
期間を指定して検索する対象の項目を指定します。
open,chargeそれぞれ利用できるcontentが異なります。
利用できるcontentは問い合わせてください。
説明
open 営業時間
指定した期間に営業している施設を返却
range_day1~5,range_time1~5を指定する事により
期間を絞り込むことができます。
range_day1~5,range_time1~5を組み合わせて検索する場合は、
各パラメータの添え字をそろえて指定してください。
※openを指定した場合にrange_cost1~5を指定する事はできません。
 指定した場合はエラーとなります。
charge 利用料金
指定した期間とコストに該当する施設を返却
コストを料金とみなして利用
range_day1~5,range_time1~5,range_cost1~5を指定する事により
期間、コストを絞り込むことができます。
range_day1~5,range_time1~5,range_cost1~5を組み合わせて検索する場合は、
各パラメータの添え字を揃えて指定してください。
range_day1~5   all 曜日
期間指定検索値 曜日を指定します。複数指定できます。
ハイフン(-)で曜日の範囲を指定する事が出来ます。
範囲/複数指定された曜日はORで検索されます。
※クエリパラメータrange_srchtargetが指定されている場合のみ有効となります。
説明
all 全ての曜日
mon~sun 月曜日~日曜日
holiday 祝日
before_hoiday 祝前日

指定例)
[単体指定]
■all(全ての曜日)
■mon(月曜日)
[範囲指定]
■mon-fri(月曜日~金曜日)
■sat-sun(土曜日~日曜日)
[複数指定]
■mon,wed,fri(月曜日、水曜日、金曜日)
■sat,sun,holiday(土曜日、日曜日、祝日)
■mon-fri,sat,before_holiday(月曜日~金曜日、土曜日、祝前日)

range_time1~5   - 時間帯
期間指定検索値-時間帯をhhmm形式で指定します。複数指定できます。
日をまたぐ時間帯を表す場合は接頭辞(N)を付与してください。例)翌1:00→N0100
ハイフン(-)で時間帯の範囲を指定する事ができます。
範囲/複数指定された曜日はORで検索されます。
hhmmまたはNhhmmの形式以外の場合、パラメータエラーとなります。
※クエリパラメータrange_srchtargetが指定されている場合のみ有効となります。
※未指定の場合は時間帯を加味しません。
※範囲指定の開始は、指定した時間帯を含みます。
※時間帯の最小単位を区切りとし、半端な時間を切り捨てた指定とみなします。
 例)30分単位の場合0945→0930、1時間単位の場合0945→0900

指定例)
[単体指定]
■0900(09:00台)
■1230(12:30台)
■N0100(翌01:00台)
[範囲指定]
■1130-1230(1130~12:30の間)
■2200-N0030(22:00~翌00:30の間)
■N0100-N0500(翌01:00~翌05:00の間)
[複数指定]
■1900,2100,2300(19:00台、21:00台、23:00台)
■1900-2100.2300-N0100(19:00~21:00の間、23:00~翌01:00の間)

range_cost1~5   - コスト
期間指定検索値-コストを指定します。
ハイフン(-)で時間帯の範囲を指定する事ができます。
※未指定の場合はコストを加味しません。
※範囲指定の開始・終了共に、指定したコストを含みます。
※range_srchtargetにopenが指定されている場合に本パラメータを指定するとエラーになります。

指定例)
[単体指定]
■0(無料)
■100(100円)
■3500(3500円)
[範囲指定]
■0-300(300円以内)
■500-2000(500円~2000円以内)

期間指定パラメータの組み合わせについて


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。
※クエリパラメータ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   - 絞り込みジャンルコード
検索範囲を指定のジャンルコードに限定します。複数検索できます。
複数指定できますが、中ジャンル以降を指定する場合、上位ジャンルコードが同じコードに限定されます。
特定ジャンルを除外する場合、コードの前方に半角マイナス(-)を付加して指定します。
iareacode   - 検索したい施設の5行のiエリアコードを指定します。
ソートパラメータ
パラメータ 必須 デフォルト値 説明
sort   content 検索タイプ
出力順を決定します。複数検索できます。
デフォルトは昇順で、降順指定の場合、ソートキーの前方にマイナス(-)を付加します。
説明
content コンテンツ区分
コンテンツ区分の指定中に並べるため、
昇順/降順の区別はしません。
リクエストパラメータcontentに指定された順にソートを行います。
code POIコード
kn POI名称カナ
tod 都道府県コード
shk 市区町村
dist 距離※緯度、経度指定時のみ機能します。
fnm 完全一致
fmsth シソーラス完全一致
mscore 入力ワードとの一致率
nmlen POI名称の文字数
mscore   none 一致率
入力ワードとの一致率を算出する方法を指定します。
※ソートパラメータmscoreが指定されている場合のみ有効となります。
説明
none 加味しない
seq 連続性を加味
seqld 連続性・類似度(レーベンシュタイン距離)を加味
seqiwd 連続性・類似度(ジャロ・ウインクラー距離)を加味
ファセットパラメータ
パラメータ 必須 デフォルト値 説明
facet   tod,shk,genre 絞込み件数
返却するファセットを指定します。複数検索できます。
説明
tod 都道府県別件数
shk 市区町村別件数
genre ジャンル別件数
content コンテンツ区分別件数
upddt データ更新日時
駐車場(パーク24,リパーク,名鉄協商のみ)
フラグパラメータ
パラメータ 必須 デフォルト値 説明
exclude_link   F 重複施設の除去
重複施設を除去するか指定します。(代表点が大きく異なる場合等)
説明
T 除去する
F 除去しない
genre_exists   genre_all ジャンル設定の絞込み
指定ジャンルパターンにおいて、ジャンルへの関連付けによる検索結果の絞込みを指定します。※複数の業種をもつPOIにおいては、どれか1つの業種がジャンルに関連付いている場合、ジャンル設定ありとみなします。
説明
genre_all ジャンルの関連付けにか関わらず全件返却
genre_off ジャンル設定なしのみ返却
genre_on ジャンル設定ありのみ返却
area_flag   F エリア自動判定検索
エリア自動判定検索を有効にするかを指定します。
エリア自動判定検索が行われると検索ワードからエリアを自動抽出し、その地点を中心とした最寄検索結果を出力パラメータcenter_areaに出力します。
説明
T 除去する
F 除去しない

エリア自動判定が行われる条件は下記になります。
・本値がT指定
・クエリパラメータ wordが二語以上指定され、かつ地名が含まれている

その他パラメータ
パラメータ 必須 デフォルト値 説明
limit   0,100 検索結果取得件数
検索結果取得件数
を指定します。
取得開始位置を10001以上の値が指定された場合はエラーとなります。
取得件数を1001以上の値が指定された場合はエラーとなります。
datum   TOKYO 測地系
返却されるPOI代表点の測地系を指定します。
outfield   - フィールド
出力フィールドの制御を指定します。複数検索できます。
指定したフィールドのみを結果から除きたい場合は、先頭に半角マイナス(-)を付加して指定します。
対象は出力項目item直下のみ(contentを除く)となります。
mscore   none 一致率
入力ワードとの一致率を算出する方法を指定します。
※ソートパラメータmscoreが指定されている場合のみ有効となります。
説明
none 加味しない
seq 連続性を加味
seqld 連続性・類似度(レーベンシュタイン距離)を加味
seqiwd 連続性・類似度(ジャロ・ウインクラー距離)を加味
cutoff   - 足切り
足きりする対象とポイントを指定します。
[指定方法]足切りする対象:足切りするポイント
mscore 入力ワードとの一致率を指定します。
入力ワードに対する最大スコア[注]を100%として、指定した割合(%)未満の算出スコアとなった施設を切り捨てます。
[注]完全一致時のスコアと同等になります。(該当施設の算出スコアで最大となったスコアではありません)

足切りするポイント指定方法 足切りするポイントを割合(%)で指定してください。0~100の自然数のみ
例1) mscore:50
算出スコアが最大スコアの1/2未満となった施設を切り捨てる
例2) mscore:25
算出スコアが最大スコアの1/4未満となった施設を切り捨てる

vsrch1~30   - 任意条件検索
任意返却値条件検索1~30を指定します。複数検索できます。
任意返却値は重複して指定することが可能で、基本的には完全一致となります。
※コンテンツ個別のval定義により、部分一致or範囲に動作が変わります。

vsrchパラメータ内に条件を複数指定している場合、パラメータ内はORで結合されます。
vsrchパラメータが複数指定されている場合、パラメータ間はANDで結合されます。

vsrchパラメータに指定するkey部分は出力項目content_data内のkeyと同じものを指定してください。
指定フォーマットは以下の通りです。
[部分一致検索]
 任意項目値:条件
■任意返却値6=1、または任意返却値7=0
・・・&vsrch1=val06:1,val07:0

■任意返却値6=1、または任意返却値6=4
・・・&vsrch1=val06:1,val06:4

■任意返却値6=1、かつ任意返却値7=0または任意返却値7=4
・・・&vsrch1=val06:1&vsrch2=val07:0,val07:4

[範囲指定検索(以上-以下)]
 任意項目値:[最小値 TO 最大値]
■任意返却値3=11~14、または任意返却値6=1~5
・・・&vsrch1=val03:[11 TO 14],val06:[1 TO 5]

■任意返却値3=10以上
・・・&vsrch1=val03:[10 TO *]

■任意返却値3=14以下
・・・&vsrch1=val03:[* TO 14]

[範囲指定検索(超-未満)]
 任意項目値:{最小値 TO 最大値}
■任意返却値3=11超14未満、または任意返却値6=1超5未満
・・・&vsrch1=val03:{11 TO 14},val06:{1 TO 5}

■任意返却値3=10超
・・・&vsrch1=val03:{10 TO *}

■任意返却値
・・・&vsrch1=val03:{* TO 14}

出力データ
出力フォーマット

{"status":{"code":"string",
           "text":"string"},
 "info":{"hit":number,
         "facet":{"tod":{code:number},
                  "shk":{code:number},
                  "genre":{code:{"text":string,
                                 "count":number}},
                  "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":string,
                  "code":string,
                  "point":object,
                  "kana":string,
                  "addressText":string,
                  "zipcode":string,
                  "phoneNumber":array,
                  "content":string,
                  "genreText":string,
                  "todcode":string,
                  "todname:string"
                  "shkcode":string,
                  "shkname":string,
                  "catId":string,
                  "eki_info":{"name":string,
                              "code":string,
                              "distance":number}
                  "iareacode":string,
                  "distance":number,
                  "angle":number,
                  "fmnmFlg":boolean,
                  "fmthFlg":boolean,
                  "mscore":string,
                  "link01":string,
                        ...
                  "link10":string,
                  "content_data":object}, ...]} -> コンテンツ区分により変化

キー名 データ型 説明
status     object ステータス情報が入ります。
  code   string ステータスコードが入ります。
0000 正常終了
0001 タイムアウトが発生またはデータサイズが 制限値を超えたため処理が中断された
  text   string ステータス内容に関するテキスト情報が入ります。
info     object 検索結果の情報が入ります。
  hit   number 入力された条件に対してヒットした件数が入ります。
  facet   object ファセット情報が入ります。
    tod object {"都道府県コード":件数}の形で都道府県毎の件数が入ります。
    shk object {"市区町村コード":件数}の形で市区町村毎の件数が入ります。
    genre object {"ジャンルコード":{"text:"ジャンル名",                                "count":件数} の形でジャンルコード毎の件数が入ります。
    upddt object {"コンテンツ区分:更新時間":件数}の形で更新時間毎の件数が入ります。
    content object {"コンテンツ名称":件数}の形でコンテンツ名称別件数が入ります。
center_area     object 中心エリアデータの配列となります。 クエリパラメータ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
  eki_info   object 最寄り駅情報
    name string 最寄り駅名
    code string 最寄り駅コード
    distance number 最寄り駅までの距離(m)
  iareacode   string iエリアコード
  distance   number 距離(m) 緯度、経度パラメータ指定がある場合、または地域検索フラッグを指定し、地域検索となった場合のみ返却します。 上記以外、または不明の場合nullとなります。
  angle   number 指定緯度経度からの角度(°) 緯度、経度パラメータがある場合のみ返却します。 上記以外、または不明の場合nullとなります。
  fmnmFlag   boolean 完全一致フラグ ソートパラメータにfnmまたはfmthの指定がある場合のみ返却します。 上記以外、または不明の場合nullとなります。
ture 完全一致
false 完全一致ではない
  fmthFlag   boolean シソーラス完全一致フラグ ソートパラメータにfnmまたはfmthの指定がある場合のみ返却します。 上記以外、または不明の場合nullとなります。
ture シソーラス完全一致
false シソーラス完全一致ではない
  mscore   string 入力ワードとの一致率を示すスコア ソートパラメータにmscoreの指定がある場合のみ返却します。 上記以外、または不明の場合nullとなります。
  link01~10   string 名寄せコンテンツリンク情報
  content_data   object コンテンツ一覧名称先リンク参照
クエリパラメータcontentによりcontent_data内の返却値が異なります。
出力例

[通常出力例]
http://core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/multi?if_clientid=JSZxxxxxxxxxx|xxxxx
&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},
          "iareacode":"05810",
          "distance":1096.1,
          "angle":22.43,
          "fmnmFlg":null,
          "fmthFlg":null,
          "mscore":null,
          "link01":null,
          "link02":null,
          "link03":null,
          "link04":null,
          "link05":null,
          "link06":null,
          "link07":null,
          "link08":null,
          "link09":null,
          "link10":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件の例] http://core.its-mo.com/zmaps/api/apicore/core/v1_0/poi/multi

{"status":{"code":"0000",
           "text":"OK",
 "info":{"hit":0,
         "facet":null},
 "center":[],  "item":[]}