Shipment Tracking

FleetEngineShipmentLocationProvider class

google.maps.journeySharing.FleetEngineShipmentLocationProvider class

貨運地點供應商。

這個類別會擴充 PollingLocationProvider。

撥打 const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
參數： 
為 Fleet Engine 貨運追蹤功能建立新的位置資訊提供者。
trackingId
類型：  string
這個位置資訊供應器觀察的工作追蹤 ID。設定這個欄位即可開始追蹤。
已繼承： isPolling、 pollingIntervalMillis
refresh
refresh()
參數：無
傳回值：  void
明確重新整理追蹤位置。
繼承： addListener
error
function(event)
引數： 
位置資訊供應器發生錯誤時觸發的事件。
update
function(event)
引數： 
Fleet Engine 資料更新要求完成時觸發的事件。
繼承： ispollingchange

FleetEngineShipmentLocationProviderOptions 介面

google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions 介面

貨運位置資訊供應商的選項。
authTokenFetcher
類型：  AuthTokenFetcher
提供 JSON Web Token，用於向 Fleet Engine 驗證用戶端。
projectId
類型：  string
Google Cloud 控制台中的消費者專案 ID。
activePolylineCustomization optional
類型：  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
自訂設定已套用至有效折線。有效折線對應於車輛目前行經的路段。

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

    如要查看提供的參數及其用途清單，請參閱 ShipmentPolylineCustomizationFunctionParams。
deliveryVehicleMarkerCustomization optional
類型：  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
已套用至送貨車輛標記的自訂項目。

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

    如要查看提供的參數及其用途清單，請參閱 ShipmentMarkerCustomizationFunctionParams。
destinationMarkerCustomization optional
類型：  (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
套用至目的地標記的自訂項目。

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

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

將這個值設為 0、Infinity 或負值，即可停用自動位置更新功能。如果追蹤 ID 參數 (例如貨運位置資訊供應商的貨運追蹤 ID) 或篩選選項 (例如視埠界線或車隊位置資訊供應商的屬性篩選器) 變更，系統會擷取一次新的位置資訊更新。

預設輪詢間隔為 5000 毫秒，也是最短間隔。如果將輪詢間隔設為較低的正值，系統會儲存並使用 5000。
remainingPolylineCustomization optional
類型：  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
自訂設定會套用至其餘折線。剩餘折線對應車輛尚未開始行駛的路段。

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

    如要查看提供的參數及其用途清單，請參閱 ShipmentPolylineCustomizationFunctionParams。
takenPolylineCustomization optional
類型：  (function(ShipmentPolylineCustomizationFunctionParams): void)|PolylineOptions optional
已套用至所選折線的自訂設定。已行駛的折線對應至車輛已行駛的路徑部分。

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

    如要查看提供的參數及其用途清單，請參閱 ShipmentPolylineCustomizationFunctionParams。
trackingId optional
類型：  string optional
工作追蹤 ID，在位置資訊供應器例項化後立即追蹤。如未指定，位置資訊供應商不會開始追蹤任何工作；請使用 FleetEngineShipmentLocationProvider.trackingId 設定追蹤 ID 並開始追蹤。

FleetEngineShipmentLocationProviderUpdateEvent 介面

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent 介面

觸發 FleetEngineShipmentLocationProvider.update 事件時，傳遞至事件處理常式的事件物件。
taskTrackingInfo optional
類型：  TaskTrackingInfo optional
更新作業傳回的工作追蹤資訊結構。無法修改。