Fleet Tracking - Last Mile Fleet

FleetEngineDeliveryVehicleLocationProvider

google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider

送货车辆位置信息提供程序。

此类扩展了 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
提供用于向 Fleet Engine 验证客户端身份的 JSON Web 令牌。
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 或为 Infinity,则系统会忽略该阈值,并且不会将车辆位置视为过时。
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 接口

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

google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider

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
提供用于向 Fleet Engine 验证客户端身份的 JSON Web 令牌。
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 小时(以毫秒为单位)。如果阈值小于零或为 Infinity,系统将忽略该阈值,并且不会将车辆位置视为过时。

FleetEngineDeliveryFleetLocationProviderUpdateEvent 接口

google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent 接口

FleetEngineDeliveryFleetLocationProvider.update 事件触发时传递给事件处理程序的事件对象。

deliveryVehicles optional
类型:  Array<DeliveryVehicle> optional
查询返回的配送车辆列表。不可修改。