Fleet Tracking - On Demand Rides & Delivery (beta)

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。車両を追跡する場合は、このフィールドを設定します。
継承: isPolling、 pollingIntervalMillis
継承: addListener
error
function(event)
引数: 
位置情報プロバイダでエラーが発生したときにトリガーされるイベント。
update
function(event)
引数: 
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineVehicleLocationProviderOptions インターフェース

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

車両位置情報プロバイダのオプション。
authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON Web Token を提供します。
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 ミリ秒（最小間隔）です。ポーリング間隔をゼロ以外の小さい値に設定した場合は、5000 が使用されます。
remainingPolylineCustomization optional
タイプ:  (function(VehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional
残りのポリラインに適用されるカスタマイズ。残りのポリラインは、車両がまだ走行していないルートの部分に対応しています。

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

    指定されたパラメータとその用途の一覧については、VehiclePolylineCustomizationFunctionParams をご覧ください。
staleLocationThresholdMillis optional
タイプ:  number optional
古い車両位置情報のしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間（ミリ秒単位）です。しきい値が 0 未満または 無限大の場合、しきい値は無視され、車両の位置情報は古い位置情報と見なされません。
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 クラス

フリート位置情報プロバイダ。

このクラスは 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
車両の取得時に適用されるフィルタ。
継承: isPolling、 pollingIntervalMillis
継承: addListener
update
function(event)
引数: 
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineFleetLocationProviderOptions インターフェース

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

フリート位置情報プロバイダのオプション。
authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON Web Token を提供します。
projectId
タイプ:  string
Google Cloud コンソールから取得したコンシューマのプロジェクト ID。
locationRestriction optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
位置情報プロバイダがインスタンス化された直後に車両を追跡する緯度と経度の境界。設定されていない場合、位置情報プロバイダは車両の追跡を開始しません。FleetEngineFleetLocationProvider.locationRestriction を使用して境界を設定し、追跡を開始します。位置情報に関係なくすべての車両を追跡するには、地球全体に相当する境界を設定します。
staleLocationThresholdMillis optional
タイプ:  number optional
古い車両位置情報のしきい値。車両の最終更新日時がこのしきい値より前の場合、車両は表示されません。デフォルトは 24 時間（ミリ秒単位）です。しきい値が 0 未満または無限大の場合、しきい値は無視され、車両の位置情報は古いと見なされません。
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
クエリによって返された車両のリスト。変更不可。