Fleet Tracking - On Demand Rides & Delivery

FleetEngineVehicleLocationProvider クラス

class google.maps.journeySharing.FleetEngineVehicleLocationProvider extends PollingLocationProvider, LocationProvider
library "journeySharing"

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

const {FleetEngineVehicleLocationProvider} = await google.maps.importLibrary("journeySharing");
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 ウェブトークンを提供します。
projectId
タイプ: string
Google Cloud コンソールから取得したコンシューマのプロジェクト ID。
activePolylineCustomization
省略可
タイプ: (function(VehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional
アクティブなポリラインに適用されるカスタマイズ。アクティブなポリラインは、車両が現在走行しているルートの一部に対応します。

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

    指定されたパラメータとその用途のリストについては、VehiclePolylineCustomizationFunctionParams をご覧ください。
destinationMarkerCustomization
省略可
車両のルートの目的地マーカーに適用されるカスタマイズ。

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

    指定されたパラメータとその用途の一覧については、VehicleWaypointMarkerCustomizationFunctionParams をご覧ください。
intermediateDestinationMarkerCustomization
省略可
車両ルートの中間目的地のマーカーに適用されるカスタマイズ。

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

    指定されたパラメータとその用途の一覧については、VehicleWaypointMarkerCustomizationFunctionParams をご覧ください。
originMarkerCustomization
省略可
車両のルートの出発地マーカーに適用されるカスタマイズ。

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

    指定されたパラメータとその用途の一覧については、VehicleWaypointMarkerCustomizationFunctionParams をご覧ください。
pollingIntervalMillis
省略可
タイプ: number optional
位置情報の更新を取得する最小間隔（ミリ秒）。位置情報の更新の取得に pollingIntervalMillis を超える時間がかかる場合、現在の更新が完了するまで次の更新は開始されません。

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

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

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

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

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

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

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

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

FleetEngineVehicleLocationProviderUpdateEvent インターフェース

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

FleetEngineVehicleLocationProvider.update イベントがトリガーされたときにイベント ハンドラに渡されるイベント オブジェクト。
trips
省略可
タイプ: Array<Trip> optional
この車両が完了したルートのリスト。変更不可。
vehicle
省略可
タイプ: Vehicle optional
更新によって返される車両データ構造。変更不可。

FleetEngineFleetLocationProvider クラス

class google.maps.journeySharing.FleetEngineFleetLocationProvider extends PollingLocationProvider, LocationProvider
library "journeySharing"

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

const {FleetEngineFleetLocationProvider} = await google.maps.importLibrary("journeySharing");
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 ウェブトークンを提供します。
projectId
タイプ: string
Google Cloud コンソールから取得したコンシューマのプロジェクト ID。
locationRestriction
省略可
タイプ: LatLngBounds|LatLngBoundsLiteral optional
位置情報プロバイダがインスタンス化された直後に車両を追跡する緯度 / 経度の境界。設定されていない場合、位置情報プロバイダは車両の追跡を開始しません。FleetEngineFleetLocationProvider.locationRestriction を使用して境界を設定し、追跡を開始します。場所に関係なくすべての車両を追跡するには、地球全体に相当する境界を設定します。
staleLocationThresholdMillis
省略可
タイプ: number optional
古い車両位置のしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間（ミリ秒単位）です。しきい値が 0 未満または Infinity の場合、しきい値は無視され、車両の位置は古いとは見なされません。
vehicleFilter
省略可
タイプ: string optional
車両の取得時に適用するフィルタクエリ。このフィルタは Fleet Engine に直接渡されます。

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

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

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

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

FleetEngineFleetLocationProviderUpdateEvent インターフェース

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

FleetEngineFleetLocationProvider.update イベントがトリガーされたときにイベント ハンドラに渡されるイベント オブジェクト。
vehicles
省略可
タイプ: Array<Vehicle> optional
クエリによって返された車両のリスト。変更不可。