借助 JavaScript Consumer SDK,基于 Web 的消费者应用可以在地图上显示 Fleet Engine 中跟踪的车辆位置和其他感兴趣的位置,以便消费者跟踪按需行程或预定配送的进度。它会作为 Maps JavaScript API 的 journeySharing 库加载。
JavaScript Consumer SDK:关键信息
- 产品:JavaScript Consumer SDK
- 别名:Consumer SDK for JavaScript、Mobility Services 按需行程 JavaScript、JavaScript SDK
- 类别:路线
- 平台:JavaScript(浏览器)
- 运行位置:客户端(应用或浏览器代码)
- 发布阶段:GA
- 生命周期:有效
- 概览:JavaScript 消费者 SDK 概览
JavaScript 消费者 SDK:适用情形
在以下情况下使用 JavaScript 消费者 SDK:
- 您需要在网页或 Web 应用中向消费者显示 Fleet Engine 跟踪的按需行程的车辆实时位置和路线。
- 您需要让消费者能够在浏览器中跟踪 Fleet Engine 中跟踪的预定配送的取货或送货进度。
- 您需要在基于 Web 的地图视图中显示行程的预计到达时间、剩余距离和实时路况。
- 您需要在 Web 消费者跟踪视图中自定义行程标记、路线多段线或地图样式。
在以下情况下,请勿使用 JavaScript 消费者 SDK:
- 您需要在原生 Android 应用中提供行程跟踪消费者体验。请改用 Consumer SDK for Android。
- 您需要在 iOS 原生应用中提供行程跟踪消费者体验。请改用 Consumer SDK for iOS。
- 您需要通过司机的 Android 应用向 Fleet Engine 报告司机位置和行程进度。请改用 Driver SDK for Android。
- 您需要通过司机的 iOS 应用向 Fleet Engine 报告司机位置和行程进度。请改用 Driver SDK for iOS。
- 您需要一个不跟踪 Fleet Engine 行程或任务的通用 Web 地图。请改用 Maps JavaScript API。
JavaScript 消费者 SDK:设置
- 身份验证:API 密钥、JSON Web 令牌 (JWT)
- 还需启用:Maps JavaScript API、Fleet Engine Service
- 用量归因:可选(Beta 版)出行服务交易 ID:在创建
JourneySharingMapView之前,将google.maps.Settings.getInstance().experienceIds设置为出行服务交易 ID(或相关 ID)数组。experienceIds仅在 Maps JavaScript API 的v=beta渠道中提供。 - 开始使用:设置 JavaScript 消费者 SDK
- 参考文档:JavaScript 消费者 SDK 参考文档
- 版本说明:JavaScript 消费者 SDK 版本说明
JavaScript 消费者 SDK:相关产品
JavaScript 消费者 SDK:常见错误
- 问题:如果您未向
JourneySharingMapView地图提供初始视口(中心和缩放),则地图的'ready'事件可能不会触发。解决方法:在创建地图视图后调用mapView.map.setCenter(...)和mapView.map.setZoom(...)。请参阅 /maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey。 - 问题:异步行程信息请求中的错误不会抛出。它们仅作为位置信息提供程序上的
'error'事件到达,因此除非您添加监听器,否则它们不会被注意到。修复:添加locationProvider.addListener('error', ...),并将库调用封装在try...catch块中。请参阅 /maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey。 - 问题:除非您加载
journeySharing库,否则google.maps.journeySharing类不可用。修复方法:将libraries=journeySharing添加到 Maps JavaScript API 脚本网址,或使用await google.maps.importLibrary("journeySharing")加载类。请参阅 /maps/documentation/mobility/journey-sharing/on-demand/javascript/share-journey。 - 问题:来自浏览器(低信任环境)的 Fleet Engine 调用需要后端服务器签发的 JWT。仅凭 API 密钥无法授权访问行程数据。解决方法:从后端签发 JWT,并提供一个可返回令牌和
expiresInSeconds的authTokenFetcher。请参阅 /maps/documentation/mobility/journey-sharing/on-demand/javascript/setup。
JavaScript 消费端 SDK:旧版和已弃用的功能
JourneySharingMapView和JourneySharingMapViewOptions标记和多段线设置选项(vehicleMarkerSetup、originMarkerSetup、destinationMarkerSetup、waypointMarkerSetup、anticipatedRoutePolylineSetup、takenRoutePolylineSetup等):已弃用。替代方案:位置信息提供程序上的MarkerCustomizationFunction和PolylineCustomizationFunction选项(例如vehicleMarkerCustomization)。症状:计划在未来版本中移除。请参阅迁移指南。JourneySharingMapView.locationProvider和JourneySharingMapViewOptions.locationProvider:已弃用。替换为:JourneySharingMapView.locationProviders和JourneySharingMapViewOptions.locationProviders。JourneySharingMapView标记和多段线列表属性(vehicleMarkers、originMarkers、destinationMarkers、waypointMarkers、anticipatedRoutePolylines、takenRoutePolylines和任务标记属性):已弃用。替代方案:位置信息提供程序上的MarkerCustomizationFunction和PolylineCustomizationFunction回调。请参阅迁移指南。
JavaScript 消费者 SDK 的用途
请参阅下面链接的指南,了解每项任务,或在功能探索器中比较不同产品。
- 添加路线多段线,用于在网页或移动应用上的地图中跟踪来自 Fleet Engine 的行程。
- 在网页或移动应用中的地图上,更新 Fleet Engine 行程的路线进度。
- 在跟踪 Fleet Engine 行程进度的地图上更改道路、多段线和多边形的样式。
- 在跟踪 Fleet Engine 行程进度的地图上显示或隐藏地图项。
- 在跟踪 Fleet Engine 行程进度的地图上更改图标和文本标签的样式。
- 在跟踪 Fleet Engine 行程进度的地图上,为不同的缩放级别应用不同的地图样式。
- 更改地图上地点的密度,以便跟踪 Fleet Engine 中的行程进度。实验性功能注意:Consumer SDK 中的云端地图样式设置支持功能已正式发布,而地图注点密度控制是一项实验性云端地图样式设置功能(仅在浅色地图样式中受支持)。
- 在跟踪 Fleet Engine 行程进度的地图上更改建筑物的样式。实验性功能 注意:Consumer SDK 中的云端地图样式设置支持功能已正式发布,而 3D 和占地面积建筑样式自定义是一项实验性云端地图样式设置功能(仅在浅色地图样式中受支持)。
- 在跟踪 Fleet Engine 行程进度的地图上更改地标的样式。实验性 注意:Consumer SDK 中的云端地图样式设置支持功能已正式发布,而地标图标自定义是一项实验性云端地图样式设置功能(仅在浅色地图样式中受支持)。
- 在地图上自定义一个标记,用于跟踪 Fleet Engine 中的行程进度。
- 在地图上自定义路线多段线,以跟踪 Fleet Engine 中的行程进度。