从 Directions API 或 Distance Matrix API 迁移

本指南介绍了如何将使用 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 中已重命名或修改的参数,或者正式版不支持的参数。如果您使用的是上述任何参数,请更新您的代码。

请求参数转换

路线或距离矩阵参数 Routes API 参数 备注
alternatives computeAlternativeRoutes
arrival_time arrivalTime 仅在 TRANSIT 模式下可用,且不能同时与 departureTime 模式一起使用。
avoid routeModifiers
departure_time departureTime 不能与“arrivalTime”同时使用。
language languageCode 仅适用于计算路线。
mode travelMode

添加了对 TWO_WHEELERTRANSIT 的支持。

region regionCode
traffic_model trafficModel 了解详情
transit_mode "travelMode": "TRANSIT" 在 Directions API 中,在公交路线中,出行方式相同的行程的每个路段(例如,步行或公交)都被视为一步,该出行方式的各个路线则以子路段为准。相比之下,在 Routes API 中,所有出行方式中的路段始终都是一条导航指令。因此,每条导航指令都是一个步骤。 对于一种出行方式中的多个路段,Routes API 会在“stepsOverview”中提供包含相应出行方式的路段摘要的元数据。如需请求此元数据,请使用“routes.legs.stepsOverview”字段掩码。 了解详情
transit_routing_preference transitRoutingPreference 了解详情
units 不适用于路线矩阵。
waypoints intermediates 取消了对编码多段线的支持。
optimize=true 表示航点 "optimizeWaypointOrder": "true" 了解详情

响应参数转换

路线或距离矩阵参数 Routes API 参数 备注
copyrights

未包含在响应中。向用户显示结果时,您必须添加以下语句:

Powered by Google, ©YEAR Google

例如:

Powered by Google, ©2022 Google

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