Method: computeRoutes

返回所请求出行方式下,所请求出发地和目的地之间的主要路线。

HTTP 请求

POST https://mapstools.googleapis.com/v1alpha:computeRoutes

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据:

JSON 表示法
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "travelMode": enum (RouteTravelMode),
  "intermediateWaypoints": [
    {
      object (Waypoint)
    }
  ],
  "routingPreference": enum (RoutingPreference),
  "locationBias": {
    object (LatLng)
  },
  "includePolyline": boolean,
  "computeAlternativeRoutes": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "departureTime": string,
  "arrivalTime": string
  // End of mutually exclusive fields.
}
字段
origin

object (Waypoint)

必需。起点航点。

destination

object (Waypoint)

必需。目的地航点。

travelMode

enum (RouteTravelMode)

可选。指定交通方式。

intermediateWaypoints[]

object (Waypoint)

可选。出发地和目的地之间需要按顺序经过的中间停靠点。最多支持 25 个中间航点。

指定超过 10 个中间航点会导致费用增加和延迟时间延长。当 travelMode 为 TRANSIT 时,不支持中间航点。

routingPreference

enum (RoutingPreference)

可选。确定如何使用路况数据来计算路线。当 travelMode 为 WALK 或 BICYCLE 时,不支持 ROUTING_PREFERENCE_TRAFFIC_AWARE_OPTIMAL。对于TRANSIT,它可启用实时公交数据,例如延误和取消。

locationBias

object (LatLng)

可选。搜索结果偏向的位置,例如,用于消除航点文本查询的歧义。

includePolyline

boolean

可选。是否在响应路线中包含编码多段线。默认为 false。如果设置为 true,则返回 Route.encoded_polyline。

computeAlternativeRoutes

boolean

可选。是否计算除推荐路线之外的备选路线。默认值为 false,在这种情况下,系统只会返回推荐路线。如果设置为 true,系统会返回所有可用路线,但并非每个请求都有备选路线。

指定何时从起点出发或何时到达最终航点。如果未指定,则默认为当前时间出发。对于 TRANSIT,时间必须最多是过去 7 天,最长是未来 100 天。对于其他出行方式,时间不得早于当前时间,且不得晚于当前时间 365 天。以下是互斥字段的列表。在响应中,最多只能设置其中一个字段:
departureTime

string (Timestamp format)

可选。表示应根据出发时间计算路线。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

arrivalTime

string (Timestamp format)

可选。表示应根据到达时间计算路线。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

互斥字段结束。

响应正文

如果成功,则响应正文包含一个 ComputeRoutesResponse 实例。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/maps-platform.mapstools