Consumer SDK for Android 是 Fleet Engine for on-demand trips 的一部分。它提供了一些接口,用于在 Fleet Engine 中对行程数据进行建模并跟踪行程;还提供了一些类,用于构建基于地图的显示,以便在 Android 应用中与消费者分享行程进度(车辆位置、路线、预计到达时间、剩余距离、路况)。
Consumer SDK for Android:关键信息
- 产品:Consumer SDK for Android
- 别名:Android Consumer SDK、Consumer SDK、Mobility Services On-demand Trips Android Consumer SDK
- 类别:路线
- 平台:Android
- 运行位置:客户端(应用或浏览器代码)
- 发布阶段:GA
- 生命周期:有效
- 概览:Consumer SDK for Android 概览
Consumer SDK for Android:何时使用
在以下情况下使用 Consumer SDK for Android:
- 您需要让 Android 应用中的消费者跟踪后端在 Fleet Engine 中跟踪的按需行程(行程、订单或配送)。
- 您需要在 Android 消费者应用中的地图上显示车辆的近乎实时的、贴合道路的位置和路线。
- 您需要在 Android 中显示 Fleet Engine 行程的上车和下车预计到达时间、剩余距离和实时路况。
- 您需要为 Android 中的行程分享地图自定义行程标记、路线多段线或地图样式。
在以下情况下,请勿使用 Consumer SDK for Android:
- 您需要在 iOS 应用中为按需行程提供行程分享功能。请改用 Consumer SDK for iOS。
- 您需要在网页中分享行程,或让消费者跟踪预定任务(例如配送)。请改用 JavaScript 消费者 SDK。
- 您需要通过司机的 Android 应用报告司机位置和行程进度。请改用 Driver SDK for Android。
Consumer SDK for Android:设置
- 身份验证:JSON Web 令牌 (JWT)、API 密钥
- 还需启用:Fleet Engine Service、Maps SDK for Android
- 开始使用:设置 Consumer SDK for Android
- 参考文档:Consumer SDK for Android 参考文档
- 政策:Consumer SDK for Android 政策
- 版本说明:Consumer SDK for Android 版本说明
官方 Consumer SDK for Android 软件包:
- maven:
com.google.android.libraries.mapsplatform.transportation:transportation-consumer
Consumer SDK for Android:相关产品
Consumer SDK for Android:常见错误
- 问题:如果 Maps SDK 依赖项未设置为明确的版本,Consumer SDK 会使用所需的最低 Maps SDK 版本,这可能会破坏依赖于更高 Maps SDK 版本中功能的应用。修复方法:在 Gradle 或 Maven 中,在声明
transportation-consumer的同时,声明一个明确定义的play-services-maps版本。请参阅 /maps/documentation/mobility/journey-sharing/on-demand/android/configure-project。 - 问题:行程结束后未停止行程分享,导致向 Fleet Engine 发出不必要的网络请求,并导致内存泄漏。解决方法:在不再需要行程时(例如在
onDestroy()中或行程为COMPLETE时)调用JourneySharingSession.stop()。请参阅 /maps/documentation/mobility/journey-sharing/on-demand/android/share-journey。 - 问题:如果 API 实例已存在,
ConsumerApi.initialize()会抛出异常(2.0.0 及更高版本)。解决方法:先调用ConsumerApi.getInstance(),然后检查返回的Task,以确定实例是否已存在。请参阅 /maps/documentation/mobility/services/resources/relnotes_consumer_sdk_android。 - 问题:Consumer SDK v3 及更低版本不支持完整 R8 模式;以 AGP 8.0+ 为目标平台的应用可能会遇到 build 或运行时问题。修复:如果目标版本为 AGP 8.0+,请设置
android.enableR8.fullMode=false;如果目标版本为 Consumer SDK 3.0+,请将 AGP 7.3+ 与 Kotlin 2.0 搭配使用。请参阅 /maps/documentation/mobility/journey-sharing/on-demand/android/migration-guide-v3。
Consumer SDK for Android:旧版和已弃用的功能
ConsumerTrip、ConsumerTripCallback、ConsumerTripManager、ConsumerTripOptions:自 2023 年 9 月 15 日起已停用。替换:TripModel、TripModelCallback、TripModelManager、TripModelOptions。请参阅迁移指南。Trip类和Trip.TripStatus/Trip.TripType注解(以及TripInfo#getTripStatus()、TripInfo#getTripType()、TripModelCallback#onTripStatusUpdated):自 2023 年 9 月 15 日起已弃用。更换:TripInfo.TripStatus/TripInfo.TripType、TripInfo#getCurrentTripStatus()、TripInfo#getCurrentTripType()、TripModelCallback#onTripStatusUpdate。请参阅迁移指南。MarkerStyleOptions和PolylineStyleOptions:自 2021 年 11 月 30 日起已停用。替代项:MarkerOptions和PolylineOptions(与 Maps SDK 共享)。症状:Consumer SDK 会根据标记或多段线类型应用自己的默认样式,而不是MarkerOptions默认样式。请参阅迁移指南。- 私有代码库分发渠道:已弃用。替代方案:Google Maven 仓库(2.1.0 及更高版本)。请参阅迁移指南。
Consumer SDK for Android 的用途
请参阅下面链接的各项任务指南,或在功能探索器中比较不同产品。
- 添加可自定义的互动式地图,用于跟踪从 Fleet Engine 到移动应用的行程进度。
- 添加路线多段线,用于在网页或移动应用上的地图中跟踪来自 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 中的行程进度。