Shipment Tracking

FleetEngineShipmentLocationProvider 类

google.maps.journeySharing.FleetEngineShipmentLocationProvider 类

送货地点提供商。

此类扩展了 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
提供 JSON Web 令牌，用于向 Fleet Engine 对客户端进行身份验证。
projectId
类型：string
来自 Google Cloud Console 的使用方的项目 ID。
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、无限或负值，系统会停用位置信息自动更新。如果跟踪 ID 参数（例如，货运地点提供商的物流跟踪 ID）或过滤选项（例如，车队位置提供商的视口边界或属性过滤器）发生更改，系统将获取一次新的位置更新。

默认的最小时间间隔为 5000 毫秒。如果您将轮询间隔设置为较低的正值，则系统会存储和使用 5000。
trackingId optional
类型：string optional
在营业地点提供程序实例化后要立即跟踪的任务的跟踪 ID。如果未指定，则位置信息提供程序不会开始跟踪任何任务；请使用 FleetEngineShipmentLocationProvider.trackingId 设置跟踪 ID 并开始跟踪。

FleetEngineShipmentLocationProviderUpdateEvent 接口

google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent接口

触发 FleetEngineShipmentLocationProvider.update 事件时传递给事件处理脚本的事件对象。
taskTrackingInfo optional
类型：TaskTrackingInfo optional
更新返回的任务跟踪信息结构。无法修改。