Fleet Tracking - Last Mile Fleet

FleetEngineDeliveryVehicleLocationProvider 類別

class google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider extends PollingLocationProvider, LocationProvider
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
提供 JSON Web Token,用於向 Fleet Engine 驗證用戶端。
projectId
類型: string
Google Cloud 控制台中的消費者專案 ID。
activePolylineCustomization
選填
自訂設定已套用至使用中的折線。有效折線對應車輛目前行經的部分路線。

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

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

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

    如需提供的參數清單和用途,請參閱 DeliveryVehicleMarkerCustomizationFunctionParams。
plannedStopMarkerCustomization
選填
類型: (function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optional
套用至預定停靠點標記的自訂設定。

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

    如需提供的參數清單和用途,請參閱 PlannedStopMarkerCustomizationFunctionParams。
pollingIntervalMillis
選填
類型: number optional
擷取位置更新的最短時間間隔 (以毫秒為單位)。如果擷取位置更新的時間超過 pollingIntervalMillis,系統會等到目前的位置更新完成後,才會開始下一次位置更新。

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

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

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

    如需提供的參數清單和用途,請參閱 DeliveryVehiclePolylineCustomizationFunctionParams。
shouldShowOutcomeLocations
選填
類型: boolean optional
布林值,用於顯示或隱藏所擷取任務的結果位置。
shouldShowTasks
選填
類型: boolean optional
用於顯示或隱藏工作的布林值。如果將這個值設為 false,系統就不會呼叫 ListTasks 端點來擷取工作。系統只會顯示接下來的車輛停靠站。
staleLocationThresholdMillis
選填
類型: number optional
車輛位置過時的門檻。如果車輛的上次更新位置早於這個門檻,系統就不會顯示該車輛。預設值為 24 小時 (以毫秒為單位)。如果門檻小於 0 或 Infinity,系統會忽略門檻,且不會將車輛位置視為過時。
takenPolylineCustomization
選填
自訂設定已套用至所選折線。已行駛折線對應至車輛已行經的部分路線。

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

    如需提供的參數清單和用途,請參閱 DeliveryVehiclePolylineCustomizationFunctionParams。
taskFilterOptions
選填
類型: FleetEngineTaskFilterOptions optional
擷取工作時要套用的篩選器選項。選項包括特定車輛、時間和工作狀態。
taskMarkerCustomization
選填
類型: (function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional
套用至工作標記的自訂設定。系統會根據指派給配送車輛的每項工作,在預定位置顯示工作標記。

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

    如需提供的參數清單和用途,請參閱 TaskMarkerCustomizationFunctionParams。
taskOutcomeMarkerCustomization
選填
類型: function(TaskMarkerCustomizationFunctionParams): void optional
套用至工作結果標記的自訂設定。系統會在指派給配送車輛的每項工作實際結果位置,顯示工作結果標記。

使用這個欄位指定自訂樣式 (例如標記圖示) 和互動功能 (例如點擊處理)。
  • 如果指定 MarkerOptions 物件,系統會在建立標記後,將其中指定的變更套用至標記,並覆寫預設選項 (如有)。
  • 如果指定函式,系統會在建立標記時叫用一次,然後才將標記加入地圖檢視。(在這個叫用中,函式參數物件中的 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 類別

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

Delivery Fleet 位置資訊提供者。

const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineDeliveryFleetLocationProvider
FleetEngineDeliveryFleetLocationProvider(options)
參數:
為 Fleet Engine 追蹤的車輛建立新的位置資訊提供者。
deliveryVehicleFilter
類型: string optional
擷取配送車輛時套用的篩選器。
locationRestriction
追蹤外送車輛的範圍。如未設定範圍,系統就不會追蹤任何貨車。如要追蹤所有外送車輛 (不限位置),請將範圍設為整個地球。
staleLocationThresholdMillis
類型: number
這個欄位為唯讀。車輛位置過時的門檻。如果車輛上次更新位置的時間早於這個門檻,系統就不會顯示該車輛。
繼承: isPolling、pollingIntervalMillis
沿用: addListener
update
function(event)
Fleet Engine 資料更新要求完成時觸發的事件。
沿用: ispollingchange

FleetEngineDeliveryFleetLocationProviderOptions 介面

介面 google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions

貨運車隊位置供應商的選項。

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

    如需提供的參數清單和用途,請參閱 DeliveryVehicleMarkerCustomizationFunctionParams。
locationRestriction
選填
位置資訊供應器例項化後,立即追蹤車輛的經緯度範圍。如未設定,位置資訊提供者就不會開始追蹤任何車輛;請使用 FleetEngineDeliveryFleetLocationProvider.locationRestriction 設定邊界並開始追蹤。如要追蹤所有外送車輛 (不限位置),請將範圍設為整個地球。
staleLocationThresholdMillis
選填
類型: number optional
車輛位置過時的門檻。如果車輛的上次更新位置早於這個門檻,系統就不會顯示該車輛。預設值為 24 小時 (以毫秒為單位)。如果門檻小於零或 Infinity,系統會忽略門檻,且不會將車輛位置視為過時。

FleetEngineDeliveryFleetLocationProviderUpdateEvent 介面

介面 google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent

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

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