Fleet Tracking - On Demand Rides & Delivery

FleetEngineVehicleLocationProvider クラス

google.maps.journeySharing.FleetEngineVehicleLocationProvider クラス

車両位置情報プロバイダ。

このクラスは PollingLocationProvider を拡張します。

const {FleetEngineVehicleLocationProvider} = await google.maps.importLibrary("journeySharing") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。

FleetEngineVehicleLocationProvider
FleetEngineVehicleLocationProvider(options)
パラメータ: 
Fleet Engine 車両の新しい位置情報プロバイダを作成します。
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params)
パラメータ: 
戻り値: なし
アクティブなポリラインを速読の速度に応じて色付けするポリラインのカスタマイズ関数。この関数を FleetEngineVehicleLocationProviderOptions.activePolylineCustomization として指定すると、アクティブなポリラインの交通状況を考慮したポリラインがレンダリングされます。
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params)
パラメータ: 
戻り値: なし
残りのポリラインを速読の速度に応じて色付けするポリラインのカスタマイズ関数。この関数を FleetEngineVehicleLocationProviderOptions.remainingPolylineCustomization として指定して、残りのポリラインの交通状況を考慮したポリラインをレンダリングします。
staleLocationThresholdMillis
タイプ:  number
このフィールドは読み取り専用です。車両の位置情報が古いと判断されるしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。
vehicleId
タイプ:  string
この位置情報プロバイダが監視する車両の ID。このフィールドを設定して車両を追跡します。
継承: isPollingpollingIntervalMillis
継承: addListener
error
function(event)
引数: 
位置情報プロバイダでエラーが発生したときにトリガーされるイベント。
update
function(event)
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineVehicleLocationProviderOptions インターフェース

google.maps.journeySharing.FleetEngineVehicleLocationProviderOptions インターフェース

車両位置情報プロバイダのオプション。

authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON ウェブトークンを提供します。
projectId
タイプ:  string
Google Cloud コンソールから取得したコンシューマーのプロジェクト ID。
activePolylineCustomization optional
タイプ:  (function(VehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional
アクティブなポリラインに適用されたカスタマイズ。アクティブなポリラインは、車両が現在走行しているルートの一部に対応します。

このフィールドを使用して、カスタム スタイル(ポリラインの色など)とインタラクティビティ(クリック処理など)を指定します。
  • PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合は、ポリラインの作成時に 1 回呼び出されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます)。また、この関数は、ポリラインの座標が変更されたとき、またはこのポリラインに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、VehiclePolylineCustomizationFunctionParams をご覧ください。
destinationMarkerCustomization optional
タイプ:  (function(VehicleWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional
車両の乗車地のマーカーに適用されるカスタマイズ。

このフィールドを使用して、カスタム スタイル(マーカー アイコンなど)とインタラクティビティ(クリック処理など)を指定します。
  • MarkerOptions オブジェクトが指定されている場合、マーカーの作成後に、そのオブジェクトで指定された変更がマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合、マーカーが作成されたときに、マップビューに追加される前に 1 回呼び出されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます)。また、この関数は、このマーカーに対応するデータが変更されたかどうかに関係なく、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、VehicleWaypointMarkerCustomizationFunctionParams をご覧ください。
intermediateDestinationMarkerCustomization optional
タイプ:  (function(VehicleWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional
車両の乗車の中間地点マーカーに適用されるカスタマイズ。

このフィールドを使用して、カスタム スタイル(マーカー アイコンなど)とインタラクティビティ(クリック処理など)を指定します。
  • MarkerOptions オブジェクトが指定されている場合、マーカーの作成後に、そのオブジェクトで指定された変更がマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合、マーカーが作成されたときに、マップビューに追加される前に 1 回呼び出されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます)。また、この関数は、このマーカーに対応するデータが変更されたかどうかに関係なく、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、VehicleWaypointMarkerCustomizationFunctionParams をご覧ください。
originMarkerCustomization optional
タイプ:  (function(VehicleWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional
車両の乗車地のマーカーに適用されるカスタマイズ。

このフィールドを使用して、カスタム スタイル(マーカー アイコンなど)とインタラクティビティ(クリック処理など)を指定します。
  • MarkerOptions オブジェクトが指定されている場合、マーカーの作成後に、そのオブジェクトで指定された変更がマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合、マーカーが作成されたときに、マップビューに追加される前に 1 回呼び出されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます)。また、この関数は、このマーカーに対応するデータが変更されたかどうかに関係なく、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、VehicleWaypointMarkerCustomizationFunctionParams をご覧ください。
pollingIntervalMillis optional
タイプ:  number optional
位置情報の更新を取得する最小間隔(ミリ秒単位)。位置情報の更新の取得に pollingIntervalMillis より長い時間がかかる場合、次の位置情報の更新は現在の更新が完了するまで開始されません。

この値を 0 に設定すると、定期的な位置情報の更新が無効になります。位置情報プロバイダによって監視されているパラメータのいずれかが変更されると、新しい位置情報の更新が取得されます。

デフォルトのポーリング間隔は 5, 000 ミリ秒(最小間隔)です。ポーリング間隔をゼロ以外の小さい値に設定すると、5, 000 が使用されます。
remainingPolylineCustomization optional
タイプ:  (function(VehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional
残りのポリラインに適用されたカスタマイズ。残りのポリラインは、車両がまだ通過していないルートの一部に対応します。

このフィールドを使用して、カスタム スタイル(ポリラインの色など)とインタラクティビティ(クリック処理など)を指定します。
  • PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合は、ポリラインの作成時に 1 回呼び出されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます)。また、この関数は、ポリラインの座標が変更されたとき、またはこのポリラインに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、VehiclePolylineCustomizationFunctionParams をご覧ください。
staleLocationThresholdMillis optional
タイプ:  number optional
車両の位置情報が古いと判断されるしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間(ミリ秒単位)です。しきい値が 0 未満または Infinity の場合、しきい値は無視され、車両の位置情報は古いと見なされません。
takenPolylineCustomization optional
タイプ:  (function(VehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional
取得したポリラインに適用されたカスタマイズ。取得済みのポリラインは、車両がすでに通過したルートの一部に対応します。

このフィールドを使用して、カスタム スタイル(ポリラインの色など)とインタラクティビティ(クリック処理など)を指定します。
  • PolylineOptions オブジェクトが指定されている場合、そのオブジェクトで指定された変更は、ポリラインの作成後にポリラインに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合は、ポリラインの作成時に 1 回呼び出されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます)。また、この関数は、ポリラインの座標が変更されたとき、またはこのポリラインに対応するデータが変更されたかどうかにかかわらず、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、VehiclePolylineCustomizationFunctionParams をご覧ください。
vehicleId optional
タイプ:  string optional
位置情報プロバイダのインスタンス化直後に追跡する車両 ID。指定しない場合、位置情報プロバイダは車両の追跡を開始しません。FleetEngineVehicleLocationProvider.vehicleId を使用して ID を設定し、追跡を開始します。
vehicleMarkerCustomization optional
タイプ:  (function(VehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional
車両マーカーに適用されるカスタマイズ。

このフィールドを使用して、カスタム スタイル(マーカー アイコンなど)とインタラクティビティ(クリック処理など)を指定します。
  • MarkerOptions オブジェクトが指定されている場合、マーカーの作成後に、そのオブジェクトで指定された変更がマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合、マーカーが作成されたときに、マップビューに追加される前に 1 回呼び出されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます)。また、この関数は、このマーカーに対応するデータが変更されたかどうかに関係なく、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、VehicleMarkerCustomizationFunctionParams をご覧ください。

FleetEngineVehicleLocationProviderUpdateEvent インターフェース

google.maps.journeySharing.FleetEngineVehicleLocationProviderUpdateEvent インターフェース

FleetEngineVehicleLocationProvider.update イベントがトリガーされたときにイベント ハンドラに渡されるイベント オブジェクト。

trips optional
タイプ:  Array<Trip> optional
この車両で完了したルートのリスト。変更不可。
vehicle optional
タイプ:  Vehicle optional
更新によって返される車両データ構造。変更不可。

FleetEngineFleetLocationProvider クラス

google.maps.journeySharing.FleetEngineFleetLocationProvider クラス

Fleet Location Provider。

このクラスは PollingLocationProvider を拡張します。

const {FleetEngineFleetLocationProvider} = await google.maps.importLibrary("journeySharing") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。

FleetEngineFleetLocationProvider
FleetEngineFleetLocationProvider(options)
パラメータ: 
Fleet Engine で追跡される車両の新しい位置情報プロバイダを作成します。
locationRestriction
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
車両を追跡する範囲。境界が設定されていない場合、車両は追跡されません。場所に関係なくすべての車両を追跡するには、地球全体に相当する境界を設定します。
staleLocationThresholdMillis
タイプ:  number
このフィールドは読み取り専用です。車両の位置情報が古いと判断されるしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。
vehicleFilter
タイプ:  string optional
車両の取得時に適用されるフィルタ。
継承: isPollingpollingIntervalMillis
継承: addListener
update
function(event)
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineFleetLocationProviderOptions インターフェース

google.maps.journeySharing.FleetEngineFleetLocationProviderOptions インターフェース

フリート ロケーション プロバイダのオプション。

authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON ウェブトークンを提供します。
projectId
タイプ:  string
Google Cloud コンソールから取得したコンシューマーのプロジェクト ID。
locationRestriction optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
位置情報プロバイダがインスタンス化された直後に車両を追跡する緯度と経度の境界。設定されていない場合、位置情報プロバイダは車両の追跡を開始しません。FleetEngineFleetLocationProvider.locationRestriction を使用して境界を設定し、追跡を開始します。場所に関係なくすべての車両を追跡するには、地球全体に相当する境界を設定します。
staleLocationThresholdMillis optional
タイプ:  number optional
車両の位置情報が古いと判断されるしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間(ミリ秒単位)です。しきい値がゼロ未満または Infinity の場合、しきい値は無視され、車両の位置が古いと見なされることはありません。
vehicleFilter optional
タイプ:  string optional
車両を取得するときに適用するフィルタ クエリ。このフィルタは Fleet Engine に直接渡されます。

サポートされている形式については、ListVehiclesRequest.filter をご覧ください。

属性の有効なフィルタには、接頭辞「attributes」が必要です。たとえば、attributes.x = "y"attributes."x y" = "z" です。
vehicleMarkerCustomization optional
タイプ:  function(VehicleMarkerCustomizationFunctionParams): void optional
車両マーカーに適用されたカスタマイズ。

このフィールドを使用して、カスタム スタイル(マーカー アイコンなど)とインタラクティビティ(クリック処理など)を指定します。
  • MarkerOptions オブジェクトが指定されている場合、マーカーの作成後に、そのオブジェクトで指定された変更がマーカーに適用され、デフォルトのオプションが存在する場合は上書きされます。
  • 関数が指定されている場合、マーカーが作成されたときに、マップビューに追加される前に 1 回呼び出されます。(この呼び出しでは、関数パラメータ オブジェクトの isNew パラメータが true に設定されます)。また、この関数は、このマーカーに対応するデータが変更されたかどうかに関係なく、位置情報プロバイダが Fleet Engine からデータを受信したときに呼び出されます。

    指定されたパラメータとその使用方法の一覧については、VehicleMarkerCustomizationFunctionParams をご覧ください。

FleetEngineFleetLocationProviderUpdateEvent インターフェース

google.maps.journeySharing.FleetEngineFleetLocationProviderUpdateEvent インターフェース

FleetEngineFleetLocationProvider.update イベントがトリガーされたときにイベント ハンドラに渡されるイベント オブジェクト。

vehicles optional
タイプ:  Array<Vehicle> optional
クエリで返された車両のリスト。変更不可。