Fleet Tracking - Last Mile Fleet

FleetEngineDeliveryVehicleLocationProvider class

google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider class

交貨車輛位置資訊提供者。

這個類別會擴充 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
傳回擷取工作時要套用的篩選器選項。
已繼承: isPollingpollingIntervalMillis
繼承: addListener
error
function(event)
引數: 
位置資訊供應器發生錯誤時觸發的事件。
update
function(event)
Fleet Engine 資料更新要求完成時觸發的事件。
繼承: ispollingchange

FleetEngineDeliveryVehicleLocationProviderOptions 介面

google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions 介面

配送車輛位置資訊供應商的選項。

authTokenFetcher
類型:  AuthTokenFetcher
提供 JSON Web Token,用於向 Fleet Engine 驗證用戶端。
projectId
類型:  string
Google Cloud 控制台中的消費者專案 ID。
activePolylineCustomization optional
自訂設定已套用至有效折線。有效折線對應於車輛目前行經的路段。

使用這個欄位指定自訂樣式 (例如折線顏色) 和互動性 (例如點擊處理)。
  • 如果指定 PolylineOptions 物件,系統會在建立折線後,將其中指定的變更套用至折線,並覆寫預設選項 (如有)。
  • 如有指定函式,系統會在建立折線時呼叫該函式一次。(在此呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論對應這條折線的資料是否已變更,只要折線的座標變更,或位置資訊供應商從 Fleet Engine 接收資料,系統就會呼叫這個函式。

    如要查看提供的參數及其用途清單,請參閱 DeliveryVehiclePolylineCustomizationFunctionParams
deliveryVehicleId optional
類型:  string optional
位置資訊提供者例項化後,要立即追蹤的送貨車輛 ID。如未指定,位置資訊供應商不會開始追蹤任何車輛;請使用 FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId 設定 ID 並開始追蹤。
deliveryVehicleMarkerCustomization optional
已套用至送貨車輛標記的自訂項目。

使用這個欄位指定自訂樣式 (例如標記圖示) 和互動性 (例如點擊處理)。
  • 如果指定 MarkerOptions 物件,系統會在建立標記後,將其中指定的變更套用至標記,並覆寫預設選項 (如有)。
  • 如果指定函式,系統會在建立標記時呼叫該函式一次,然後將標記加入地圖檢視區塊。(在此呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論對應這個標記的資料是否已變更,當位置資訊供應器從 Fleet Engine 接收資料時,系統都會呼叫這個函式。

    如要查看提供的參數及其用途清單,請參閱 DeliveryVehicleMarkerCustomizationFunctionParams
plannedStopMarkerCustomization optional
類型:  (function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optional
自訂項目已套用至預計停靠站標記。

使用這個欄位指定自訂樣式 (例如標記圖示) 和互動性 (例如點擊處理)。
  • 如果指定 MarkerOptions 物件,系統會在建立標記後,將其中指定的變更套用至標記,並覆寫預設選項 (如有)。
  • 如果指定函式,系統會在建立標記時呼叫該函式一次,然後將標記加入地圖檢視區塊。(在此呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論對應這個標記的資料是否已變更,當位置資訊供應器從 Fleet Engine 接收資料時,系統都會呼叫這個函式。

    如要查看提供的參數及其用途清單,請參閱 PlannedStopMarkerCustomizationFunctionParams
pollingIntervalMillis optional
類型:  number optional
以毫秒為單位,擷取位置資訊更新之間的最短時間。如果擷取位置更新資訊的時間超過 pollingIntervalMillis,系統會等到目前的位置更新完成後,才會開始下一次更新。

將這個值設為 0 可停用定期位置資訊更新。如果位置資訊供應器觀察到的任何參數有所變更,系統就會擷取新的位置資訊更新。

預設輪詢間隔為 5000 毫秒,這是最短間隔。如果您將輪詢間隔設為較低的非零值,系統會使用 5000。
remainingPolylineCustomization optional
自訂設定會套用至其餘折線。剩餘折線對應車輛尚未開始行駛的路段。

使用這個欄位指定自訂樣式 (例如折線顏色) 和互動性 (例如點擊處理)。
  • 如果指定 PolylineOptions 物件,系統會在建立折線後,將其中指定的變更套用至折線,並覆寫預設選項 (如有)。
  • 如有指定函式,系統會在建立折線時呼叫該函式一次。(在此呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論對應這條折線的資料是否已變更,只要折線的座標變更,或位置資訊供應商從 Fleet Engine 接收資料,系統就會呼叫這個函式。

    如要查看提供的參數及其用途清單,請參閱 DeliveryVehiclePolylineCustomizationFunctionParams
shouldShowOutcomeLocations optional
類型:  boolean optional
布林值,用於顯示或隱藏所擷取工作的結果位置。
shouldShowTasks optional
類型:  boolean optional
布林值,用於顯示或隱藏工作。如果設為 false,系統就不會呼叫 ListTasks 端點來擷取工作。系統只會顯示即將停靠的站點。
staleLocationThresholdMillis optional
類型:  number optional
車輛位置資訊過時的門檻。如果車輛的最新位置資訊超過這個時間門檻,系統就不會顯示車輛。預設值為 24 小時 (以毫秒為單位)。如果門檻小於 0 或無限大,系統會忽略門檻,且不會將車輛位置視為過時。
takenPolylineCustomization optional
已套用至所選折線的自訂設定。已行駛的折線對應至車輛已行駛的路徑部分。

使用這個欄位指定自訂樣式 (例如折線顏色) 和互動性 (例如點擊處理)。
  • 如果指定 PolylineOptions 物件,系統會在建立折線後,將其中指定的變更套用至折線,並覆寫預設選項 (如有)。
  • 如有指定函式,系統會在建立折線時呼叫該函式一次。(在此呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論對應這條折線的資料是否已變更,只要折線的座標變更,或位置資訊供應商從 Fleet Engine 接收資料,系統就會呼叫這個函式。

    如要查看提供的參數及其用途清單,請參閱 DeliveryVehiclePolylineCustomizationFunctionParams
taskFilterOptions optional
類型:  FleetEngineTaskFilterOptions optional
擷取工作時要套用的篩選器選項。選項可能包括特定車輛、時間和工作狀態。
taskMarkerCustomization optional
類型:  (function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional
已套用至工作標記的自訂項目。系統會在指派給送貨車輛的每項工作預定地點,顯示工作標記。

使用這個欄位指定自訂樣式 (例如標記圖示) 和互動性 (例如點擊處理)。
  • 如果指定 MarkerOptions 物件,系統會在建立標記後,將其中指定的變更套用至標記,並覆寫預設選項 (如有)。
  • 如果指定函式,系統會在建立標記時呼叫該函式一次,然後將標記加入地圖檢視區塊。(在此呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論對應這個標記的資料是否已變更,當位置資訊供應器從 Fleet Engine 接收資料時,系統都會呼叫這個函式。

    如要查看提供的參數及其用途清單,請參閱 TaskMarkerCustomizationFunctionParams
taskOutcomeMarkerCustomization optional
類型:  function(TaskMarkerCustomizationFunctionParams): void optional
自訂項目已套用至工作結果標記。系統會在指派給送貨車輛的每項工作實際結果位置,顯示工作結果標記。

使用這個欄位指定自訂樣式 (例如標記圖示) 和互動性 (例如點擊處理)。
  • 如果指定 MarkerOptions 物件,系統會在建立標記後,將其中指定的變更套用至標記,並覆寫預設選項 (如有)。
  • 如果指定函式,系統會在建立標記時呼叫該函式一次,然後將標記加入地圖檢視區塊。(在此呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論對應這個標記的資料是否已變更,當位置資訊供應器從 Fleet Engine 接收資料時,系統都會呼叫這個函式。

    如要查看提供的參數及其用途清單,請參閱 TaskMarkerCustomizationFunctionParams

FleetEngineTaskFilterOptions interface

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 class

google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider class

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
這是唯讀欄位。車輛位置資訊過時的門檻。如果車輛的最新位置資訊超過這個時間門檻,系統就不會顯示車輛。
已繼承: isPollingpollingIntervalMillis
繼承: addListener
update
function(event)
Fleet Engine 資料更新要求完成時觸發的事件。
繼承: ispollingchange

FleetEngineDeliveryFleetLocationProviderOptions 介面

google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions 介面

配送車隊位置資訊供應商的選項。

authTokenFetcher
類型:  AuthTokenFetcher
提供 JSON Web Token,用於向 Fleet Engine 驗證用戶端。
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 物件,系統會在建立標記後,將其中指定的變更套用至標記,並覆寫預設選項 (如有)。
  • 如果指定函式,系統會在建立標記時呼叫該函式一次,然後將標記加入地圖檢視區塊。(在此呼叫中,函式參數物件中的 isNew 參數會設為 true)。此外,無論對應這個標記的資料是否已變更,當位置資訊供應器從 Fleet Engine 接收資料時,系統都會呼叫這個函式。

    如要查看提供的參數及其用途清單,請參閱 DeliveryVehicleMarkerCustomizationFunctionParams
locationRestriction optional
類型:  LatLngBounds|LatLngBoundsLiteral optional
位置資訊提供者例項化的經緯度界限,用於追蹤車輛。如果未設定,位置資訊供應商不會開始追蹤任何車輛;請使用 FleetEngineDeliveryFleetLocationProvider.locationRestriction 設定界線並開始追蹤。如要追蹤所有送貨車輛,不論位置為何,請將界線設為整個地球。
staleLocationThresholdMillis optional
類型:  number optional
車輛位置資訊過時的門檻。如果車輛的最新位置資訊超過這個時間門檻,系統就不會顯示車輛。預設值為 24 小時 (以毫秒為單位)。如果門檻小於零或為「無限大」,系統會忽略門檻,且不會將車輛位置視為過時。

FleetEngineDeliveryFleetLocationProviderUpdateEvent 介面

google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent 介面

觸發 FleetEngineDeliveryFleetLocationProvider.update 事件時,傳遞至事件處理常式的事件物件。

deliveryVehicles optional
類型:  Array<DeliveryVehicle> optional
查詢傳回的送貨車輛清單。無法修改。