指定一組航廈和中繼路線控點以及路線目標,即可計算路線目標的最佳路徑。系統也會傳回最快路線和最短路線做為參考路線。
注意:這個方法需要您在輸入中指定回應欄位遮罩。如要提供回應欄位遮罩,您可以使用網址參數 $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 個中繼路線控點。 |
travelMode |
選用設定。指定交通方式,目前僅支援「DRIVE」。 |
routingPreference |
選用設定。指定如何計算路徑。伺服器會嘗試使用所選轉送偏好設定來計算路徑。如果轉送偏好設定導致錯誤或過長的延遲時間,則會傳回錯誤。日後如果偏好的選項無法提供有效結果,我們可能會導入備用機制,以便使用其他選項。只有在 |
polylineQuality |
選用設定。指定您對折線品質的偏好設定。 |
polylineEncoding |
選用設定。指定折線的偏好編碼。 |
departureTime |
選用設定。出發時間。如未設定這個值,則這個值會預設為您提出要求的時間。如果將這個值設為已發生的時間,要求就會失敗。 RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例: |
routeModifiers |
選用設定。一組滿足條件,這些條件會影響路線的計算方式。 |
routeObjective |
必要欄位。要最佳化的路徑目標。 |
languageCode |
選用設定。BCP-47 語言代碼,例如「en-US」或「sr-Latn」。詳情請參閱 http://www.unicode.org/reports/tr35/#Unicode_locale_identifier。如需支援的語言清單,請參閱語言支援。如未提供這個值,系統會根據路線要求的位置推斷顯示語言。 |
units |
選用設定。指定顯示欄位的測量單位。這包括 |
回應主體
如果成功,回應主體會包含 ComputeCustomRoutesResponse
的執行例項。
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/maps-platform.routespreferred
詳情請參閱 OAuth 2.0 總覽。