API Reference
| API name | description | parameter | parameter type | return | 必須・任意 | 補足 |
|---|---|---|---|---|---|---|
| activate | プローブデータ収集SDKの起動処理 | 配信条件 | request:SdkUploadRequest | SdkResult： OK、ERROR、HAS_ACTIVATED、NOT_PERMITTED | 必須 | 認証パラメータ以外の変更には、 一度deactivateが必要 |
| deactivate | プローブデータ収集SDKの終了処理 | none | none | SdkResult： OK、ERROR、NOT_ACTIVATED | 必須 | |
| updateKey | クラウドアクセス時に使用する 認証Key情報を設定・更新する | 認証情報 | authKey:SdkAuthKey | SdkResult： OK、ERROR、NOT_ACTIVATED | 任意 | 認証パラメータがactivityで未指定の場合、 本APIで認証パラメータを設定する |
| checkHealth | プローブデータ収集SDKの生存確認 | 詳細フラグ | needDetails:BOOL | SdkHealthInfo： SdkHealthInfo.statusCode= OK、ERROR、NOT_ACTIVATED | 任意 | needDetail=true時に、 戻り値のSdkHealthInfoの全項目が有効値となる。 false時には、 SdkHealthInfo.statusCodeのみが有効値で、 他はnullとなる。 |
| setVehicleId | 配信時に付帯する車両IDを設定する | 車両ID | vehicleId:String | SdkResult： OK、NOT_ACTIVATED、HAS_REGISTERED | 任意 | vehicleIdが既設定時には、 HAS_REGISTEREDを返す |
setContext (Androidのみ) | コンテキストを設定する | context | context : Context | なし | 必須 | プローブデータ収集SDKのインスタンスの生成後、 かつactivateの前に、本API実行が必須。 |
requestLocationPermission (iOSのみ) | 位置情報の権限を取得する | none | none | SdkResult： OK、NOT_PERMITTED | 必須 | |
| requestActivityPermission (iOSのみ) | アクティビティの権限を取得する | none | none | SdkResult： OK、NOT_PERMITTED | 必須 | |
| startBackgroundPositioning (iOSのみ) | バックグラウンド実行時の 位置情報更新を有効にする | none | none | なし | 任意 | バックグラウンドでの位置情報更新を 有効にしたい場合は必須。 |
stopBackgroundPositioning (iOSのみ) | バックグラウンド実行時の 位置情報更新を無効にする | none | none | なし | 任意 | |
| isBackgroundPositioning (iOSのみ) | バックグラウンド実行時の 位置情報更新を確認する | none | none | Boolean: True=有効、 False=無効 | 任意 |
| ID | API name | description | parameter | parameter type | return | 必須・任意 | 補足 |
|---|---|---|---|---|---|---|---|
| 1 | addNaviInfo | 自車位置が更新された時に、 プローブデータ収集SDKに通知する | ナビ情報 | naviInfo: AppNaviInfo | SdkResult： OK、NOT_ACTIVATED | 必須 | |
| 2 | addRouteActionLog | ナビルート情報が更新された時に、 プローブデータ収集SDKに通知する | ナビルート情報 | routeActionLog: RouteActionLog | SdkResult： OK、NOT_ACTIVATED | 必須 | |
| 3 | setVehicleInfo | 車両情報を、 プローブデータ収集SDKに通知する | 車両情報 | vehicleInfo: VehicleInfo | SdkResult： OK、NOT_ACTIVATED | 任意 |
| 名称：enum SdkResult | 説明：SDK動作結果 | 備考 |
|---|---|---|
| OK | 正常動作 | 排他的に利用 |
| ERROR | 下記以外のエラー動作 | 排他的に利用 |
| HAS_ACTIVATED | SDKが既にActivate済み | 排他的に利用 |
| NOT_ACTIVATED | SDKがActivateされていない | 排他的に利用 |
| NOT_PERMITTED | OSでの権限が不許可 | 排他的に利用 |
| HAS_REGISTERED | 値が既に設定済み | 排他的に利用 |
| 名称：class SdkUploadRequest | 説明：配信条件 | 備考 | 省略可否 |
|---|---|---|---|
| authKey: SdkAuthKey? = null | 認証方法に用いる文字列など | 省略可 | |
| vehicleId: String? = null | 車両ID | 省略可 | |
| url: String | 配信先のURL | 省略不可 | |
| uploadInterval: Int | 配信周期[秒] | 省略不可 | |
| uploadDataType: List<SdkUploadDataType> | 配信するデータ種別のList | 省略不可 |
| 名称：enum SdkAuthType | 説明：認証方法 | 備考 |
|---|---|---|
| TOKEN | Tokenによる認証 | トークン方式は未使用 |
| API_KEY | API keyによる認証 |
| 名称：class SdkAuthKey | 説明 | 備考 | 省略可否 |
|---|---|---|---|
| type: SdkAuthType | 認証に用いるkeyの種別 | "API_KEY"のみ使用 | 省略不可 |
| value: String | 認証に用いるkeyの値 | 省略不可 |
| 名称：enum SdkUploadDataType | 説明：アップロードデータ種別 | 備考 |
|---|---|---|
| SENSOR_INFO | センサー情報 (下記のa,b,c,d全て) | 重複指定可 |
| NAVI_INFO | ナビ情報 | 重複指定可 |
| ROUTE_ACTION_LOG | ルートアクションログ情報 | 重複指定可 |
| VEHICLE_INFO | 車両情報 | 重複指定可 |
| LOCATION_INFO | 補正後の位置情報 (a) | 重複指定可 |
| GNSS_INFO | GNSS位置情報・受信状況 (b) | 重複指定可 |
| HW_SENSOR_INFO | 加速度・ジャイロ情報 (c) | 重複指定可 |
| ACTIVITY_INFO | アクティビティ情報 (d) | 重複指定可 |
| 名称：class SdkHealthInfo | 説明：SDKの動作状況 | 備考 |
|---|---|---|
| statusCode : SdkResult | SDK動作結果 | |
| uploadInterval : Int? = null | 配信周期[秒] | needDetails=False時には、NULL |
| uploadDataType: List<SdkUploadDataType>? = null | 配信するデータ種別のList | needDetails=False時には、NULL |
| authKey: SdkAuthKey? = null | 認証に用いるkeyの種別とkeyの値 | needDetails=False時には、NULL |
| vehicleId: String? = null | 車両ID | needDetails=False時には、NULL |
| url : String? = null | 配信先のURL | needDetails=False時には、NULL |
| isUploading : Boolean? = null | 定期配信のON・OFF | needDetails=False時には、NULL |
| connectionStatus : Boolean? =null | 直前の配信の成功・失敗 | needDetails=False時には、NULL |
| sensorStatus : Boolean? = null | センサ(加速度・ジャイロ)取得部の動作状態 | needDetails=False時には、NULL |
| fusionLocationStatus : Boolean? = null | fusionLocation取得部の動作状態 | needDetails=False時には、NULL |
| gnssStatus : Boolean? = null | GNSS取得部の動作状態 (Androidのみ有効) | needDetails=False時には、NULL |
| 名称：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) | 省略不可 |
| 名称：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] | 省略可 |
| 名称：class PointInfo | 説明：アプリから受領するナビルート情報に含まれるPOI情報 | 省略可否 | 備考 |
|---|---|---|---|
| kind: Int | 地点種別 0:目的地 1:立ち寄り地 2:ルート始点 (地点名称・地点ヨミは省略) 3:ルート削除地点 | 省略不可 | |
| index: Int | 地点番号 出発地を0とし、立ち寄る順で番号を付与する | 省略不可 | |
| name: String? = null | 地点名称 | 省略可 | |
| nameVoice: String? = null | 地点ヨミ。地点名の仮名表記 | 省略可 | |
| lat: Double | 地点緯度[degree] 世界測地系 | 省略不可 | |
| lon: Double | 地点経度[degree] 世界測地系 | 省略不可 |
| 名称：class VehicleInfo | 説明：アプリから受領する車両情報 | 省略可否 | 備考 |
|---|---|---|---|
| engType: Int | 0：「選択しない」/「不明」 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: Double | EV最大電池量[kWh] | 省略不可 | |
| fuelCapacity: Double | ガソリンタンク量[L] | 省略不可 | |
| wltc: Double | WLTC値[km/L]。EVの場合は [Wh/km] | 省略不可 |
Data List
| ID | 説明 | データ型 | 値[単位] | 必須/任意 |
|---|---|---|---|---|
| 1 | マップマッチング緯度 | double | [degree] | 必須 |
| 2 | マップマッチング経度 | double | [degree] | 必須 |
| 3 | 速度 | double | [m/s]走行速度 | 必須 |
| 4 | 路上フラグ | int | 0: 自車位置がオフロード、1: 自車位置がオンロード | 必須 |
| 5 | 車両向き | double | [degree] | 必須 |
| 6 | リンク種別 | int | 0 Roundaboutリンク 1 本線（上下線非分離）リンク 2 本線（上下線分離）リンク 3 連結路（本線間の渡り線）リンク 4 交差点内リンク 5 連結路（ランプ）リンク 6 本線と同一路線の側道 7 SA等測線リンク | 必須 |
| 7 | 道路種別 | int | 0:高速 1:都市高速 2:国道 3:主要地方道 4:県道 5:一般道路（幹線） 6:一般道路（その他） 7:導入路 8:細街路1 9:細街路2 10:フェリー航路 | 任意 |
| 8 | トンネルフラグ | int | 0: トンネル外、1: トンネル内 | 必須 |
| 9 | 高速道路フラグ | int | 0: 高速道路以外を走行中、1: 高速道路走行中 | 必須 |
| 10 | 料金所までの距離 | double | [m]現在位置から料金所までの道なり距離 | 任意 |
| 11 | 信号機までの距離 | double | [m]現在位置から信号機までの道なり距離 | 任意 |
| 12 | 案内地点までの距離 | double | [m]現在位置から案内地点までの道なり距離 | 任意 |
| 13 | 合流地点までの距離 | double | [m]現在位置から合流地点までの道なり距離 | 任意 |
| 14 | 目的地までの距離 | double | [m]現在位置から目的地までの道なり距離 | 任意 |
| 15 | 地図バージョン | string | 必須 | |
| 16 | ルート設定フラグ | int | 0: ルートなし、1: ルートあり | 必須 |
| 17 | 道路名称 | string | 必須 | |
| 18 | 道路名称ヨミデータ | string | 必須 | |
| 19 | リンクID | int | 現在走行中の道路のリンクID | 必須 |
| 20 | 案内地点ID | int | 直近案内地点のリンクID | 任意 |
| 21 | 通過地点ID | int | 直近通過地点のリンクID | 必須 |
| 22 | デバッグ情報 | string | 任意 | |
| 23 | 順方向走行フラグ | int | 0:リンク格納方向と異なる方向に走行中 1:リンク格納方向と同方向に走行中 | 必須 |
| 24 | 前方ノードまでの距離 | double | [m]現在位置から前方ノードまでの道なり距離 | 必須 |
| 25 | リンク長 | double | [m] リンク全長 | 必須 |
| 26 | タイルID | int | 自車位置のタイル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 | 乗車中フラグ | int | 0:乗車中ではない、1:乗車中と判定 | 必須 |
| ID | データ種別 | データ型 | 値 [単位] | 必須/任意 |
|---|---|---|---|---|
| 1 | アクション発生時刻 | string | UTC時刻 (ISO8601) | 必須 |
| 2 | アクション種別 | int | 0:不明 1:出発（案内開始） 2:出発（案内再開） 3:到着 4:新規探索 5:再探索 6:オートリルートまたはルートアドバイザーによるリルート 7:ルート削除 8:自宅探索(Androidのみ) | 必須 |
| 3 | POI情報配列 | array | 出発地、目的地、立ち寄り地、等の配列(ID4~9を単位) | 必須 |
| 4 | ├ 地点種別 | int | 0:目的地 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] | 任意 |
| ID | データ種別 | データ型 | 値 [単位] | 必須/任意 |
|---|---|---|---|---|
| 1 | エンジンタイプ | int | 0：「選択しない」/「不明」 1：「ガソリン車」 2：「ディーゼル車」 3：「LPG車」 4：「HV」 5：「PHEV」 6：「EV」 7：「FCEV」 | 必須 |
| 2 | 型式 | string | 例："ABC-AB1" | 必須 |
| 3 | 類別区分番号 | string | 例："0001" | 必須 |
| 4 | アイドリングストップ有無 | int | 0:無し、1:有り、EVの場合は項目自体無し | 任意 |
| 5 | 排気量 | int | [cc]、EVの場合は項目自体無し | 任意 |
| 6 | 車両重量 | int | [kg] | 必須 |
| 7 | 車幅 | int | [cm] | 必須 |
| 8 | 車高 | int | [cm] | 必須 |
| 9 | 最大積載量 | int | [kg] | 必須 |
| 10 | 実積載量 | int | [kg] | 必須 |
| 11 | 車両ID | string | UUID | 必須 |
| 12 | EV最大電池量 | double | [kWh] | 必須 |
| 13 | ガソリンタンク量 | double | [L] | 必須 |
| 14 | WLTC値 | double | [km/L]、EVの場合は[Wh/km] | 必須 |
| ID | データ種別 | データ型 | 値 [単位] | 必須/任意 |
|---|---|---|---|---|
| 1 | GNSS位置 緯度 | double | [degree] | 必須 |
| 2 | GNSS位置 経度 | double | [degree] | 必須 |
| 3 | GNSS方位 | double | [degree] デバイスが移動している方向 | 必須 |
| 4 | GNSS高度 | double | [m] | 必須 |
| 5 | 捕捉衛星数 | int | 必須 | |
| 6 | 測位使用衛星数 | int | 必須 | |
| 7 | 電波強度 | double | [dBHz] | 必須 |
| 8 | GNSS有効 | int | 0:無効、1:有効 | 必須 |
| ID | データ種別 | データ型 | 値 [単位] | 必須/任意 |
|---|---|---|---|---|
| 1 | 補正後の位置 緯度 | double | [degree] | 必須 |
| 2 | 補正後の位置 経度 | double | [degree] | 必須 |
| 3 | 補正後の方位 | double | [degree] デバイスが移動している方向 | 必須 |
| 4 | 補正後の高度 | double | [m] | 必須 |
| 5 | 補正後の速度 | double | [m/s] | 必須 |
| ID | データ種別 | データ型 | 値 [単位] | 必須/任意 |
|---|---|---|---|---|
| 1~3 | XYZ方向加速度 | double | [m/s^2]、各xyz方向 座標系はOS依存 | 必須 |
| 4~6 | 回転加速度 | double | [rad/s]、各xyz軸の回転方向 座標系はOS依存 | 必須 |
| ID | データ種別 | データ型 | 値 [単位] | 必須/任意 |
|---|---|---|---|---|
| 1 | ActivityStatus | int | SDKで判定したアクティビティ 0：動作不明 1：歩行中 2：乗車中 | 必須 |
| 2 | アクティビティ検知結果 (Activity) | int | OS標準APIで取得したアクティビティ 取り得る値はOS依存 | 必須 |
| 3 | アクティビティ検知結果 (confidence) | int | OS標準APIで取得したアクティビティの信頼度 取り得る値はOS依存 | 必須 |
| ID | データ種別 | データ型 | 値 [単位] | 必須/任意 |
|---|---|---|---|---|
| 1 | OS情報 | int | 0：不明 1：Android 2：iOS 81：iOSシミュレータ | 必須 |
| 2 | OSバージョン情報 | string | OSバージョン情報 | 必須 |
| 3 | ユーザー識別情報 | string | Android：ANDROID_ID(OSから取得) iOS：UUID(OSから取得) | 必須 |