Method: computeRoutes

針對要求的交通方式,傳回所要求起點和目的地之間的主要路線。

HTTP 要求

POST https://mapstools.googleapis.com/v1: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 正規化,並使用 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 正規化,並使用 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