Routes API 在计算路线时,会将您提供的航点和配置参数作为输入。然后,API 会返回一个包含 default 路由以及一个或多个备用路由的响应。
您的响应可以包含不同类型的路线和其他数据,具体取决于您请求的字段:
在回答中添加此内容 | 请参阅此文档 |
---|---|
最省油或最节能的路线(取决于车辆的引擎类型)。 | 配置环保路线 |
最多 3 条备选路线 | 请求备选路线 |
整条路线、路线的每段路程以及路程的每路段的多段线。 | 请求路线多段线 |
估算路桥费(考虑司机或车辆可用的通行费折扣或通行证费)。 | 计算通行费 |
按语言代码和度量单位(英制或公制)显示本地化的响应。 | 请求本地化的值 |
如需将导航说明的格式设置为 HTML 文本字符串,请将 HTML_FORMATTED_NAVIGATION_INSTRUCTIONS 添加到 extraComputations 。 |
额外计算 |
您可以使用响应为客户提供所需信息,以选择符合其要求的路由。
关于字段掩码
调用计算路线的方法时,您必须指定一个字段掩码,用于定义要在响应中返回的字段。没有返回字段的默认列表。如果省略此列表,这些方法会返回错误。
本文档中的示例展示了整个响应对象,而不考虑字段掩码。在生产环境中,您的响应将仅包含您在字段掩码中明确指定的字段。
如需了解详情,请参阅选择要返回的信息。
关于显示版权
在向用户显示结果时,您必须添加以下版权声明:
Powered by Google, ©YEAR Google
例如:
Powered by Google, ©2023 Google
关于路线、路段和步数
在查看 Routes API 返回的响应之前,您应该先了解路线的组成部分:
您的响应可能包含下列各个路由组件的相关信息:
路线:从出发地航点到经过任何中间航点到目的地航点的整个行程。路线由一个或多个段组成。
路程:从路线中的一个航点到该路线中的下一个航点的路径。每段路程都包含一个或多个离散的路段。
路线包含从每个航点到下一个航点的路径的单独路程。例如,如果路线包含一个出发地航点和单个目的地航点,则该路线包含一段路程。对于您在路线中在出发地和目的地后添加的每个额外航点(称为“中间航点”),API 会添加一段单独的路程。
API 不会为直通中间航点添加路程。例如,包含出发地航点、直通的中间航点和目的地航点的路线仅包含从出发地到目的地的一段路程,同时途经航点。如需详细了解传递航点,请参阅定义直通航点。
路段:路线的一段指示。路段是路线的最小单位例如,路段可以指示“在主街左转”。
回答内容
表示 API 响应的 JSON 对象包含以下顶级属性:
routes
:Route 类型的元素数组。对于 API 返回的每条路线,routes
数组都包含一个元素。该数组最多可包含五个元素:默认路线、环保路线,以及最多三条备选路线。geocodingResults
:类型为 GeocodingResults 的元素数组。对于请求中您指定为地址字符串或 Plus Code 的每个位置(出发地、目的地或中间航点),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
数组,其中每个数组元素都是 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 类型。数组中的每段路程都定义了路线沿途从一个航点到下一个航点的路径。路线始终至少包含一段路程。
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
数组元素的类型为 RouteLegStep。路段对应一段路程。一段路程始终至少包含一个路段。
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 Code 的每个位置(出发地、目的地或中间航点),API 会尝试查找具有对应地点 ID 的最相关位置。geocodingResults
数组的每个元素都包含 placeID
字段(其中包含以地点 ID 表示的位置)和 type
字段(用于指定位置类型),例如 street_address
、premise
或 airport
。
geocodingResults
数组包含以下三个字段:
origin
:该出发地的地点 ID(如果指定为地址字符串或 Plus 代码)。否则,响应中将省略此字段。destination
:如果指定为地址字符串或 Plus 代码,则为目的地的地点 ID。否则,响应中将省略此字段。intermediates
:一个数组,其中包含指定为地址字符串或 Plus 代码的任何中间航点的地点 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 单位。