共用方式為


Route - Post Route Directions

使用 來計算指定來源與目的地之間的路由,並傳遞任何指定的路徑點。

Post Route Directions API 是 HTTP POST 要求,會傳回來源與目的地之間的路由,並在指定時通過路點。 路線將考慮目前交通和一般道路速度等因素,在一周的要求當天和一天的時間。

傳回的資訊包括距離、預估的行進時間,以及路線幾何的表示。 視選取的選項而定,也會提供其他路由資訊,例如優化的導航點順序或回合指示。

路由服務提供一組參數,以取得車輛特定耗用量模型的詳細描述。 如需相關概念和參數的詳細說明,請參閱 取用模型

POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}&currentFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}&currentChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}

URI 參數

名稱 位於 必要 類型 Description
format
path True

ResponseFormat

回應所需的格式。 值可以是 json xml

api-version
query True

string

Azure 地圖服務 API 的版本號碼。

query
query True

string

用來計算路由的座標,並以冒號分隔。 至少需要兩個座標。 第一個是來源,最後一個是路由的目的地。 選擇性座標在路由中作為 WayPoints。 您最多可以傳遞 150 個 WayPoints。

accelerationEfficiency
query

number

double

指定當車輛加速 時,將儲存在燃料中的化學能量轉換為動能的效率(即 KineticEnergyGained/ChemicalEnergyConsumed)。ChemicalEnergyConsumed 是利用 燃料EnergyDensityInMJoulesPerLiter,將消耗的燃料轉換成化學能量來取得。

必須與 減速效率配對。

允許的值範圍是 0.0 到 1/減速效率

合理的值:適用於 燃燒模型:0.33,適用於 電動模型: 0.66

alternativeType
query

AlternativeRouteType

相較於參考路由,控制所計算替代方案的指定規劃準則的最佳性。

arriveAt
query

string

date-time

抵達目的地點的日期和時間,其格式為 值,如 rfC 3339 第 5339 節 5.6所定義,並具有選擇性時區位移。 如果未指定時區位移,則會假設為目的地點的位移。

例子:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

arriveAt 參數不能與 departAtminDeviationDistanceminDeviationTime搭配使用。

auxiliaryPowerInkW
query

number

double

指定以千瓦為單位維持輔助系統所使用的電力量。

它可以用來指定因 AC 系統、無線電、加熱等裝置和系統而耗用量。

合理的值:1.7

auxiliaryPowerInLitersPerHour
query

number

double

指定以每小時升為單位,用於維持車輛輔助系統的燃料量。

它可以用來指定因 AC 系統、無線電、加熱等裝置和系統而耗用量。

明智的值:0.2

avoid
query

RouteAvoidType[]

指定路由計算在判斷路由時應嘗試避免的事項。 可以在一個要求中指定多次,例如『&avoid=高速公路&avoid=tollRoads&avoid=ferries』。 在 [路由範圍] 要求中,不得使用已經使用的值UsedRoads。

computeBestOrder
query

boolean

使用快速啟發學習演算法來重新排序路由路點,以減少路由長度。 與 routeType 搭配使用時,會產生最佳結果,最短。 請注意,來源和目的地會從優化的方式點索引中排除。 若要在回應中包含來源和目的地,請將所有索引增加 1 以考慮來源,然後將目的地新增為最終索引。 可能的值為 true 或 false。 True 會盡可能計算更好的順序,但不允許與 maxAlternatives 值搭配大於 0 或與圓形導航點搭配使用。 False 會使用指定順序中的位置,且不允許與 routeRepresentation 搭配使用,

computeTravelTimeFor
query

ComputeTravelTime

指定是否使用不同類型的交通資訊傳回額外的旅行時間(無、歷史、即時),以及預設的最佳估計旅行時間。

constantSpeedConsumptionInkWhPerHundredkm
query

string

指定耗用量的速度相依元件。

以未排序的速度/耗用量率組清單的形式提供。 此清單會定義耗用量曲線上的點。 找到不在清單中之速度的耗用量率,如下所示:

  • 如果指定的速度位於清單中的兩個速度之間,則為線性插補

  • 依線性外推,否則假設由清單中最接近兩個點所決定的常數 (1Consumption/OcSpeed)

清單必須包含介於 1 到 25 點之間(含),且不能包含相同速度的重複點。 如果它只包含單一點,則會使用該點的耗用量率,而不需進一步處理。

針對最大速度指定的耗用量必須大於或等於倒數第二個最大速度的耗用量。 這可確保外推不會導致負耗用量率。

同樣地,針對清單中兩個最小速度指定的耗用量值,無法導致任何較小速度的負耗用量率。

耗用量值的有效範圍(以 kWh/100 公里表示)介於 0.01 到 100000.0 之間。

合理的值:50,8.2:130,21.3

電耗模型需要此參數,

constantSpeedConsumptionInLitersPerHundredkm
query

string

指定耗用量的速度相依元件。

提供為非排序的冒號分隔速度清單,& 耗用量率組。 此清單會定義耗用量曲線上的點。 找到不在清單中之速度的耗用量率,如下所示:

  • 如果指定的速度位於清單中的兩個速度之間,則為線性插補

  • 依線性外推,否則假設由清單中最接近兩個點所決定的常數 (1Consumption/OcSpeed)

清單必須包含介於 1 到 25 點之間(含),且不能包含相同速度的重複點。 如果它只包含單一點,則會使用該點的耗用量率,而不需進一步處理。

針對最大速度指定的耗用量必須大於或等於倒數第二個最大速度的耗用量。 這可確保外推不會導致負耗用量率。

同樣地,針對清單中兩個最小速度指定的耗用量值,無法導致任何較小速度的負耗用量率。

耗用量值的有效範圍(以 l/100 公里表示)介於 0.01 到 100000.0 之間。

合理的值:50,6.3:130,11.5

附注燃燒耗用量模型需要此參數。

currentChargeInkWh
query

number

double

指定目前千瓦時(kWh)的電力供應。

此參數與 maxChargeInkWh 參數 並存。

允許的值範圍是 0.0 到 maxChargeInkWh

明智的值:43

currentFuelInLiters
query

number

double

指定目前以升為單位的燃料供應。

明智的值:55

decelerationEfficiency
query

number

double

指定當車輛減速 (即 ChemicalEnergySaved/KineticEnergyLost)時,將動能轉換為節約(未耗用)燃料的效率。ChemicalEnergySaved 是利用 燃料EnergyDensityInMJoulesPerLiter,將已儲存的(未消耗)燃料轉換為能源來取得。

必須與 accelerationEfficiency配對。

允許的值範圍是 0.0 到 1/accelerationEfficiency

合理值:適用於 燃燒模型:0.83,適用於 電動模型: 0.91

departAt
query

string

date-time

從原始點出發的日期和時間,格式為 dateTime 值,如 RFC 3339 第 5.6 節所定義,並具有選擇性時區位移。 未指定時區位移時,會假設其為源點的位移。

  • 預設值: 現在
  • 其他值:dateTime

例子:

  • 2023-12-19T16:39:57
  • 2023-12-19T16:39:57-08:00

departAt 參數不能與 arriveAt搭配使用。

downhillEfficiency
query

number

double

指定當車輛失去海拔 (即 ChemicalEnergySaved/PotentialEnergyLost)時,將潛在能源轉換為節約(未耗用)燃料的效率。ChemicalEnergySaved 是利用 燃料EnergyDensityInMJoulesPerLiter,將已儲存的(未消耗)燃料轉換為能源來取得。

必須與 uphillEfficiency配對。

允許的值範圍是 0.0 到 1/uphillEfficiency

合理的值:適用於 燃燒模型:0.51,適用於 電動模型:0.73

fuelEnergyDensityInMJoulesPerLiter
query

number

double

指定以兆焦耳(MJ)儲存在一升燃料中的化學能量量。 它與 *效率 參數搭配使用,用於節省或耗用的能源和燃料之間的轉換。 例如,汽油的能源密度為 34.2 MJ/l,柴油為 35.8 MJ/l。

如果已設定任何 *Efficiency 參數,則需要此參數。

明智的值:34.2

hilliness
query

InclineLevel

驚心動魄路線的丘陵程度。 此參數只能與 routeType=thrilling 搭配使用。

instructionsType
query

RouteInstructionsType

如果指定,將會傳回指引指示。 請注意,instructionsType 參數不能與 routeRepresentation=none 搭配使用。

language
query

string

語言參數會決定指引訊息的語言。 它不會影響適當的名詞(街道、廣場等的名稱)當 instructionsType=coded 時,它沒有任何作用。 允許的值是 IETF 語言標籤所述的 (子集)

maxAlternatives
query

integer

要計算的所需替代路由數目。 默認值:0、最小值:0 和最大值:5

maxChargeInkWh
query

number

double

指定可能儲存在車輛電池中的千瓦時(kWh)最大電力供應量。

此參數與 currentChargeInkWh 參數 並存。

最小值必須大於或等於 currentChargeInkWh

明智的值:85

minDeviationDistance
query

integer

傳回的所有替代路由都會遵循參考路由(請參閱 POST 要求一節),從 calculateRoute 要求的源點至少傳回此數目的公尺。 只能在重建路由時使用。 minDeviationDistance 參數無法與 arriveAt 搭配使用

minDeviationTime
query

integer

傳回的所有替代路由都會遵循參考路由(請參閱 POST 要求一節),從 calculateRoute 要求的源點至少要有此秒數。 只能在重建路由時使用。 minDeviationTime 參數無法與 arriveAt 搭配使用。 預設值為 0。 將 )minDeviationTime_設定為大於零的值會產生下列結果:

  • calculateRoute 要求的來源點必須位於輸入參考路由上(或非常接近)。
    • 如果情況並非如此,則會傳回錯誤。
    • 不過,源點不需要位於輸入參考路線的開頭(可以視為參考路線上的目前車輛位置)。
  • 傳回為 calculateRoute Response 中第一個路由的參考路由,將會從 calculateRoute Request 中指定的源點開始。 輸入參考的初始部分會向上路由,直到來源點從回應中排除為止。
  • minDeviationDistanceminDeviationTime 的值 決定從源點開始遵循參考路由的距離。
  • 路由必須使用 的 departAt
  • 會忽略 vehicleHeading
report
query

Report

指定應報告哪些數據以供診斷之用。 唯一可能的值是 effectiveSettings。 報告呼叫 API 時所使用的有效參數或數據。 在預設參數的情況下,預設會反映呼叫端未指定參數的位置。

routeRepresentation
query

RouteRepresentationForBestOrder

指定提供做為回應之路由集的表示。

routeType
query

RouteType

要求的路由類型。

sectionType
query

SectionType[]

指定路由回應中報告哪些區段類型。

例如,如果 sectionType = 行人,則只傳回適合行人之區段。 可以在一個要求中指定多次,例如 '§ionType=carTrain§ionType=pedestrian§ionType=motorway'。 默認 sectionType 是指 travelMode 輸入。 根據預設,travelMode 會設定為 car

traffic
query

boolean

可能的值:

  • true - 在路由期間考慮所有可用的流量資訊
  • false - 在路由期間忽略目前的流量數據。 請注意,雖然在路由期間忽略目前的交通數據,但歷史交通對有效道路速度的影響仍會納入其中。
travelMode
query

TravelMode

所要求路線的移動模式。 如果未定義,預設值為 『car』。 請注意,要求的 travelMode 可能無法用於整個路線。 當要求之 travelMode 不適用於特定區段時,該區段回應的 travelMode 元素將會是 “other”。 請注意,旅遊模式巴士、摩托車、計程車和麵包車是 BETA 功能。 所有區域都無法使用完整限制數據。

uphillEfficiency
query

number

double

指定當車輛提高高度 時,將儲存在燃料中的化學能量轉換為潛在能源的效率(即 PotentialEnergyGained/ChemicalEnergyConsumed)。ChemicalEnergyConsumed 是利用 燃料EnergyDensityInMJoulesPerLiter,將消耗的燃料轉換成化學能量來取得。

必須與 downhillEfficiency配對。

允許的值範圍是 0.0 到 1/downhillEfficiency

合理的值:適用於 燃燒模型:0.27,適用於 電動模型: 0.74

vehicleAxleWeight
query

integer

每軸車輛重量以公斤為單位。 值為 0 表示不會考慮每個軸的重量限制。

vehicleCommercial
query

boolean

車輛是否用於商業用途。 可能不允許商用車輛在一些道路上行駛。

vehicleEngineType
query

VehicleEngineType

車輛的引擎類型。 指定詳細的取用模型時,它必須與 vehicleEngineType的值一致。

vehicleHeading
query

integer

以度為單位的車輛方向方向從真正的北方開始,並順時針方向繼續。 北方是0度,東是90度,南是180度,西部是270度。 可能的值 0-359

vehicleHeight
query

number

double

車輛的高度以公尺為單位。 值為 0 表示不會考慮高度限制。

vehicleLength
query

number

double

車輛的長度以公尺為單位。 值為 0 表示不會考慮長度限制。

vehicleLoadType
query

VehicleLoadType

可能分類為危險物質的貨物類型,並受限於某些道路。 可用的 vehicleLoadType 值為 US Hazmat 類別 1 到 9,加上用於其他國家/地區的泛型分類。 以 USHazmat 開頭的值適用於美國路由,而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以指定多次。 此參數目前只考慮 travelMode=truck。

vehicleMaxSpeed
query

integer

車輛的最大速度,以公里/小時為單位。 車輛配置檔中的最大速度用於檢查高速公路上是否允許車輛。

  • 值為 0 表示將在路線規劃期間決定並套用車輛的適當值。

  • 在路線規劃期間,可能會覆寫非零的值。 例如,目前的流量為 60 公里/小時。 如果車輛最大速度設定為每小時 50 公里,路由引擎會考慮 60 公里/小時,因為這是目前的情況。 如果車輛的最大速度提供為80公里/小時,但目前的交通流量為60公里/小時,則路由引擎將再次使用60公里/小時。

vehicleWeight
query

integer

車輛重量以公斤為單位。

  • 如果已設定任何 *效率參數,則這是強制性的。

  • 在取用模型的內容中使用時,它必須嚴格為正數。 考慮權數限制。

  • 如果未指定詳細的 耗用量模型,且 車輛重量 的值為非零,則會考慮重量限制。

  • 在其他所有情況下,會忽略此參數。

合理的值:適用於 燃燒模型:1600,適用於 電動模型:1900

vehicleWidth
query

number

double

車輛寬度以公尺為單位。 值為 0 表示不會考慮寬度限制。

windingness
query

WindingnessLevel

驚心動魄路線的轉彎水準。 此參數只能與 routeType=thrilling 搭配使用。

要求標頭

名稱 必要 類型 Description
x-ms-client-id

string

指定要與 Microsoft Entra ID 安全性模型搭配使用的帳戶。 它代表 Azure 地圖服務帳戶的唯一標識碼,而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性,請參閱下列 文章 以取得指引。

要求本文

名稱 類型 Description
allowVignette

string[]

這是允許使用 Vignette 的 3 個字元、ISO 3166-1、Alpha-3 國家/地區的國家/地區代碼清單,例如“AUS,CHE”。 使用某些國家/地區 X 指定 allowVignette 相當於使用所有國家/地區指定 avoidVignette 但 X。使用空白清單指定 allowVignette 指定 allowVignette,與避免使用 vignettes 的所有收費公路相同。 注意:指定 avoidVignetteallowVignette是錯誤的。

avoidAreas

GeoJsonMultiPolygon

GeoJSON MultiPolygon,代表要避免的區域清單。 僅支援矩形多邊形。 矩形的大小上限約為 160x160 公里。 避免區域數目上限為 10。 它不能越過第180個子午線。 它必須介於 -80 到 +80 度的緯度之間。

avoidVignette

string[]

這是 3 個字元的清單,ISO 3166-1,alpha-3 國家/地區的國家/地區代碼,其中所有有 Vignette 的收費公路都必須避免,例如“AUS,CHE”。 不在清單中的國家/地區有 Vignette 的收費公路不受影響。 注意:指定 avoidVignetteallowVignette是錯誤的。

supportingPoints

GeoJsonGeometryCollection

GeoJSON Geometry 集合,代表用來作為路線重建輸入的座標序列,以及計算此參考路由的零個或多個替代路由。

  • 提供的支援點序列會作為路線重建的輸入。
  • 替代路由會計算在基底路徑參數位置中指定的原點和目的地點之間。
  • 如果 minDeviationDistanceminDeviationTime 都設定為零,則這些原點和目的地點應該分別位於參考路由的開頭和結尾(或非常接近)。
  • 使用 <supportingPoints>時,不支援中繼位置 (waypoints]。
  • 參考路由可能包含類型為 ROAD_CLOSURE的流量事件,這些事件會忽略,以計算參考路由的行進時間和流量延遲。 如需詳細資訊,請參閱 支援點

回應

名稱 類型 Description
200 OK

RouteDirections

還行

Other Status Codes

ErrorResponse

發生未預期的錯誤。

安全性

AADToken

這些是 Entra OAuth 2.0 Flow Microsoft。 與 Azure 角色型存取配對時, 控制它可用來控制 Azure 地圖服務 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。 任何使用者、群組或服務主體都可以透過內建角色或由一或多個 Azure 地圖服務 REST API 許可權所組成的自定義角色來授與存取權。

若要實作案例,建議您檢視 驗證概念。 總而言之,此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件,提供模型化應用程式的解決方案。

筆記

  • 此安全性定義 需要 使用 x-ms-client-id 標頭來指出應用程式要求存取的 Azure 地圖服務資源。 這可以從 地圖管理 API取得。

Authorization URL 專屬於 Azure 公用雲端實例。 主權雲端具有唯一的授權 URL,Microsoft Entra ID 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 管理 平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
https://atlas.microsoft.com/.default https://atlas.microsoft.com/.default

subscription-key

這是當您 在 Azure 入口網站或使用 PowerShell、CLI、Azure SDK 或 REST API 建立 Azure 地圖服務帳戶時所佈建的共用密鑰。

使用此金鑰,任何應用程式都可以存取所有 REST API。 換句話說,此金鑰可用來做為帳戶中核發的主要密鑰。

針對公開的應用程式,我們建議使用 機密用戶端應用程式 方法來存取 Azure 地圖服務 REST API,以便安全地儲存您的密鑰。

類型: apiKey
位於: query

SAS Token

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 azure 地圖服務資源 列表 SAS 作業建立共用存取簽章令牌。

使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並更精細地控制特定令牌的到期、速率和區域。 換句話說,SAS 令牌可用來讓應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式,我們建議在 對應帳戶資源上設定允許的來源特定清單, 以限制轉譯濫用,並定期更新 SAS 令牌。

類型: apiKey
位於: header

範例

Successfully retrieve a route between an origin and a destination with additional parameters in the body

範例要求

POST https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings

{
  "supportingPoints": {
    "type": "GeometryCollection",
    "geometries": [
      {
        "type": "Point",
        "coordinates": [
          13.42936,
          52.5093
        ]
      },
      {
        "type": "Point",
        "coordinates": [
          13.42859,
          52.50844
        ]
      }
    ]
  },
  "avoidVignette": [
    "AUS",
    "CHE"
  ],
  "avoidAreas": {
    "type": "MultiPolygon",
    "coordinates": [
      [
        [
          [
            -122.39456176757811,
            47.489368981370724
          ],
          [
            -122.00454711914061,
            47.489368981370724
          ],
          [
            -122.00454711914061,
            47.65151268066222
          ],
          [
            -122.39456176757811,
            47.65151268066222
          ],
          [
            -122.39456176757811,
            47.489368981370724
          ]
        ]
      ],
      [
        [
          [
            100,
            0
          ],
          [
            101,
            0
          ],
          [
            101,
            1
          ],
          [
            100,
            1
          ],
          [
            100,
            0
          ]
        ]
      ]
    ]
  }
}

範例回覆

{
  "formatVersion": "0.0.12",
  "routes": [
    {
      "summary": {
        "lengthInMeters": 1147,
        "travelTimeInSeconds": 162,
        "trafficDelayInSeconds": 0,
        "departureTime": "2017-09-07T16:56:58+00:00",
        "arrivalTime": "2017-09-07T16:59:40+00:00"
      },
      "legs": [
        {
          "summary": {
            "lengthInMeters": 1147,
            "travelTimeInSeconds": 162,
            "trafficDelayInSeconds": 0,
            "departureTime": "2017-09-07T16:56:58+00:00",
            "arrivalTime": "2017-09-07T16:59:40+00:00"
          },
          "points": [
            {
              "latitude": 52.50931,
              "longitude": 13.42937
            },
            {
              "latitude": 52.50904,
              "longitude": 13.42912
            },
            {
              "latitude": 52.50894,
              "longitude": 13.42904
            },
            {
              "latitude": 52.50867,
              "longitude": 13.42879
            },
            {
              "latitude": 52.5084,
              "longitude": 13.42857
            },
            {
              "latitude": 52.50791,
              "longitude": 13.42824
            },
            {
              "latitude": 52.50757,
              "longitude": 13.42772
            },
            {
              "latitude": 52.50735,
              "longitude": 13.42823
            },
            {
              "latitude": 52.5073,
              "longitude": 13.42836
            },
            {
              "latitude": 52.50573,
              "longitude": 13.43194
            },
            {
              "latitude": 52.50512,
              "longitude": 13.43336
            },
            {
              "latitude": 52.50464,
              "longitude": 13.43451
            },
            {
              "latitude": 52.5045,
              "longitude": 13.43481
            },
            {
              "latitude": 52.50443,
              "longitude": 13.43498
            },
            {
              "latitude": 52.50343,
              "longitude": 13.43737
            },
            {
              "latitude": 52.50274,
              "longitude": 13.43872
            }
          ]
        }
      ],
      "sections": [
        {
          "startPointIndex": 0,
          "endPointIndex": 15,
          "sectionType": "TRAVEL_MODE",
          "travelMode": "car"
        }
      ]
    }
  ]
}

定義

名稱 Description
AlternativeRouteType

相較於參考路由,控制所計算替代方案的指定規劃準則的最佳性。

ComputeTravelTime

指定是否使用不同類型的交通資訊傳回額外的旅行時間(無、歷史、即時),以及預設的最佳估計旅行時間。

DelayMagnitude

事件造成的延遲幅度。 這些值會對應至 取得流量事件詳細數據 API回應欄位 ty 的值。

DrivingSide

表示在機動點的左側與右側駕駛。

EffectiveSetting

呼叫此路由 API 時所使用的有效參數或數據。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

GeoJsonGeometry

有效的 GeoJSON geometry 物件。 此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 如需詳細資訊,請參閱 RFC 7946

GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 物件類型。 如需詳細資訊,請參閱 RFC 7946

GeoJsonLineString

有效的 GeoJSON LineString 幾何類型。 如需詳細資訊,請參閱 RFC 7946

GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 幾何類型。 如需詳細資訊,請參閱 RFC 7946

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 幾何類型。 如需詳細資訊,請參閱 RFC 7946

GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 物件類型。 如需詳細資訊,請參閱 RFC 7946

GeoJsonPoint

有效的 GeoJSON Point 幾何類型。 如需詳細資訊,請參閱 RFC 7946

GeoJsonPolygon

有效的 GeoJSON Polygon 幾何類型。 如需詳細資訊,請參閱 RFC 7946

GuidanceInstructionType

指示的類型,例如,轉向或變更道路形式。

GuidanceManeuver

識別動作的程序代碼。

InclineLevel

驚心動魄路線的丘陵程度。 此參數只能與 routeType=thrilling 搭配使用。

JunctionType

動作的交匯點類型。 對於較大的環圈,會產生兩個不同的指示來輸入和離開環島。

LatLongPair

以緯度和經度表示的位置。

Report

指定應報告哪些數據以供診斷之用。 唯一可能的值是 effectiveSettings。 報告呼叫 API 時所使用的有效參數或數據。 在預設參數的情況下,預設會反映呼叫端未指定參數的位置。

ResponseFormat

回應所需的格式。 值可以是 json xml

ResponseSectionType

回報路由回應的區段類型

ResponseTravelMode

匯出路線的行進模式。 如果本節中不可能有要求的傳輸模式,此值將會設定為 other

Route
RouteAvoidType

指定路由計算在判斷路由時應嘗試避免的事項。 可以在一個要求中指定多次,例如『&avoid=高速公路&avoid=tollRoads&avoid=ferries』。 在 [路由範圍] 要求中,不得使用已經使用的值UsedRoads。

RouteDirectionParameters

Post body parameters for Route directions.

RouteDirections

此物件會從成功的路由方向呼叫傳回

RouteGuidance

包含指引相關元素。 只有在要求指導方針且可供使用時,才會顯示此欄位。

RouteInstruction

一組描述機動的屬性,例如「向右轉」、「保持左轉」、「乘坐渡輪」、「乘坐高速公路」、「到達」。

RouteInstructionGroup

將彼此相關的指令元素序列分組。 序列範圍受限於 firstInstructionIndex 和 lastInstructionIndex。 當要求人類可讀取的文字訊息以取得指引時(instructionType=text 或標記),則 instructionGroup 會在可用時傳回摘要訊息。

RouteInstructionsType

如果指定,將會傳回指引指示。 請注意,instructionsType 參數不能與 routeRepresentation=none 搭配使用。

RouteLeg

由點清單所組成的路線部分描述。 要求中提供的每個額外導航點,都會在傳回的路線中再增加一條腿。

RouteLegSummary

路由區段的 Summary 物件。

RouteOptimizedWaypoint

優化的方式點物件。

RouteReport

報告目前呼叫中使用的有效設定。

RouteRepresentationForBestOrder

指定提供做為回應之路由集的表示。

RouteSection

路由區段包含路由部分的其他資訊。 每個區段至少包含 startPointIndexendPointIndexsectionType的專案。

RouteSectionTec

流量事件的詳細數據,使用 TPEG2-TEC 標準中的定義。 可以包含 effectCode 並造成專案。

RouteSectionTecCause

流量事件的原因。 可以包含mainCauseCode和subCauseCode元素。 可以用來定義圖示和描述。

RouteSummary

Summary 物件

RouteType

要求的路由類型。

SectionType

指定路由回應中報告哪些區段類型。

例如,如果 sectionType = 行人,則只傳回適合行人之區段。 可以在一個要求中指定多次,例如 '§ionType=carTrain§ionType=pedestrian§ionType=motorway'。 默認 sectionType 是指 travelMode 輸入。 根據預設,travelMode 會設定為 car

SimpleCategory

事件的類型。 目前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 如需詳細資訊,請參閱 「tec」。

TravelMode

所要求路線的移動模式。 如果未定義,預設值為 『car』。 請注意,要求的 travelMode 可能無法用於整個路線。 當要求之 travelMode 不適用於特定區段時,該區段回應的 travelMode 元素將會是 “other”。 請注意,旅遊模式巴士、摩托車、計程車和麵包車是 BETA 功能。 所有區域都無法使用完整限制數據。

VehicleEngineType

車輛的引擎類型。 指定詳細的取用模型時,它必須與 vehicleEngineType的值一致。

VehicleLoadType

可能分類為危險物質的貨物類型,並受限於某些道路。 可用的 vehicleLoadType 值為 US Hazmat 類別 1 到 9,加上用於其他國家/地區的泛型分類。 以 USHazmat 開頭的值適用於美國路由,而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以指定多次。 此參數目前只考慮 travelMode=truck。

WindingnessLevel

驚心動魄路線的轉彎水準。 此參數只能與 routeType=thrilling 搭配使用。

AlternativeRouteType

相較於參考路由,控制所計算替代方案的指定規劃準則的最佳性。

名稱 類型 Description
anyRoute

string

允許傳回任何替代路由,無論其如何以最佳性比較參考路由。

betterRoute

string

只有在根據指定的規劃準則比參考路由更好時,才傳回替代路由。

ComputeTravelTime

指定是否使用不同類型的交通資訊傳回額外的旅行時間(無、歷史、即時),以及預設的最佳估計旅行時間。

名稱 類型 Description
all

string

計算所有類型的流量信息的移動時間,並指定路由響應中摘要中包含的所有結果欄位 noTrafficTravelTimeInSeconds、historicTrafficTravelTimeInSeconds 和 liveTrafficIncidentsTravelTimeInSeconds 字段中的所有結果。

none

string

不會計算額外的旅行時間。

DelayMagnitude

事件造成的延遲幅度。 這些值會對應至 取得流量事件詳細數據 API回應欄位 ty 的值。

名稱 類型 Description
0

string

未知。

1

string

次要。

2

string

溫和。

3

string

主要。

4

string

未定義,用於道路封閉和其他無限期延誤。

DrivingSide

表示在機動點的左側與右側駕駛。

名稱 類型 Description
LEFT

string

左。

RIGHT

string

右。

EffectiveSetting

呼叫此路由 API 時所使用的有效參數或數據。

名稱 類型 Description
key

string

所使用的參數名稱。

value

string

所使用的參數值。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。

type

string

其他信息類型。

ErrorDetail

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。

code

string

錯誤碼。

details

ErrorDetail[]

錯誤詳細數據。

message

string

錯誤訊息。

target

string

錯誤目標。

ErrorResponse

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

GeoJsonGeometry

有效的 GeoJSON geometry 物件。 此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 如需詳細資訊,請參閱 RFC 7946

名稱 類型 Description
type

GeoJsonObjectType

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonGeometryCollection

有效的 GeoJSON GeometryCollection 物件類型。 如需詳細資訊,請參閱 RFC 7946

名稱 類型 Description
geometries GeoJsonGeometry[]:

包含有效的 GeoJSON geometry 物件清單。 注意 GeoJSON 中的座標 以 x、y 順序(經度、緯度) 為單位。

type string:

GeometryCollection

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonLineString

有效的 GeoJSON LineString 幾何類型。 如需詳細資訊,請參閱 RFC 7946

名稱 類型 Description
coordinates

number[]

GeoJson LineString 幾何座標。

type string:

LineString

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiLineString

有效的 GeoJSON MultiLineString 幾何類型。 如需詳細資訊,請參閱 RFC 7946

名稱 類型 Description
coordinates

number[]

GeoJson MultiLineString 幾何座標。

type string:

MultiLineString

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPoint

有效的 GeoJSON MultiPoint 幾何類型。 如需詳細資訊,請參閱 RFC 7946

名稱 類型 Description
coordinates

number[]

GeoJson MultiPoint 幾何座標。

type string:

MultiPoint

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonMultiPolygon

有效的 GeoJSON MultiPolygon 物件類型。 如需詳細資訊,請參閱 RFC 7946

名稱 類型 Description
coordinates

number[]

包含有效的 GeoJSON Polygon 物件清單。 注意 GeoJSON 中的座標 以 x、y 順序(經度、緯度) 為單位。

type string:

MultiPolygon

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPoint

有效的 GeoJSON Point 幾何類型。 如需詳細資訊,請參閱 RFC 7946

名稱 類型 Description
coordinates

number[]

Position 是具有兩個或多個元素的數字數位數位數位。 前兩個元素是 經度緯度,確切地依該順序排列。 高度/高度 是選擇性的第三個專案。 如需詳細資訊,請參閱 RFC 7946

type string:

Point

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GeoJsonPolygon

有效的 GeoJSON Polygon 幾何類型。 如需詳細資訊,請參閱 RFC 7946

名稱 類型 Description
coordinates

number[]

GeoJson Polygon 幾何類型的座標。

type string:

Polygon

指定 GeoJSON 類型。 必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

GuidanceInstructionType

指示的類型,例如,轉向或變更道路形式。

名稱 類型 Description
DIRECTION_INFO

string

方向資訊。

LOCATION_ARRIVAL

string

抵達位置。

LOCATION_DEPARTURE

string

出發地點。

LOCATION_WAYPOINT

string

方向點位置。

ROAD_CHANGE

string

道路變更。

TURN

string

轉。

GuidanceManeuver

識別動作的程序代碼。

名稱 類型 Description
ARRIVE

string

你已經到達了。

ARRIVE_LEFT

string

你已經到達了。 您的目的地位於左側。

ARRIVE_RIGHT

string

你已經到達了。 您的目的地位於右側。

BEAR_LEFT

string

熊左。

BEAR_RIGHT

string

熊右。

DEPART

string

離開。

ENTER_FREEWAY

string

走高速公路。

ENTER_HIGHWAY

string

走高速公路。

ENTER_MOTORWAY

string

走高速公路。

ENTRANCE_RAMP

string

走坡道。

FOLLOW

string

跟隨。

KEEP_LEFT

string

保持左。

KEEP_RIGHT

string

保持正確。

MAKE_UTURN

string

製作U轉彎。

MOTORWAY_EXIT_LEFT

string

離開左側。

MOTORWAY_EXIT_RIGHT

string

離開右側。

ROUNDABOUT_BACK

string

四處走動。

ROUNDABOUT_CROSS

string

越過環島。

ROUNDABOUT_LEFT

string

在環形交叉路口,左方結束。

ROUNDABOUT_RIGHT

string

在環形交叉路口,右方結束。

SHARP_LEFT

string

左轉尖銳。

SHARP_RIGHT

string

向右翻轉。

STRAIGHT

string

保持直截了當。

SWITCH_MAIN_ROAD

string

切換到主幹道。

SWITCH_PARALLEL_ROAD

string

切換至平行道路。

TAKE_EXIT

string

結束。

TAKE_FERRY

string

乘坐渡輪。

TRY_MAKE_UTURN

string

嘗試進行U轉彎。

TURN_LEFT

string

左轉。

TURN_RIGHT

string

向右轉。

WAYPOINT_LEFT

string

您已到達路點。 它位於左邊。

WAYPOINT_REACHED

string

您已到達路點。

WAYPOINT_RIGHT

string

您已到達路點。 它就在右邊。

InclineLevel

驚心動魄路線的丘陵程度。 此參數只能與 routeType=thrilling 搭配使用。

名稱 類型 Description
high

string

low

string

normal

string

正常

JunctionType

動作的交匯點類型。 對於較大的環圈,會產生兩個不同的指示來輸入和離開環島。

名稱 類型 Description
BIFURCATION

string

分 岔

REGULAR

string

定期

ROUNDABOUT

string

環形交叉

LatLongPair

以緯度和經度表示的位置。

名稱 類型 Description
latitude

number

Latitude 屬性

longitude

number

經度屬性

Report

指定應報告哪些數據以供診斷之用。 唯一可能的值是 effectiveSettings。 報告呼叫 API 時所使用的有效參數或數據。 在預設參數的情況下,預設會反映呼叫端未指定參數的位置。

名稱 類型 Description
effectiveSettings

string

報告呼叫 API 時所使用的有效參數或數據。

ResponseFormat

回應所需的格式。 值可以是 json xml

名稱 類型 Description
json

string

JavaScript 物件表示法數據交換格式

xml

string

可延伸標記語言

ResponseSectionType

回報路由回應的區段類型

名稱 類型 Description
CARPOOL

string

需要使用拼車(HOV/高佔用車輛)車道的路線區段。

CAR_TRAIN

string

汽車或火車路線的區段。

COUNTRY

string

區段,指出路由所在的國家/地區。

FERRY

string

渡輪路線的區段。

MOTORWAY

string

高速公路路線的路段。

PEDESTRIAN

string

僅適用於行人的路線區段。

TOLL_ROAD

string

需要付費的路線區段。

TOLL_VIGNETTE

string

需要有收費 Vignette 的路線區段。

TRAFFIC

string

包含流量資訊的路由區段。

TRAVEL_MODE

string

與要求參數相關的區段 travelMode

TUNNEL

string

屬於通道之路由的區段。

URBAN

string

位於城市區域內的路線區段。

ResponseTravelMode

匯出路線的行進模式。 如果本節中不可能有要求的傳輸模式,此值將會設定為 other

名稱 類型 Description
bicycle

string

傳回的路線已針對自行車進行優化,包括使用自行車道。

bus

string

傳回的路線已針對公交車進行優化,包括只使用公交車車道。 BETA 功能。

car

string

傳回的路線已針對汽車進行優化。

motorcycle

string

傳回的路線已針對摩托車進行優化。 BETA 功能。

other

string

本節中無法提供指定的傳輸模式

pedestrian

string

傳回的路線已針對行人進行優化,包括人行道的使用。

taxi

string

傳回的路線已針對計程車進行優化。 BETA 功能。

truck

string

傳回的路線已針對商用車輛進行優化,例如卡車。

van

string

傳回的路線已針對麵包車進行優化。 BETA 功能。

Route

名稱 類型 Description
guidance

RouteGuidance

包含指引相關元素。 只有在要求指導方針且可供使用時,才會顯示此欄位。

legs

RouteLeg[]

Legs 陣列

sections

RouteSection[]

Sections 陣列

summary

RouteSummary

Summary 物件

RouteAvoidType

指定路由計算在判斷路由時應嘗試避免的事項。 可以在一個要求中指定多次,例如『&avoid=高速公路&avoid=tollRoads&avoid=ferries』。 在 [路由範圍] 要求中,不得使用已經使用的值UsedRoads。

名稱 類型 Description
alreadyUsedRoads

string

避免多次使用相同的道路。 與 routeType=thrilling 搭配使用時,最有用。

borderCrossings

string

避免路由計算中的邊界交叉。

carpools

string

避免需要使用拼車(HOV/高佔用車輛)車道的路線。

ferries

string

避免渡輪

motorways

string

避免高速公路

tollRoads

string

避免收費道路。

unpavedRoads

string

避免未修補的道路

RouteDirectionParameters

Post body parameters for Route directions.

名稱 類型 Description
allowVignette

string[]

這是允許使用 Vignette 的 3 個字元、ISO 3166-1、Alpha-3 國家/地區的國家/地區代碼清單,例如“AUS,CHE”。 使用某些國家/地區 X 指定 allowVignette 相當於使用所有國家/地區指定 avoidVignette 但 X。使用空白清單指定 allowVignette 指定 allowVignette,與避免使用 vignettes 的所有收費公路相同。 注意:指定 avoidVignetteallowVignette是錯誤的。

avoidAreas

GeoJsonMultiPolygon

GeoJSON MultiPolygon,代表要避免的區域清單。 僅支援矩形多邊形。 矩形的大小上限約為 160x160 公里。 避免區域數目上限為 10。 它不能越過第180個子午線。 它必須介於 -80 到 +80 度的緯度之間。

avoidVignette

string[]

這是 3 個字元的清單,ISO 3166-1,alpha-3 國家/地區的國家/地區代碼,其中所有有 Vignette 的收費公路都必須避免,例如“AUS,CHE”。 不在清單中的國家/地區有 Vignette 的收費公路不受影響。 注意:指定 avoidVignetteallowVignette是錯誤的。

supportingPoints

GeoJsonGeometryCollection

GeoJSON Geometry 集合,代表用來作為路線重建輸入的座標序列,以及計算此參考路由的零個或多個替代路由。

  • 提供的支援點序列會作為路線重建的輸入。
  • 替代路由會計算在基底路徑參數位置中指定的原點和目的地點之間。
  • 如果 minDeviationDistanceminDeviationTime 都設定為零,則這些原點和目的地點應該分別位於參考路由的開頭和結尾(或非常接近)。
  • 使用 <supportingPoints>時,不支援中繼位置 (waypoints]。
  • 參考路由可能包含類型為 ROAD_CLOSURE的流量事件,這些事件會忽略,以計算參考路由的行進時間和流量延遲。 如需詳細資訊,請參閱 支援點

RouteDirections

此物件會從成功的路由方向呼叫傳回

名稱 類型 Description
formatVersion

string

Format Version 屬性

optimizedWaypoints

RouteOptimizedWaypoint[]

優化的方式點序列。 它會顯示使用者針對原始和優化清單提供之導航點序列的索引。 例如,回應:

<optimizedWaypoints>
<waypoint providedIndex="0" optimizedIndex="1"/>
<waypoint providedIndex="1" optimizedIndex="2"/>
<waypoint providedIndex="2" optimizedIndex="0"/>
</optimizedWaypoints>

表示原始序列為 [0, 1, 2] 且優化序列為 [1, 2, 0]。 由於索引從 0 開始,原始為 “first, second, third” ,而優化則為 “second, third, first” 。

report

RouteReport

報告目前呼叫中使用的有效設定。

routes

Route[]

路由陣列

RouteGuidance

包含指引相關元素。 只有在要求指導方針且可供使用時,才會顯示此欄位。

名稱 類型 Description
instructionGroups

RouteInstructionGroup[]

將彼此相關的指令元素序列分組。

instructions

RouteInstruction[]

描述動作的指示清單。

RouteInstruction

一組描述機動的屬性,例如「向右轉」、「保持左轉」、「乘坐渡輪」、「乘坐高速公路」、「到達」。

名稱 類型 Description
combinedMessage

string

動作的人類可讀取訊息,結合下一個指示中的訊息。 有時候,可以將兩個連續的指示合併成單一指令,以便更容易遵循。 當發生這種情況時,possibleCombineWithNext 旗標會是 true。 例如:

10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam

指令 10 上的 possibleCombineWithNext 旗標為 true。 這向程式代碼指引的用戶端表示,它可以與指令 11 結合。 系統會針對要求人類可讀取指引的用戶端,自動合併這些指示。 combinedMessage 字段包含合併的訊息:

Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam
then follow Einsteinweg/A10/E22 towards Ring Amsterdam.
countryCode

string

3 個字元 ISO 3166-1 alpha-3 國家/地區代碼。 例如美國

drivingSide

DrivingSide

表示在機動點的左側與右側駕駛。

exitNumber

string

目前機動的高速公路出口數目。 如果結束有多個結束號碼,它們會以 “,”分隔,而且可能由 “-” 匯總,例如 “10, 13-15”。

instructionType

GuidanceInstructionType

指示的類型,例如,轉向或變更道路形式。

junctionType

JunctionType

動作的交匯點類型。 對於較大的環圈,會產生兩個不同的指示來輸入和離開環島。

maneuver

GuidanceManeuver

識別動作的程序代碼。

message

string

人類可讀的動作訊息。

point

LatLongPair

以緯度和經度表示的位置。

pointIndex

integer

與指令點相對應之聚合線條 「points」 清單中的點索引。

possibleCombineWithNext

boolean

您可以選擇性地結合指令與下一個指令。 這可用來建置訊息,例如「向左轉,然後向右轉」。

roadNumbers

string[]

下一個重大路段的路號(s)在機動后,或道路(s)的路號要跟隨。 範例:[“E34”, “N205”]

roundaboutExitNumber

integer

這表示在環島採取哪一個結束。

routeOffsetInMeters

integer

從路線起點到指令點的距離。

signpostText

string

路標上的文字,與機動最相關的文字,或應遵循的方向。

stateCode

string

ISO 3166-2 代碼的第二個部分表示的國家/地區的細分(例如,州)。 這僅適用於某些國家/地區,例如美國、加拿大和墨西哥。

street

string

動作之後下一條重要路段的街道名稱,或應遵循的街道名稱。

travelTimeInSeconds

integer

估計行進時間到對應至 routeOffsetInMeters 的點。

turnAngleInDecimalDegrees

integer

指示的方向。 如果 junctionType 指出回合指示:

  • 180 = U-turn
  • [-179, -1] = 左轉
  • 0 = 直接開啟 (0 度』 回合 )
  • [1, 179] = 右轉

如果 junctionType 表示 bifurcation 指令:

  • <0 - 保留左
  • >0 - 保持正確

RouteInstructionGroup

將彼此相關的指令元素序列分組。 序列範圍受限於 firstInstructionIndex 和 lastInstructionIndex。 當要求人類可讀取的文字訊息以取得指引時(instructionType=text 或標記),則 instructionGroup 會在可用時傳回摘要訊息。

名稱 類型 Description
firstInstructionIndex

integer

指示中第一個指令的索引,並屬於此群組。

groupLengthInMeters

integer

群組的長度。

groupMessage

string

當要求人類可讀取的文字訊息以取得指引時摘要訊息(instructionType=text 或已標記)。

lastInstructionIndex

integer

指示中最後一個指令的索引,並屬於此群組。

RouteInstructionsType

如果指定,將會傳回指引指示。 請注意,instructionsType 參數不能與 routeRepresentation=none 搭配使用。

名稱 類型 Description
coded

string

傳回未經人類讀取訊息的原始指令數據。

tagged

string

傳回具有標記人類可讀取訊息的原始指令數據,以允許格式化。 人類可讀取的訊息是由可重複識別的元素所建置。 這些標記可讓用戶端應用程式正確格式化。 當 instructionsType=tagged 時,會標記下列訊息元件:street、roadNumber、signpostText、exitNumber、roundaboutExitNumber。

已標記 『Turn left』 訊息的範例:

Turn left onto <roadNumber>A4</roadNumber>/<roadNumber>E19</roadNumber>
towards <signpostText>Den Haag</signpostText>
text

string

以純文本傳回具有人類可讀取訊息的原始指示數據。

RouteLeg

由點清單所組成的路線部分描述。 要求中提供的每個額外導航點,都會在傳回的路線中再增加一條腿。

名稱 類型 Description
points

LatLongPair[]

Points 陣列

summary

RouteLegSummary

路由區段的 Summary 物件。

RouteLegSummary

路由區段的 Summary 物件。

名稱 類型 Description
arrivalTime

string

路線或腿部的估計抵達時間。 時間以UTC為單位。

batteryConsumptionInkWh

number

使用電耗模型估計千瓦時(kWh)的電力能耗。 如果 vehicleEngineType 設定為電動,且指定 constantSpeedConsumptionInkWhPerHundredkm,則包含 。 batteryConsumptionInkWh 的值包括回收的電力,因此可以是負數(這表示獲得能量)。 如果同時指定 maxChargeInkWh 和 currentChargeInkWh,則會封存,以確保電池電量永遠不會超過 maxChargeInkWh。 如果未指定 maxChargeInkWh 和 currentChargeInkWh,則會在耗用量計算中假設未受限制的回收。

departureTime

string

路線或腿部的估計出發時間。 時間以UTC為單位。

fuelConsumptionInLiters

number

使用燃燒耗用量模型以升為單位的估計燃料耗用量。 如果 vehicleEngineType 設定為 燃燒,且指定 constantSpeedConsumptionInLitersPerHundredkm,則包含 。 值將是非負數。

historicTrafficTravelTimeInSeconds

integer

使用時間相依的歷史流量數據計算的預估行進時間。 只有當 computeTravelTimeFor = 全部用於查詢時,才會包含 。

lengthInMeters

integer

Length In Meters 屬性

liveTrafficIncidentsTravelTimeInSeconds

integer

使用即時速度數據計算的預估行進時間。 只有當 computeTravelTimeFor = 全部用於查詢時,才會包含 。

noTrafficTravelTimeInSeconds

integer

由於交通狀況(例如擁堵)而計算的估計行程時間,好像路線上沒有延誤。 只有當 computeTravelTimeFor = 全部用於查詢時,才會包含 。

trafficDelayInSeconds

integer

根據交通資訊,由即時事件造成的秒數估計延遲。 對於規劃未來出發時間的航線,延誤一律為 0。 若要使用不同類型的流量資訊傳回其他旅行時間,必須新增parameter computeTravelTimeFor=all。

travelTimeInSeconds

integer

估計的行進時間,以秒為單位屬性,其中包含由於即時流量造成的延遲。 請注意,即使 traffic=false travelTimeInSeconds 仍然包含流量造成的延遲。 如果 DepartAt 是未來,則會使用時間相依的歷史交通數據來計算行進時間。

RouteOptimizedWaypoint

優化的方式點物件。

名稱 類型 Description
optimizedIndex

integer

從系統優化的方式點索引。

providedIndex

integer

使用者提供的方式點索引。

RouteReport

報告目前呼叫中使用的有效設定。

名稱 類型 Description
effectiveSettings

EffectiveSetting[]

呼叫此路由 API 時所使用的有效參數或數據。

RouteRepresentationForBestOrder

指定提供做為回應之路由集的表示。

名稱 類型 Description
none

string

只包含優化的 waypoint 索引,但不包含回應中的路由幾何。 此參數值只能與 computeBestOrder=true 搭配使用。

polyline

string

在回應中包含路由幾何。

summaryOnly

string

根據聚合線條摘要,但不包括回應中路由的點幾何元素。

RouteSection

路由區段包含路由部分的其他資訊。 每個區段至少包含 startPointIndexendPointIndexsectionType的專案。

名稱 類型 Description
delayInSeconds

integer

事件造成的延遲以秒為單位。

effectiveSpeedInKmh

integer

以公里/小時為單位的事件有效速度,平均超過其整個長度。

endPointIndex

integer

本節所套用路由中最後一個點 (位移 0) 的索引。

magnitudeOfDelay

DelayMagnitude

事件造成的延遲幅度。 這些值會對應至 取得流量事件詳細數據 API回應欄位 ty 的值。

sectionType

ResponseSectionType

回報路由回應的區段類型

simpleCategory

SimpleCategory

事件的類型。 目前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 如需詳細資訊,請參閱 「tec」。

startPointIndex

integer

本節所套用路由中第一個點 (位移 0) 的索引。

tec

RouteSectionTec

流量事件的詳細數據,使用 TPEG2-TEC 標準中的定義。 可以包含 effectCode 並造成專案。

travelMode

ResponseTravelMode

匯出路線的行進模式。 如果本節中不可能有要求的傳輸模式,此值將會設定為 other

RouteSectionTec

流量事件的詳細數據,使用 TPEG2-TEC 標準中的定義。 可以包含 effectCode 並造成專案。

名稱 類型 Description
causes

RouteSectionTecCause[]

造成陣列

effectCode

integer

對流量的影響。 包含 tec001:EffectCode 數據表中的值,如 TPEG2-TEC 標準中所定義。 可用來根據嚴重性來色彩編碼流量事件。

RouteSectionTecCause

流量事件的原因。 可以包含mainCauseCode和subCauseCode元素。 可以用來定義圖示和描述。

名稱 類型 Description
mainCauseCode

integer

流量事件的主要原因。 包含 tec002:CauseCode 數據表中的值,如 TPEG2-TEC 標準中所定義。

subCauseCode

integer

流量事件的子類別。 在mainCauseCode所定義的子原因數據表中包含值,如 TPEG2-TEC 標準中所定義。

RouteSummary

Summary 物件

名稱 類型 Description
arrivalTime

string

路線或腿部的估計抵達時間。 時間以UTC為單位。

departureTime

string

路線或腿部的估計出發時間。 時間以UTC為單位。

lengthInMeters

integer

Length In Meters 屬性

trafficDelayInSeconds

integer

根據交通資訊,由即時事件造成的秒數估計延遲。 對於規劃未來出發時間的航線,延誤一律為 0。 若要使用不同類型的流量資訊傳回其他旅行時間,必須新增parameter computeTravelTimeFor=all。

travelTimeInSeconds

integer

估計的行進時間,以秒為單位屬性,其中包含由於即時流量造成的延遲。 請注意,即使 traffic=false travelTimeInSeconds 仍然包含流量造成的延遲。 如果 DepartAt 是未來,則會使用時間相依的歷史交通數據來計算行進時間。

RouteType

要求的路由類型。

名稱 類型 Description
eco

string

經濟和速度平衡的路線。

fastest

string

最快的路線。

shortest

string

依距離的最短路線。

thrilling

string

包含有趣或具有挑戰性的道路,並盡可能少地使用高速公路。 您可以選擇包含的回合層級,以及丘陵程度。 如需如何設定此設定,請參閱丘陵和線圈參數。 規劃的路線限制為900公里,routeType=驚心動魄

SectionType

指定路由回應中報告哪些區段類型。

例如,如果 sectionType = 行人,則只傳回適合行人之區段。 可以在一個要求中指定多次,例如 '§ionType=carTrain§ionType=pedestrian§ionType=motorway'。 默認 sectionType 是指 travelMode 輸入。 根據預設,travelMode 會設定為 car

名稱 類型 Description
carTrain

string

汽車或火車路線的區段。

carpool

string

需要使用拼車(HOV/高佔用車輛)車道的路線區段。

country

string

區段,指出路由所在的國家/地區。

ferry

string

渡輪路線的區段。

motorway

string

高速公路路線的路段。

pedestrian

string

僅適用於行人的路線區段。

tollRoad

string

需要付費的路線區段。

tollVignette

string

需要有收費 Vignette 的路線區段。

traffic

string

包含流量資訊的路由區段。

travelMode

string

與要求參數相關的區段 travelMode

tunnel

string

屬於通道之路由的區段。

urban

string

位於城市區域內的路線區段。

SimpleCategory

事件的類型。 目前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 如需詳細資訊,請參閱 「tec」。

名稱 類型 Description
JAM

string

塞車。

OTHER

string

其他。

ROAD_CLOSURE

string

道路封閉。

ROAD_WORK

string

道路工作。

TravelMode

所要求路線的移動模式。 如果未定義,預設值為 『car』。 請注意,要求的 travelMode 可能無法用於整個路線。 當要求之 travelMode 不適用於特定區段時,該區段回應的 travelMode 元素將會是 “other”。 請注意,旅遊模式巴士、摩托車、計程車和麵包車是 BETA 功能。 所有區域都無法使用完整限制數據。

名稱 類型 Description
bicycle

string

傳回的路線已針對自行車進行優化,包括使用自行車道。

bus

string

傳回的路線已針對公交車進行優化,包括只使用公交車車道。 BETA 功能。

car

string

傳回的路線已針對汽車進行優化。

motorcycle

string

傳回的路線已針對摩托車進行優化。 BETA 功能。

pedestrian

string

傳回的路線已針對行人進行優化,包括人行道的使用。

taxi

string

傳回的路線已針對計程車進行優化。 BETA 功能。

truck

string

傳回的路線已針對商用車輛進行優化,例如卡車。

van

string

傳回的路線已針對麵包車進行優化。 BETA 功能。

VehicleEngineType

車輛的引擎類型。 指定詳細的取用模型時,它必須與 vehicleEngineType的值一致。

名稱 類型 Description
combustion

string

內燃機。

electric

string

電動引擎。

VehicleLoadType

可能分類為危險物質的貨物類型,並受限於某些道路。 可用的 vehicleLoadType 值為 US Hazmat 類別 1 到 9,加上用於其他國家/地區的泛型分類。 以 USHazmat 開頭的值適用於美國路由,而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以指定多次。 此參數目前只考慮 travelMode=truck。

名稱 類型 Description
USHazmatClass1

string

炸藥

USHazmatClass2

string

壓縮氣體

USHazmatClass3

string

易燃液體

USHazmatClass4

string

易燃固體

USHazmatClass5

string

Oxidizers

USHazmatClass6

string

毒藥

USHazmatClass7

string

放射性

USHazmatClass8

string

腐蝕

USHazmatClass9

string

雜項

otherHazmatExplosive

string

炸藥

otherHazmatGeneral

string

雜項

otherHazmatHarmfulToWater

string

對水有害

WindingnessLevel

驚心動魄路線的轉彎水準。 此參數只能與 routeType=thrilling 搭配使用。

名稱 類型 Description
high

string

low

string

normal

string

正常