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 ウェブトークンを提供します。
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 または 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 クラス

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

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

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

属性に対して有効なフィルタには、属性の接頭辞を付ける必要があります。たとえば、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
クエリによって返される車両のリスト。変更できません。