Fleet Tracking - On Demand Rides & Delivery (beta)

FleetEngineVehicleLocationProvider

google.maps.journeySharing.FleetEngineVehicleLocationProvider

车辆位置信息提供程序。

此类扩展了 PollingLocationProvider

通过调用 const {FleetEngineVehicleLocationProvider} = await google.maps.importLibrary("journeySharing") 进行访问。请参阅 Maps JavaScript API 中的库

FleetEngineVehicleLocationProvider
FleetEngineVehicleLocationProvider(options)
参数
为 Fleet Engine 车辆创建新的位置信息提供程序。
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params)
参数
返回值:None
多段线自定义函数,用于根据当前多段线的速度读数为其着色。将此函数指定为 FleetEngineVehicleLocationProviderOptions.activePolylineCustomization,为活跃多段线渲染交通感知多段线。
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params)
参数
返回值:None
多段线自定义函数,用于根据剩余多段线的速度读数为其着色。将此函数指定为 FleetEngineVehicleLocationProviderOptions.remainingPolylineCustomization,为其余多段线渲染交通感知多段线。
staleLocationThresholdMillis
类型number
此字段是只读字段。过时车辆位置信息的阈值。如果最近更新的车辆位置早于此阈值,则不会显示这辆车。
vehicleId
类型string
此位置信息提供程序观察到的车辆的 ID。设置此字段以跟踪车辆。
已继承isPollingpollingIntervalMillis
已继承addListener
error
function(event)
参数
在位置信息提供程序遇到错误时触发的事件。
update
function(event)
完成 Fleet Engine 数据更新请求时触发的事件。
已继承ispollingchange

FleetEngineVehicleLocationProviderOptions 接口

google.maps.journeySharing.FleetEngineVehicleLocationProviderOptions 接口

车辆位置信息提供程序的选项。

authTokenFetcher
提供 JSON Web 令牌,用于向 Fleet Engine 验证客户端的身份。
projectId
类型string
Google Cloud 控制台中的使用方项目 ID。
activePolylineCustomization optional
自定义设置会应用到当前使用的多段线。活跃多段线对应于车辆当前穿过的路线的一部分。

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

    有关提供的参数及其用途的列表,请参阅 VehiclePolylineCustomizationFunctionParams
destinationMarkerCustomization optional
自定义内容已应用于车辆行程目的地标记。

您可以使用此字段指定自定义样式(例如标记图标)和互动性(例如点击处理)。
  • 如果指定了 MarkerOptions 对象,则其中指定的更改会在标记创建后应用于该标记,并覆盖其默认选项(如果存在)。
  • 如果指定了函数,则在创建标记后、将标记添加到地图视图之前,系统会调用该函数一次。(在此调用中,函数参数对象中的 isNew 参数设置为 true。)此外,当位置信息提供程序从 Fleet Engine 接收数据时,系统会调用此函数,无论与此标记对应的数据是否已更改。

    如需查看提供的参数及其用途的列表,请参阅 VehicleWaypointMarkerCustomizationFunctionParams
intermediateDestinationMarkerCustomization optional
应用于车辆行程中间目的地标记的自定义。

您可以使用此字段指定自定义样式(例如标记图标)和互动性(例如点击处理)。
  • 如果指定了 MarkerOptions 对象,则其中指定的更改会在标记创建后应用于该标记,并覆盖其默认选项(如果存在)。
  • 如果指定了函数,则在创建标记后、将标记添加到地图视图之前,系统会调用该函数一次。(在此调用中,函数参数对象中的 isNew 参数设置为 true。)此外,当位置信息提供程序从 Fleet Engine 接收数据时,系统会调用此函数,无论与此标记对应的数据是否已更改。

    如需查看提供的参数及其用途的列表,请参阅 VehicleWaypointMarkerCustomizationFunctionParams
originMarkerCustomization optional
自定义内容已应用于车辆行程出发地标记。

您可以使用此字段指定自定义样式(例如标记图标)和互动性(例如点击处理)。
  • 如果指定了 MarkerOptions 对象,则其中指定的更改会在标记创建后应用于该标记,并覆盖其默认选项(如果存在)。
  • 如果指定了函数,则在创建标记后、将标记添加到地图视图之前,系统会调用该函数一次。(在此调用中,函数参数对象中的 isNew 参数设置为 true。)此外,当位置信息提供程序从 Fleet Engine 接收数据时,系统会调用此函数,无论与此标记对应的数据是否已更改。

    如需查看提供的参数及其用途的列表,请参阅 VehicleWaypointMarkerCustomizationFunctionParams
pollingIntervalMillis optional
类型number optional
提取位置信息更新的最短时间(以毫秒为单位)。如果获取位置更新所需的时间超过 pollingIntervalMillis,则只有当前位置更新完成后,系统才会开始下一次位置更新。

将此值设置为 0 会停用定期位置信息更新。如果位置信息提供程序观察到的任何参数发生变化,系统会提取新的位置信息更新。

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

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

    有关提供的参数及其用途的列表,请参阅 VehiclePolylineCustomizationFunctionParams
staleLocationThresholdMillis optional
类型number optional
过时车辆位置信息的阈值。如果车辆上次更新的位置信息早于此阈值,则不会显示车辆。默认值为 24 小时(以毫秒为单位)。如果阈值小于 0 或无穷大,则系统会忽略阈值,并且车辆位置信息不会被视为已过时。
takenPolylineCustomization optional
自定义设置应用于所拍摄的多段线。采用的多段线对应于车辆已穿过路线的一部分。

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

    有关提供的参数及其用途的列表,请参阅 VehiclePolylineCustomizationFunctionParams
vehicleId optional
类型string optional
在位置信息提供程序实例化后立即要跟踪的车辆 ID。如果未指定,位置信息提供程序不会开始跟踪任何车辆;请使用 FleetEngineVehicleLocationProvider.vehicleId 设置 ID 并开始跟踪。
vehicleMarkerCustomization optional
类型(function(VehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional
对车辆标记应用的自定义。

您可以使用此字段指定自定义样式(例如标记图标)和互动性(例如点击处理)。
  • 如果指定了 MarkerOptions 对象,则其中指定的更改会在标记创建后应用于该标记,并覆盖其默认选项(如果存在)。
  • 如果指定了函数,则在创建标记后、将标记添加到地图视图之前,系统会调用该函数一次。(在此调用中,函数参数对象中的 isNew 参数设置为 true。)此外,当位置信息提供程序从 Fleet Engine 接收数据时,系统会调用此函数,无论与此标记对应的数据是否已更改。

    如需查看提供的参数及其用途的列表,请参阅 VehicleMarkerCustomizationFunctionParams

FleetEngineVehicleLocationProviderUpdateEvent 接口

google.maps.journeySharing.FleetEngineVehicleLocationProviderUpdateEvent 接口

触发 FleetEngineVehicleLocationProvider.update 事件时传递给事件处理脚本的事件对象。

trips optional
类型Array<Trip> optional
此车辆已完成的行程列表。不可修改。
vehicle optional
类型Vehicle optional
更新返回的车辆数据结构。不可修改。

FleetEngineFleetLocationProvider

google.maps.journeySharing.FleetEngineFleetLocationProvider

舰队位置信息提供程序。

此类扩展了 PollingLocationProvider

通过调用 const {FleetEngineFleetLocationProvider} = await google.maps.importLibrary("journeySharing") 进行访问。请参阅 Maps JavaScript API 中的库

FleetEngineFleetLocationProvider
FleetEngineFleetLocationProvider(options)
参数
为 Fleet Engine 跟踪的车辆创建新的位置信息提供程序。
locationRestriction
跟踪车辆的范围。如果未设置边界,系统将不会跟踪任何车辆。要跟踪所有车辆的位置(无论位置),请设置相当于整个地球的边界。
staleLocationThresholdMillis
类型number
此字段是只读字段。过时车辆位置信息的阈值。如果最近更新的车辆位置早于此阈值,则不会显示这辆车。
vehicleFilter
类型string optional
提取车辆时应用的过滤条件。
已继承isPollingpollingIntervalMillis
已继承addListener
update
function(event)
完成 Fleet Engine 数据更新请求时触发的事件。
已继承ispollingchange

FleetEngineFleetLocationProviderOptions 接口

google.maps.journeySharing.FleetEngineFleetLocationProviderOptions 接口

舰队位置信息提供程序的选项。

authTokenFetcher
提供 JSON Web 令牌,用于向 Fleet Engine 验证客户端的身份。
projectId
类型string
Google Cloud 控制台中的使用方项目 ID。
locationRestriction optional
在位置提供程序实例化后,用于在此范围内跟踪车辆的纬度/经度边界。如果未设置,位置信息提供程序不会开始跟踪任何车辆;请使用 FleetEngineFleetLocationProvider.locationRestriction 设置边界并开始跟踪。要跟踪所有车辆的位置(无论位置),请设置相当于整个地球的边界。
staleLocationThresholdMillis optional
类型number optional
过时车辆位置信息的阈值。如果最近更新的车辆位置早于此阈值,则不会显示这辆车。默认值为 24 小时(以毫秒为单位)。如果阈值小于零或无穷大,则系统会忽略阈值,并且车辆位置信息不会被视为已过时。
vehicleFilter optional
类型string optional
在提取车辆时应用的过滤条件查询。此过滤器会直接传递给 Fleet Engine。

如需了解支持的格式,请参阅 ListVehiclesRequest.filter

请注意,有效的属性过滤条件必须包含“属性”前缀。例如 attributes.x = "y"attributes."x y" = "z"
vehicleMarkerCustomization optional
类型function(VehicleMarkerCustomizationFunctionParams): void optional
应用于车辆标记的自定义。

您可以使用此字段指定自定义样式(例如标记图标)和互动性(例如点击处理)。
  • 如果指定了 MarkerOptions 对象,则其中指定的更改会在标记创建后应用于该标记,并覆盖其默认选项(如果存在)。
  • 如果指定了函数,则在创建标记后、将标记添加到地图视图之前,系统会调用该函数一次。(在此调用中,函数参数对象中的 isNew 参数设置为 true。)此外,当位置信息提供程序从 Fleet Engine 接收数据时,系统会调用此函数,无论与此标记对应的数据是否已更改。

    如需查看提供的参数及其用途的列表,请参阅 VehicleMarkerCustomizationFunctionParams

FleetEngineFleetLocationProviderUpdateEvent 接口

google.maps.journeySharing.FleetEngineFleetLocationProviderUpdateEvent 接口

触发 FleetEngineFleetLocationProvider.update 事件时传递给事件处理脚本的事件对象。

vehicles optional
类型Array<Vehicle> optional
查询返回的车辆列表。不可修改。