Fleet Tracking - Last Mile Fleet

FleetEngineDeliveryVehicleLocationProvider クラス

google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider class
extends PollingLocationProvider
library "journeySharing"

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

const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing");
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
省略可
アクティブなポリラインに適用されるカスタマイズ。アクティブなポリラインは、車両が現在走行しているルートの一部に対応します。

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

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

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

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

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

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

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

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

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

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

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

    指定されたパラメータとその用途のリストについては、DeliveryVehiclePolylineCustomizationFunctionParams をご覧ください。
taskFilterOptions
省略可
タイプ: FleetEngineTaskFilterOptions optional
タスクの取得時に適用するフィルタ オプション。オプションには、特定の車両、時間、タスクのステータスなどがあります。
taskMarkerCustomization
省略可
タイプ: (function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional
タスクマーカーに適用されたカスタマイズ。タスク マーカーは、配送車両に割り当てられた各タスクの予定位置にレンダリングされます。

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

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

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

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

FleetEngineTaskFilterOptions インターフェース

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

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

FleetEngineDeliveryVehicleLocationProviderUpdateEvent インターフェース

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

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

FleetEngineDeliveryFleetLocationProvider クラス

google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider class
extends PollingLocationProvider
library "journeySharing"

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

const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing");
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
省略可
タイプ: string optional
配送車両を取得するときに適用するフィルタ。このフィルタは Fleet Engine に直接渡されます。

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

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

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

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

FleetEngineDeliveryFleetLocationProviderUpdateEvent インターフェース

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

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