Routes API 计算路线时,会将您提供的途经点和配置参数作为输入。然后,该 API 会返回一个包含默认路线和一个或多个替代路线的响应。
您的响应可以包含不同类型的路线和其他数据,具体取决于您请求的字段:
在回答中包含此内容 | 请参阅此文档 |
---|---|
根据车辆的发动机类型估算的最省油或最节能的路线。 | 配置环保路线 |
最多 3 条备选路线 | 请求备选路线 |
整个路线、路线的每个航段以及航段的每个步行的多段线。 | 请求路线多段线 |
估计的通行费,其中考虑了司机或车辆可享受的任何通行费折扣或通行卡。 | 计算通行费 |
按语言代码和度量单位(英制或公制)本地化的响应。 | 请求本地化值 |
如需将导航说明格式化为 HTML 文本字符串,请向 extraComputations 添加 HTML_FORMATTED_NAVIGATION_INSTRUCTIONS 。 |
额外计算 |
如需查看完整的输入选项列表,请参阅可用的路线选项和请求正文。
您可以根据响应结果,为客户提供必要的信息,以便他们根据自己的需求选择合适的路线。
关于字段掩码
调用方法来计算路线时,您必须指定一个字段掩码,用于定义您希望在响应中返回哪些字段。没有默认的返回字段列表。如果您省略此列表,这些方法会返回错误。
本文档中的示例显示了整个响应对象,而未考虑字段掩码。在生产环境中,您的响应将仅包含您在字段掩码中明确指定的字段。
如需了解详情,请参阅选择要返回的信息。
关于显示版权信息
向用户显示结果时,您必须添加以下版权声明:
Powered by Google, ©YEAR Google
例如:
Powered by Google, ©2023 Google
路线、路段和步骤简介
在查看 Routes API 返回的响应之前,您应该了解构成路线的组件:
您的回答可能包含有关以下各项路线组成部分的信息:
路线:从出发地途经所有中间途经点到目的地的整个行程。路线由一段或多段路程组成。
路段:路线中从一个途经点到下一个途经点的路径。每个行程段都包含一个或多个离散的步数。
路线包含从每个途经点到下一个途经点的单独路程。例如,如果路线包含一个起点途径点和一个目的地途径点,则该路线包含一个路段。对于您在起点和目的地之后添加到路线中的每个额外途经点(称为中途途经点),API 都会添加一个单独的路线段。
对于直达中间经停点,该 API 不会添加路段。例如,包含出发地航点、途经中间航点和目的地航点的路线仅包含一段从出发地到目的地的行程,但会途经中间航点。如需详细了解途经点,请参阅定义途经点。
路段:路线中一段行程的单个指示。路段是路线的最小单位。例如,某一步骤可以指示“在主街左转”。
响应中的内容
表示 API 响应的 JSON 对象包含以下顶级属性:
routes
,类型为 Route 的元素数组。routes
数组包含 API 返回的每条路线对应的一个元素。该数组最多可包含 5 个元素:默认路线、环保路线以及最多 3 条替代路线。geocodingResults
,一个 GeocodingResults 类型的元素数组。 对于您在请求中指定为地址字符串或 Plus 代码的每个位置(出发地、目的地或中途经停点),API 都会执行地点 ID 查找。此数组的每个元素都包含与某个位置对应的地点 ID。请求中指定为地点 ID 或纬度/经度坐标的位置不包括在内。如果您已使用地点 ID 或纬度和经度坐标指定所有位置,则不会提供此数组。fallbackInfo
,类型为 FallbackInfo。 如果 API 无法根据所有输入属性计算出路线,则可能会改用其他计算方式。使用回退模式时,此字段包含有关回退响应的详细信息。否则,系统将取消设置此字段。
响应的格式如下:
{ // The routes array. "routes": [ { object (Route) } ], // The place ID lookup results. "geocodingResults": [ { object (GeocodedWaypoint) } ], // The fallback property. "fallbackInfo": { object (FallbackInfo) } }
解读 routes 数组
响应包含 routes
数组,其中每个数组元素的类型均为 Route。每个数组元素都表示从出发地到目的地的完整路线。该 API 始终会返回至少一条路线,称为默认路线。
您可以申请其他路线。如果您请求环保路线,则该数组可以包含两个元素:默认路线和环保路线。或者,在请求中将 computeAlternativeRoutes
设置为 true
,以在响应中添加最多三条替代路线。
数组中的每条路线都通过 routeLabels
数组属性进行标识:
值 | 说明 |
---|---|
DEFAULT_ROUTE |
标识默认路线。 |
FUEL_EFFICIENT |
标识环保路线。 |
DEFAULT_ROUTE_ALTERNATE |
I 表示备选路线。 |
legs
数组包含路线中每个路段的定义。其余属性(例如 distanceMeters
、duration
和 polyline,
)包含有关整个路线的信息:
{ "routeLabels": [ enum (RouteLabel) ], "legs": [ { object (RouteLeg) } ], "distanceMeters": integer, "duration": string, "routeLabels": [string], "staticDuration": string, "polyline": { object (Polyline) }, "description": string, "warnings": [ string ], "viewport": { object (Viewport) }, "travelAdvisory": { object (RouteTravelAdvisory) } "routeToken": string }
由于当前的驾驶条件和其他因素,默认路线和环保路线可能相同。在本例中,routeLabels
数组包含两个标签:DEFAULT_ROUTE
和 FUEL_EFFICIENT
。
{ "routes": [ { "routeLabels": [ "DEFAULT_ROUTE", "FUEL_EFFICIENT" ], … } ] }
了解 legs 数组
响应中的每个 route
都包含一个 legs
数组,其中每个 legs
数组元素的类型均为 RouteLeg。数组中的每个 leg 都定义了路线中从一个途径点到下一个途径点的路径。路线始终包含至少一个路段。
legs
属性包含 steps
数组中路段的每个步骤的定义。其余属性(例如 distanceMeters
、duration
和 polyline
)包含有关路段的信息。
{ "distanceMeters": integer, "duration": string, "staticDuration": string, "polyline": { object (Polyline) }, "startLocation": { object (Location) }, "endLocation": { object (Location) }, "steps": [ { object (RouteLegStep) } ], "travelAdvisory": { object (RouteLegTravelAdvisory) } }
了解 steps 数组
响应中的每个路段都包含一个 steps
数组,其中每个 steps
数组元素都是 RouteLegStep 类型。一个步数对应于沿腿部的一条指令。一个 leg 始终包含至少一个 step。
steps
数组中的每个元素都包含 navigationInstruction
属性(类型为 NavigationInstruction),其中包含路线规划步骤说明。例如:
"navigationInstruction": { "maneuver": "TURN_LEFT", "instructions": "Turn left toward Frontage Rd" }
instructions
可能包含有关相应步骤的其他信息。例如:
"navigationInstruction": { "maneuver": "TURN_SLIGHT_LEFT", "instructions": "Slight left (signs for I-90 W/Worcester)nParts of this road may be closed at certain times or days" }
该步骤中的其余属性描述了有关该步骤的信息,例如 distanceMeters
、duration
和 polyline
:
{ "distanceMeters": integer, "staticDuration": string, "polyline": { object (Polyline) }, "startLocation": { object (Location) }, "endLocation": { object (Location) }, "navigationInstruction": { object (NavigationInstruction) } }
指定步骤说明的语言
该 API 会返回本地语言的路线信息,如果需要,还会将信息音译为用户可读的文字,同时遵循首选语言。地址组成部分均以同一种语言返回。
使用请求的
languageCode
参数,从支持的语言列表中明确设置路线语言。Google 会经常更新支持的语言,因此该列表可能并非详尽无遗。如果指定语言中没有相应名称,API 会使用最接近的匹配项。
指定的语言可能会影响 API 选择返回的结果集以及返回这些结果的顺序。地理编码器会根据语言以不同的方式解读缩写,例如街道类型的缩写,或者在一种语言中有效但在另一种语言中无效的同义词。例如,utca 和 tér 是匈牙利语中“街道”的同义词。
了解 geocodingResults 数组
对于请求中指定为地址字符串或 Plus 代码的每个位置(起点、目的地或中间途经点),API 会尝试查找具有相应地点 ID 的最相关位置。geocodingResults
数组的每个元素都包含 placeID
字段(包含作为地点 ID 的位置)和 type
字段(用于指定位置类型,例如 street_address
、premise
或 airport
)。
geocodingResults
数组包含三个字段:
origin
:如果指定为地址字符串或 Plus Code,则为起点的地点 ID。否则,响应中会省略此字段。destination
:如果指定为地址字符串或 Plus Code,则为目的地的地点 ID。否则,此字段将从响应中省略。intermediates
:一个数组,其中包含以地址字符串或 Plus Code 形式指定的任何中间途经点的地点 ID。如果您使用地点 ID 或经纬度坐标指定中间途经点,则该途经点会从响应中省略。使用响应中的intermediateWaypointRequestIndex
属性来确定请求中的哪个中间途经点与响应中的地点 ID 对应。
"geocodingResults": { "origin": { "geocoderStatus": {}, "type": [ enum (Type) ], "placeId": string }, "destination": { "geocoderStatus": {}, "type": [ enum (Type) ], "placeId": string }, "intermediates": [ { "geocoderStatus": {}, "intermediateWaypointRequestIndex": integer, "type": [ enum (Type) ], "placeId": string }, { "geocoderStatus": {}, "intermediateWaypointRequestIndex": integer, "type": [ enum (Type) ], "placeId": string } ] }
了解本地化响应值
本地化响应值是一个额外的响应字段,用于为返回的参数值提供本地化文本。系统会提供本地化的行程时长、距离和单位制(公制或英制)。您可以使用字段掩码请求本地化值,并且可以指定语言和单位制,也可以使用 API 推断的值。如需了解详情,请参阅 LocalizedValues。
例如,如果您指定德语 (de) 的语言代码和英制单位,则 distanceMeters
的值为 49889.7,但同时也会获得本地化文本,以德语和英制单位提供该距离测量值,即“31 Meile”。
以下是本地化值的显示示例:
{ "localized_values": { "distance": { "text": "31,0 Meile/n" }, "duration": { "text": 38 Minuten}. "static_duration": { "text": 36 Minuten}. } }
如果您未指定语言或单位制,API 会按如下方式推断语言和单位:
ComputeRoutes
方法会根据出发地航点推断位置和距离单位。因此,对于美国境内的路线规划请求,API 会推断出en-US
语言和IMPERIAL
单位。ComputeRouteMatrix
方法默认使用“en-US”语言和 METRIC 单位。