Fleet Tracking - Last Mile Fleet

FleetEngineDeliveryVehicleLocationProvider クラス

google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider クラス

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

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

const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
FleetEngineDeliveryVehicleLocationProvider
FleetEngineDeliveryVehicleLocationProvider(options)
パラメータ: 
Fleet Engine の配達車両用の新しい位置情報プロバイダを作成します。
deliveryVehicleId
タイプ:  string
この位置情報プロバイダが監視する車両の ID。このフィールドを設定して車両を追跡します。
shouldShowOutcomeLocations
タイプ:  boolean optional
必要に応じて、タスクの結果の場所をユーザーに表示できるようにします。
shouldShowTasks
タイプ:  boolean optional
必要に応じて、ユーザーが取得したタスクを表示できるようにします。
staleLocationThresholdMillis
タイプ:  number
このフィールドは読み取り専用です。車両の位置情報が古いと判断されるしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。
taskFilterOptions
タスクの取得時に適用するフィルタ オプションを返します。
継承: isPolling、 pollingIntervalMillis
継承: addListener
error
function(event)
引数: 
位置情報プロバイダでエラーが発生したときにトリガーされるイベント。
update
function(event)
引数: 
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineDeliveryVehicleLocationProviderOptions インターフェース

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

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

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

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

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

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

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

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

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

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

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

    指定されたパラメータとその使用方法の一覧については、DeliveryVehiclePolylineCustomizationFunctionParams をご覧ください。
shouldShowOutcomeLocations optional
タイプ:  boolean optional
取得したタスクの結果の場所を表示または非表示にするブール値。
shouldShowTasks optional
タイプ:  boolean optional
タスクの表示 / 非表示を切り替えるブール値。これを false に設定すると、タスクを取得するために ListTasks エンドポイントが呼び出されなくなります。次のバス停のみが表示されます。
staleLocationThresholdMillis optional
タイプ:  number optional
車両の位置情報が古いと判断されるしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間（ミリ秒単位）です。しきい値が 0 未満または Infinity の場合、しきい値は無視され、車両の位置情報は古いと見なされません。
takenPolylineCustomization optional
取得したポリラインに適用されたカスタマイズ。取得済みのポリラインは、車両がすでに通過したルートの一部に対応します。

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

    指定されたパラメータとその使用方法の一覧については、DeliveryVehiclePolylineCustomizationFunctionParams をご覧ください。
taskFilterOptions optional
タイプ:  FleetEngineTaskFilterOptions optional
タスクの取得時に適用するフィルタ オプション。オプションには、特定の車両、時間、タスクのステータスを含めることができます。
taskMarkerCustomization optional
タイプ:  (function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional
タスク マーカーに適用されたカスタマイズ。タスク マーカーは、配達車両に割り当てられた各タスクの予定地にレンダリングされます。

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

    指定されたパラメータとその使用方法の一覧については、TaskMarkerCustomizationFunctionParams をご覧ください。
taskOutcomeMarkerCustomization optional
タイプ:  function(TaskMarkerCustomizationFunctionParams): void optional
タスク結果マーカーに適用されたカスタマイズ。タスクの結果マーカーは、配送車両に割り当てられた各タスクの実際の結果の位置にレンダリングされます。

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

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

FleetEngineTaskFilterOptions インターフェース

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

Delivery Vehicle Location Provider のタスクのフィルタ オプション。
completionTimeFrom optional
タイプ:  Date optional
タスクの完了時刻の下限（境界値を含まない）。指定した時刻以降に完了したタスクをフィルタするために使用されます。
completionTimeTo optional
タイプ:  Date optional
タスクの完了時刻の上限（境界値を含まない）。指定した時刻より前に完了したタスクをフィルタするために使用されます。
state optional
タイプ:  string optional
タスクの状態。有効な値は OPEN または CLOSED です。

FleetEngineDeliveryVehicleLocationProviderUpdateEvent インターフェース

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

FleetEngineDeliveryVehicleLocationProvider.update イベントがトリガーされたときにイベント ハンドラに渡されるイベント オブジェクト。
completedVehicleJourneySegments optional
タイプ:  Array<VehicleJourneySegment> optional
この車両が完了したルート セグメント。変更不可。
deliveryVehicle optional
タイプ:  DeliveryVehicle optional
更新によって返される配達車両のデータ構造。変更不可。
tasks optional
タイプ:  Array<Task> optional
この配達車両が対応するタスクのリスト。変更不可。

FleetEngineDeliveryFleetLocationProvider クラス

google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider クラス

Delivery Fleet Location Provider。

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

const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing") を呼び出してアクセスします。
Maps JavaScript API のライブラリをご覧ください。
FleetEngineDeliveryFleetLocationProvider
FleetEngineDeliveryFleetLocationProvider(options)
パラメータ: 
Fleet Engine で追跡される車両の新しい位置情報プロバイダを作成します。
deliveryVehicleFilter
タイプ:  string optional
配達車両を取得するときに適用されるフィルタ。
locationRestriction
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
配送車両を追跡する範囲。境界が設定されていない場合、配送車両は追跡されません。位置情報に関係なくすべての配送車両を追跡するには、地球全体に相当する境界を設定します。
staleLocationThresholdMillis
タイプ:  number
このフィールドは読み取り専用です。車両の位置情報が古いと判断されるしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。
継承: isPolling、 pollingIntervalMillis
継承: addListener
update
function(event)
引数: 
Fleet Engine データ更新リクエストが完了したときにトリガーされるイベント。
継承: ispollingchange

FleetEngineDeliveryFleetLocationProviderOptions インターフェース

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

配送車両の位置情報プロバイダのオプション。
authTokenFetcher
タイプ:  AuthTokenFetcher
Fleet Engine に対してクライアントを認証するための JSON ウェブトークンを提供します。
projectId
タイプ:  string
Google Cloud コンソールから取得したコンシューマーのプロジェクト ID。
deliveryVehicleFilter optional
タイプ:  string optional
配達車両を取得するときに適用するフィルタ クエリ。このフィルタは Fleet Engine に直接渡されます。

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

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

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

    指定されたパラメータとその使用方法の一覧については、DeliveryVehicleMarkerCustomizationFunctionParams をご覧ください。
locationRestriction optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
位置情報プロバイダがインスタンス化された直後に車両を追跡する緯度と経度の境界。設定されていない場合、位置情報プロバイダは車両の追跡を開始しません。FleetEngineDeliveryFleetLocationProvider.locationRestriction を使用して境界を設定し、追跡を開始します。位置情報に関係なくすべての配送車両を追跡するには、地球全体に相当する境界を設定します。
staleLocationThresholdMillis optional
タイプ:  number optional
車両の位置情報が古いと判断されるしきい値。車両の最終更新位置がこのしきい値より古い場合、車両は表示されません。デフォルトは 24 時間（ミリ秒単位）です。しきい値がゼロ未満または Infinity の場合、しきい値は無視され、車両の位置が古いと見なされることはありません。

FleetEngineDeliveryFleetLocationProviderUpdateEvent インターフェース

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

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