External Data

データ収集用のAPIを使うことにより外部からのデータをプローブデータ収集SDKに渡すことができます。

それぞれのAPIの詳細は以下の通りです。

なお、外部からのデータ追加はこちらのAPIを介してのみ可能となります。

また、扱えるデータも各APIで扱うパラメータのみです。



addNaviInfo

本APIによりナビ情報(ナビ機能で生成した緯度経度、車両向き、速度など)を追加することができます。

このナビ情報の作成には、パイオニア クラウドナビゲーションSDKから得られる情報が必要となります。

本APIは、プローブデータ収集SDKが動作している時のみ有効です。

本APIの設定パラメータと戻り値の詳細は、Table.4.2.1.1 ~ Table.4.2.1.5、 および Table.4.1.2 ~ Table.4.1.7 を参照してください。

Android:addNaviInfo
fun sendAddNaviInfo(){

	val appNaviInfo = AppNaviInfo(
        mmLat = 緯度の値
        mmLon = 経度の値
        speed = 速度の値
        dir = 方向の値
        ...
    )

	val result = sdk.addNaviInfo(appNaviInfo)
}

iOS:addNaviInfo
result = await sdk.addNaviInfo(.init(
	mmLat: Double(mmLatString)!,
	mmLon: Double(mmLonString)!,
	speed: Double(speedString)!,
	direction: Double(directionString)!,
	...
))

addRouteActionLog

本APIによりルートアクションログ(案内開始、目的地到着などのアクションとその発生日時位置情報など)を追加することができます。

このルートアクションログの作成には、パイオニア クラウドナビゲーションSDKから得られる情報が必要となります。

本APIは、プローブデータ収集SDKが動作している時のみ有効です。

本APIの設定パラメータと戻り値の詳細は、Table.4.2.1.1 ~ Table.4.2.1.5、 および Table.4.1.2 ~ Table.4.1.7 を参照してください。

Android:addRouteActionLog
fun sendAddRouteActionLog(){

	val routeActionLog = RouteActionLog(
        actionTime = "2023-01-01T10:10:10Z"
        actionType = 1
        ...
    )

	val result = sdk.addRouteActionLog(routeActionLog)
}

iOS:addRouteActionLog
result = await sdk.addRouteActionLog(.init(
	actionTime: actionTime,
	actionType: Int(actionTypeString)!,
	...
))

setVehicleInfo

本APIは、プローブデータ収集SDKの動作に必須ではありません。

本APIにより車両情報(エンジンタイプ、排気量、車重など)を追加することができます。

本APIの情報は、クラウドサーバでの誘導情報や燃費計算の精度向上に用います。

本APIは、プローブデータ収集SDKが動作している時のみ有効です。

本APIの設定パラメータと戻り値の詳細は、Table.4.2.1.1 ~ Table.4.2.1.5、 および Table.4.1.2 ~ Table.4.1.7 を参照してください。

Android:setVehicleInfo
fun sendSetVehicleInfo(){

	val vehicleInfo = VehicleInfo(
		engType = 1,
		engModel ="TYPE_A",
		...
	)

	val result = sdk.setVehicleInfo(vehicleInfo)
}

iOS:setVehicleInfo
result = await sdk.setVehicleInfo(.init(
	engType: Int(engTypeString)!,
	engModel: engModel,
	...
))


APIのパラメータと戻り値

IDAPI namedescriptionparameterparameter typereturn必須・任意補足
1addNaviInfo自車位置が更新された時に、
プローブデータ収集SDKに通知する
ナビ情報naviInfo: AppNaviInfoSdkResult:
OK、NOT_ACTIVATED
必須
2addRouteActionLogナビルート情報が更新された時に、
プローブデータ収集SDKに通知する
ナビルート情報routeActionLog: RouteActionLogSdkResult:
OK、NOT_ACTIVATED
必須
3setVehicleInfo車両情報を、
プローブデータ収集SDKに通知する
車両情報vehicleInfo: VehicleInfoSdkResult:
OK、NOT_ACTIVATED
任意
Table.4.2.1.1 - 外部データ収集API一覧

APIの引数

下記のパラメータ(AppNaviInfo, RouteActionLog, PointInfo)の詳細については、別資料(naviCoreSdk API Reference)を参照してください。

名称:class AppNaviInfo説明:ユーザーアプリケーションから受領するナビ情報省略可否備考
mmLat: Double[degree]マップマッチング緯度。世界測地系省略不可
mmLon: Double[degree]マップマッチング経度。世界測地系省略不可
speed: Double[m/s]走行速度省略不可
onRoad: Boolean路上フラグ
True:自車位置がオンロード
False:自車位置がオフロード
省略不可
dir: Double車両向き
[degree]
省略不可北0度 時計回り正
linkKind: Intリンク種別
0:Roundaboutリンク
1:本線(上下線非分離)リンク
2:本線(上下線分離)リンク
3:連結路(本線間の渡り線)リンク、
4:交差点内リンク
5:連結路(ランプ)リンク
6:本線と同一路線の側道
7:SA等測線リンク
省略不可無効値の場合-1
roadKind: Int道路種別
0:高速
1:都市高速
2:国道
3:主要地方道
4:県道
5:一般道路(幹線)
6:一般道路(その他)
7:導入路
8:細街路1
9:細街路2
10:フェリー航路
省略不可無効値の場合-1
insideTunnel: Booleanトンネルフラグ
True:トンネル内
False:トンネル外
省略不可
onHighway: Boolean高速道路フラグ
True:高速道路走行中
False:高速道路以外を走行中
省略不可
tollgateDist: Double? = null[m]現在位置から料金所までの道なり距離省略可
signalDist: Double? = null[m]現在位置から信号機までの道なり距離省略可
directDist: Double? = null[m]現在位置から案内地点までの道なり距離省略可
joinPointDist: Double? = null[m]現在位置から合流地点までの道なり距離省略可
destDist: Double? = null[m]現在位置から目的地までの道なり距離省略可
mapVer: String地図バージョン省略不可
setRoute: Booleanルート設定中フラグ。
True:ルートあり
False:ルートなし
省略不可
streetName: String道路名称省略不可
streetYomi: String道路名称ヨミデータ省略不可
linkId: Int現在走行中の道路のリンクID省略不可無効値の場合-1
guidePointId: Int? = null案内地点ID 直近案内地点のリンクID省略可
passPointId: Int通過地点ID 直近通過地点のリンクID省略不可
debug: String? = nullデバッグ情報省略可
forward: Booleanリンク順方向走行フラグ
True:リンク格納方向と同方向に走行中
False:リンク格納方向と異なる方向に走行中
省略不可
distToNode: Double[m]現在位置から前方ノードまでの道なり距離省略不可
linkLen: Double[m] リンク全長省略不可
tileId: Int自車位置のタイルID省略不可
startX: DoubleリンクIDの始点ノードのX座標
(リンクIDの原点に対応した相対値で単位なし、0~1)
省略不可
startY: DoubleリンクIDの始点ノードのY座標
(リンクIDの原点に対応した相対値で単位なし、0~1)
省略不可
endX: DoubleリンクIDの終点ノードのX座標
(リンクIDの原点に対応した相対値で単位なし、0~1)
省略不可
endY: DoubleリンクIDの終点ノードのY座標
(リンクIDの原点に対応した相対値で単位なし、0~1)
省略不可
Table.4.2.1.2 - class AppNaviInfo



名称:class RouteActionLog説明:ユーザーアプリケーションから受領するナビルート情報省略可否備考
actionTime: Stringアクション発生時刻
UTC時刻(ISO 8601)
省略不可
actionType: Intアクション種別
0:不明
1:出発(案内開始)
2:出発(案内再開)
3:到着
4:新規探索
5:再探索
6:オートリルートまたはルートアドバイザーによるリルート
7:ルート削除
8:自宅探索(Androidのみ)
省略不可
pointInfo: List<PointInfo>POI情報配列のリスト。PointInfoを参照。省略不可
estToll: Int? = null推測される高速料金[円]省略可
fMbrToll: Int? = null無料会員ルートの高速料金[円]省略可
pMbrToll: Int? = null有料会員ルートの高速料金[(円]省略可
fMbrFuelCons: Double? = null無料会員基準ルートでのガソリン消費量
[L]、EVの場合は[kWh]
省略可
pMbrFuelCons: Double? = null有料会員基準ルートでのガソリン消費量
[L]、EVの場合は[kWh]
省略可
Table.4.2.1.3 - class RouteActionLog



名称:class PointInfo説明:アプリから受領するナビルート情報に含まれるPOI情報省略可否備考
kind: Int地点種別
0:目的地
1:立ち寄り地
2:ルート始点
   (地点名称・地点ヨミは省略)
3:ルート削除地点
省略不可
index: Int地点番号
出発地を0とし、立ち寄る順で番号を付与する
省略不可
name: String? = null地点名称省略可
nameVoice: String? = null地点ヨミ。地点名の仮名表記省略可
lat: Double地点緯度[degree] 世界測地系省略不可
lon: Double地点経度[degree] 世界測地系省略不可
Table.4.2.1.4 - class PointInfo



名称:class VehicleInfo説明:アプリから受領する車両情報省略可否備考
engType: Int0:「選択しない」/「不明」
1:「ガソリン車」
2:「ディーゼル車」
3:「LPG車」
4:「HV」
5:「PHEV」
6:「EV」
7:「FCEV」
省略不可
engModel: String車検証に記載の型式省略不可
classificationNum: String車検証に記載の類別区分番号省略不可
hasIdlingStop: booleanアイドリングストップ有無
True:有り
False:無し
省略不可EV時はFalse
engDisplacement: Int排気量[cc]省略不可EV時は-1
weight: Int車両重量[kg]省略不可
width: Int車幅[cm]省略不可
height: Int車高[cm]省略不可
maxLoadCapacity: Int最大積載量[kg]省略不可
actualLoadCapacity: Int実積載量[kg]省略不可
vehicleId: String車両ID
未使用の場合はを以下を指定
"00000000-0000-0000-0000-000000000000"
省略不可
evBatteryCapacity: DoubleEV最大電池量[kWh]省略不可
fuelCapacity: Doubleガソリンタンク量[L]省略不可
wltc: DoubleWLTC値[km/L]。EVの場合は [Wh/km]省略不可
Table.4.2.1.5 - class VehicleInfo

データリスト(外部データ)

ID説明データ型値[単位]必須/任意
1マップマッチング緯度double[degree]必須
2マップマッチング経度double[degree]必須
3速度double[m/s]走行速度必須
4路上フラグint0: 自車位置がオフロード、1: 自車位置がオンロード必須
5車両向きdouble[degree]必須
6リンク種別int0 Roundaboutリンク
1 本線(上下線非分離)リンク
2 本線(上下線分離)リンク
3 連結路(本線間の渡り線)リンク
4 交差点内リンク
5 連結路(ランプ)リンク
6 本線と同一路線の側道
7 SA等測線リンク
必須
7道路種別int0:高速
1:都市高速
2:国道
3:主要地方道
4:県道
5:一般道路(幹線)
6:一般道路(その他)
7:導入路
8:細街路1
9:細街路2
10:フェリー航路
任意
8トンネルフラグint0: トンネル外、1: トンネル内必須
9高速道路フラグint0: 高速道路以外を走行中、1: 高速道路走行中必須
10料金所までの距離double[m]現在位置から料金所までの道なり距離任意
11信号機までの距離double[m]現在位置から信号機までの道なり距離任意
12案内地点までの距離double[m]現在位置から案内地点までの道なり距離任意
13合流地点までの距離double[m]現在位置から合流地点までの道なり距離任意
14目的地までの距離double[m]現在位置から目的地までの道なり距離任意
15地図バージョンstring必須
16ルート設定フラグint0: ルートなし、1: ルートあり必須
17道路名称string必須
18道路名称ヨミデータstring必須
19リンクIDint現在走行中の道路のリンクID必須
20案内地点IDint直近案内地点のリンクID任意
21通過地点IDint直近通過地点のリンクID必須
22デバッグ情報string任意
23順方向走行フラグint0:リンク格納方向と異なる方向に走行中
1:リンク格納方向と同方向に走行中
必須
24前方ノードまでの距離double[m]現在位置から前方ノードまでの道なり距離必須
25リンク長double[m] リンク全長必須
26タイルIDint自車位置のタイルID必須
27リンクID始点ノードのX座標doubleタイル内の正規化座標必須
28リンクID始点ノードのY座標doubleタイル内の正規化座標必須
29リンクID終点ノードのX座標doubleタイル内の正規化座標必須
30リンクID終点ノードのY座標doubleタイル内の正規化座標必須
31積算走行距離double[m] SDK起動時点からの積算走行距離必須
32区間走行距離double[m] ルートありの間の積算走行距離。ルートなしの場合常に0必須
33前回レコードからの走行距離double[m]必須
34乗車中フラグint0:乗車中ではない、1:乗車中と判定必須
Table.4.2.1.6 - ナビ情報のデータリスト



IDデータ種別データ型値 [単位]必須/任意
1アクション発生時刻stringUTC時刻 (ISO8601)必須
2アクション種別int0:不明
1:出発(案内開始)
2:出発(案内再開)
3:到着
4:新規探索
5:再探索
6:オートリルートまたはルートアドバイザーによるリルート
7:ルート削除
8:自宅探索(Androidのみ)
必須
3POI情報配列array出発地、目的地、立ち寄り地、等の配列(ID4~9を単位)必須
4   ├ 地点種別int0:目的地
1:立ち寄り地
2:ルート始点
   (POI情報配列は地点名称・ヨミは無し)
3:ルート削除地点
必須
5   ├ 地点番号int出発地を0とし、立ち寄る順で番号を付与する必須
6   ├ 地点名称string任意
7   ├ 地点ヨミstring地点名の仮名表記任意
8   ├ 地点緯度int[degree] 世界測地系必須
9   ├ 地点経度int[degree] 世界測地系必須
10推測される高速料金int[円]任意
11無料会員基準ルートでの高速料金int[円]任意
12有料会員基準ルートでの高速料金int[円]任意
13無料会員基準ルートでのガソリン消費量int[L]、EVの場合は[kWh]任意
14有料会員基準ルートでのガソリン消費量int[L]、EVの場合は[kWh]任意
Table.4.2.1.7 - ルートアクションログのデータリスト




IDデータ種別データ型値 [単位]必須/任意
1エンジンタイプint0:「選択しない」/「不明」
1:「ガソリン車」
2:「ディーゼル車」
3:「LPG車」
4:「HV」
5:「PHEV」
6:「EV」
7:「FCEV」
必須
2型式string例:"ABC-AB1"必須
3類別区分番号string例:"0001"必須
4アイドリングストップ有無int0:無し、1:有り、EVの場合は項目自体無し任意
5排気量int[cc]、EVの場合は項目自体無し任意
6車両重量int[kg]必須
7車幅int[cm]必須
8車高int[cm]必須
9最大積載量int[kg]必須
10実積載量int[kg]必須
11車両IDstringUUID必須
12EV最大電池量double[kWh]必須
13ガソリンタンク量double[L]必須
14WLTC値double[km/L]、EVの場合は[Wh/km]必須
Table.4.2.1.8 - 車両情報のデータリスト