给定一组航点和中间航点以及路线目标,将根据路线目标计算最佳路线。返回最快路线和最短路线作为参考路线。
注意:此方法要求您在输入中指定响应字段掩码。您可以通过以下两种方式提供响应字段掩码:使用网址参数 $fields
或 fields
,或者使用 HTTP/gRPC 标头 X-Goog-FieldMask
(请参阅可用的网址参数和标头)。该值是以英文逗号分隔的字段路径列表。请参阅有关如何构造字段路径的详细文档。
例如,在此方法中:
- 所有可用字段的字段掩码(适用于人工检查):
X-Goog-FieldMask: *
- 路线距离、时长、令牌和收费信息的字段掩码:
X-Goog-FieldMask: routes.route.distanceMeters,routes.route.duration,routes.token,routes.route.travelAdvisory.tollInfo
Google 不建议使用通配符 (*
) 响应字段掩码,也不在顶级 (routes
) 指定字段掩码,原因如下:
- 仅选择您需要的字段有助于我们的服务器节省计算周期,从而以更低的延迟将结果返回给您。
- 仅在生产作业中选择所需字段可确保稳定的延迟时间性能。我们未来可能会添加更多响应字段,这些新字段可能需要额外的计算时间。如果您选择所有字段,或者选择顶级的所有字段,则可能会出现性能下降,因为我们添加的任何新字段都会自动包含在响应中。
- 仅选择所需字段会使响应大小变小,从而提高网络吞吐量。
HTTP 请求
POST https://routespreferred.googleapis.com/v1:computeCustomRoutes
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "origin": { object ( |
字段 | |
---|---|
origin |
必需。出发地航点。 |
destination |
必需。目的地航点。 |
intermediates[] |
可选。路线沿途的一组航点(不包括航站点),可在以下地点经停或经过。最多支持 25 个中间航点。 |
travel |
可选。指定交通方式。仅支持 |
routing |
可选。指定如何计算路线。服务器会尝试使用所选的路由偏好设置来计算路由。如果路由偏好设置导致错误或延迟时间过长,则返回错误。只有当 |
polyline |
可选。指定多段线的质量偏好设置。 |
polyline |
可选。指定多段线的首选编码。 |
departure |
可选。出发时间。如果未设置此值,则此值默认为您发出请求的时间。如果您将此值设置为已过的时间,则请求会失败。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例: |
route |
可选。一组要满足的条件,这些条件会影响路线的计算方式。 |
route |
必需。要优化的路线目标。 |
language |
可选。BCP-47 语言代码,例如“en-US”或“sr-Latn”。如需了解详情,请参阅 Unicode 语言区域标识符。如需查看支持的语言列表,请参阅语言支持。如果您未提供此值,系统会根据路线请求的位置推断显示语言。 |
units |
可选。指定显示字段的衡量单位。这包括 |
响应正文
如果成功,则响应正文包含一个 ComputeCustomRoutesResponse
实例。
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/maps-platform.routespreferred
如需了解详情,请参阅 OAuth 2.0 概览。