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 控制台中的使用方项目 ID。
activePolylineCustomization 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、无穷大或负值会停用自动位置信息更新。如果跟踪 ID 参数（例如，配送位置提供商的配送跟踪 ID）或过滤选项（例如，舰队位置提供商的视口边界或属性过滤条件）发生变化，系统会提取一次新的位置更新。

默认的轮询间隔时间为 5, 000 毫秒，最小值为 5, 000 毫秒。如果将轮询间隔设置为较小的正值，则会存储和使用 5000。
remainingPolylineCustomization optional
自定义内容已应用于其余多段线。剩下的多段线对应于车辆尚未开始穿过的路线的一部分。

使用此字段可以指定自定义样式（例如多段线颜色）和互动性（例如点击处理）。
  • 如果指定了 PolylineOptions 对象，则在其中创建的更改会在多段线创建后应用于多段线，并覆盖其默认选项（如果存在）。
  • 如果指定了函数，则在创建多段线时系统会调用一次该函数。（进行此调用时，函数参数对象中的 isNew 参数设为 true。）此外，当多段线的坐标发生变化，或位置信息提供程序从 Fleet Engine 接收数据时，系统会调用此函数，而不考虑与此多段线对应的数据是否已更改。

    有关提供的参数及其用途的列表，请参阅 ShipmentPolylineCustomizationFunctionParams。
takenPolylineCustomization 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
更新返回的任务跟踪信息结构。不可修改。