路线矩阵请求的输入是起点和终点路径点的数组。然后,Routes API 会计算从每个起点航点到每个目的地航点的路线。例如,如果您指定两个起点航点和两个目的地航点,则该 API 会计算四条单独的路线。
API 响应包含一个数组,其中每个数组元素都对应于从一个起点航点到一个目的地航点的路线。因此,如果您指定两个出发地航点和两个目的地航点,则响应数组会包含四个元素,每条计算的路线对应一个元素。
您可以使用响应为客户提供不同的路线选项,然后让用户选择符合其需求的路线。
关于字段掩码
调用计算路线的方法时,您必须指定一个字段掩码,用于定义要在响应中返回的字段。没有返回字段的默认列表。如果省略此列表,这些方法会返回错误。
本文档中的示例显示了整个响应对象,而未考虑字段掩码。在生产环境中,您的响应将仅包含您在字段掩码中明确指定的字段。
如需了解详情,请参阅选择要返回的信息。
关于显示版权信息
向用户显示结果时,您必须添加以下版权声明:
Powered by Google, ©YEAR Google
例如:
Powered by Google, ©2023 Google
在响应中标识路线
使用 originIndex
和 destinationIndex
响应属性来标识响应中的每个路由。这些属性包含输入 origin 和 destination 航点(用于计算路线)的从零开始的索引。这意味着请求中的第一个出发地航点和第一个目的地航点位于数组索引 0 处。
例如,响应中的路线包含:
"originIndex": 1, "destinationIndex": 0
这些属性表示路线是根据输入数组中索引 1 处的起点航点和索引 0 处的目的地航点计算的。
对于下一条路线:
"originIndex": 4, "destinationIndex": 1
路线是从输入数组中索引为 4 的起点航点和索引为 1 的目的地航点计算得出的。
关于响应
表示 API 响应的 JSON 对象包含一个数组,其中每个数组元素都定义了从一个起始航点到一个目的地航点的路线。
除了 originIndex
和 destinationIndex
属性之外,每条路线还包含特定于该路线的信息,例如 distanceMeters
、duration
和 travelAdvisory
。
响应的格式如下:
[ // One array element for each combination of origin and destination waypoints. { // The route for source waypoint 0 and destination waypoint 0. "originIndex": 0, "destinationIndex": 0, "status": { object (Status) }, "condition": enum (RouteMatrixElementCondition), "distanceMeters": integer, "duration": string, "staticDuration": string, "travelAdvisory": { object (RouteTravelAdvisory) }, "fallbackInfo": { object (FallbackInfo) } } { // The route for source waypoint 0 and destination waypoint 1. "originIndex": 0, "destinationIndex": 1, "status": { object (Status) }, "condition": enum (RouteMatrixElementCondition), "distanceMeters": integer, "duration": string, "staticDuration": string, "travelAdvisory": { object (RouteTravelAdvisory) }, "fallbackInfo": { object (FallbackInfo) } } … ]