本指南介绍了如何将使用 Directions API 或 Distance Matrix API 的应用迁移到使用 Routes API。如需详细了解 Routes API,请参阅产品概览。
更新 REST API 端点
更新代码以使用新的 Routes API 端点
通过 Directions API
Directions API | https://maps.googleapis.com/maps/api/directions/outputFormat?parameters |
Routes API | https://routes.googleapis.com/directions/v2:computeRoutes |
使用 Distance Matrix API
Distance Matrix API | https://maps.googleapis.com/maps/api/distancematrix/outputFormat?parameters |
Routes API | https://routes.googleapis.com/distanceMatrix/v2:computeRouteMatrix |
转换网址参数以使用 HTTPS 请求正文
使用 Directions API 和 Distance Matrix API 时,您可以将配置属性作为网址参数传递给 HTTP GET
请求。例如,对于 Directions API:
https://maps.googleapis.com/maps/api/directions/outputFormat?parameters
使用 Routes API,您可以在请求正文中或在 HTTP POST
请求的标头中传递参数。如需查看示例,请参阅:
将多段线编码的航点转换为位置航点
Directions API 支持将路径点指定为编码多段线,以便在网址限制为 16384 个字符的情况下容纳大量路径点。Routes API 中不需要此功能,因为路径点可以作为经纬度坐标在 REST 或 gRPC 请求正文中传输。如需查看示例,请参阅计算路线矩阵文档中的 HTTP 示例,或指定中间航点文档中的定义中间航点。
转换参数
下表列出了 Directions API 和 Distance Matrix API 中已重命名或修改的参数,或 GA 版本不支持的参数。如果您使用的是其中任何参数,请更新您的代码。
请求参数转换
路线或距离矩阵参数 | Routes API 参数 | 备注 |
---|---|---|
alternatives |
computeAlternativeRoutes |
|
arrival_time |
arrivalTime |
仅在 TRANSIT 模式下可用,且与 departureTime 不同。 |
avoid |
routeModifiers |
|
departure_time |
departureTime |
不能与 arrivalTime 同时使用。 |
language |
languageCode |
仅适用于计算路线。 |
mode |
travelMode |
添加了对 |
region |
regionCode |
|
traffic_model |
trafficModel |
了解详情 |
transit_mode |
"travelMode": "TRANSIT" |
在 Directions API 中,在公交路线中,具有相同出行方式(例如,步行或公交)的行程的每个路段都被视为一个路段,该出行方式的各个路线均包含子路段。相比之下,在 Routes API 中,步骤始终是所有类型行程的一项导航指令。因此,每条导航指令都是一个步骤。 对于一种出行方式中的多个路段,Routes API 会在“stepsOverview”中提供包含该出行方式路段摘要的元数据。如需请求此类元数据,请使用“routes.legs.stepsOverview”字段掩码。 了解详情。 |
transit_routing_preference |
transitRoutingPreference |
了解详情 |
units |
units |
了解详情 |
waypoints |
intermediates |
移除了对编码多段线的支持。 |
optimize=true 用于航点 |
"optimizeWaypointOrder": "true" |
了解详情 |
响应参数转换
路线或距离矩阵参数 | Routes API 参数 | 备注 |
---|---|---|
copyrights |
未包含在响应中。向用户显示结果时,您必须添加以下声明:
例如:
|
|
distance |
distanceMeters |
距离只能以米为单位。 |
duration_in_traffic |
duration |
已从 Routes API 中移除,请改用 duration 。 |
status |
不可用。针对 API 报告的错误使用 HTTP 响应代码。如需了解详情,请参阅处理请求错误。 | |
geocoded_waypoints |
geocoding_results |
仅适用于计算路线。仅包含指定为地址的航点的地理编码响应信息。 |
bounds |
viewport |
|
legs.end_address |
不可用。 | |
legs.start_address |
不可用。 | |
overview_polyline |
多段线 | |
summary |
description |
|
waypoint_order |
optimizedIntermediateWaypointIndex |