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 车辆创建新的位置信息提供程序。
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 Console 的使用方的项目 ID。
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 会停用周期性位置信息更新。如果位置信息提供程序观察到的任何参数发生更改,系统会提取新的位置信息更新。

默认的轮询间隔为 5000 毫秒(最短间隔时间)。如果您将轮询间隔设置为较低的非零值,则系统会使用 5000。
staleLocationThresholdMillis optional
类型number optional
过时车辆位置的阈值。如果最近一次更新车辆的位置是在这个阈值之前的,则不会显示车辆。默认为 24 小时(以毫秒为单位)。如果阈值小于 0 或 Infinity,则阈值会被忽略,并且车辆位置不会被视为过时。
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 Console 的使用方的项目 ID。
locationRestriction optional
在实例化位置信息提供程序后立即跟踪车辆的纬度/经度边界。如果未设置,位置信息提供程序不会开始跟踪任何车辆;请使用 FleetEngineFleetLocationProvider.locationRestriction 设置边界并开始跟踪。如需对任何位置的车辆进行跟踪,请设置与整个地球等效的边界。
staleLocationThresholdMillis optional
类型number optional
过时车辆位置的阈值。如果最后更新车辆的位置信息超过这个阈值,就不会显示车辆。默认为 24 小时(以毫秒为单位)。如果阈值小于零或 Infinity,则系统会忽略阈值,并且车辆位置不会被视为过时。
vehicleFilter optional
类型string optional
提取车辆时应用的过滤条件查询。此过滤条件会直接传递给 Fleet Engine。

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

请注意,属性的有效过滤器必须带有“attributes”前缀。例如,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
查询返回的车辆列表。不可修改。