Route - Get Route Directions
使用 來計算指定來源與目的地之間的路由,並傳遞任何指定的路徑點。
Get Route Directions
API 是 HTTP GET
要求,會傳回來源與目的地之間的路由,並在指定時通過 waypoint。 路線會將目前交通和一般道路速度等因素納入考慮,例如一周的要求日和一天的時間。
傳回的資訊包括距離、估計的行進時間,以及路線幾何的表示法。 視選取的選項而定,也提供其他路由資訊,例如優化的路線點順序或回合指示。
路由服務會提供一組參數,以取得車輛特定耗用量模型的詳細描述。 如需詳細資訊,請參閱 取用模型。
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}&maxAlternatives={maxAlternatives}&alternativeType={alternativeType}&minDeviationDistance={minDeviationDistance}&arriveAt={arriveAt}&departAt={departAt}&minDeviationTime={minDeviationTime}&instructionsType={instructionsType}&language={language}&computeBestOrder={computeBestOrder}&routeRepresentation={routeRepresentation}&computeTravelTimeFor={computeTravelTimeFor}&vehicleHeading={vehicleHeading}&report=effectiveSettings§ionType={sectionType}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}&vehicleEngineType={vehicleEngineType}&constantSpeedConsumptionInLitersPerHundredkm={constantSpeedConsumptionInLitersPerHundredkm}¤tFuelInLiters={currentFuelInLiters}&auxiliaryPowerInLitersPerHour={auxiliaryPowerInLitersPerHour}&fuelEnergyDensityInMJoulesPerLiter={fuelEnergyDensityInMJoulesPerLiter}&accelerationEfficiency={accelerationEfficiency}&decelerationEfficiency={decelerationEfficiency}&uphillEfficiency={uphillEfficiency}&downhillEfficiency={downhillEfficiency}&constantSpeedConsumptionInkWhPerHundredkm={constantSpeedConsumptionInkWhPerHundredkm}¤tChargeInkWh={currentChargeInkWh}&maxChargeInkWh={maxChargeInkWh}&auxiliaryPowerInkW={auxiliaryPowerInkW}
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
format
|
path | True |
所需的回應格式。 值可以是 json 或 xml。 |
|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
query
|
query | True |
string |
用來計算路由的座標,並以冒號分隔。 至少需要兩個座標。 第一個是來源,最後一個是路由的目的地。 在兩者之間的選擇性座標會作為路由中的 WayPoints。 您最多可以傳遞 150 個 WayPoint。 |
acceleration
|
query |
number double |
指定當車輛加速 (,也就是 KineticEnergyGained/EnergyEnergyConsumed) 時,將儲存在燃料中的化學能源轉換為動態能源的效率。使用fuelEnergyDensityInMJoulesPerLiter,將已耗用的燃料轉換成化學能源,以取得化學能源。 必須與 decelerationEfficiency 配對。 允許的值範圍是 0.0 到 1/decelerationEfficiency。 Sensible 值:適用於 熱氣模型 :0.33,適用於 電力模型 :0.66 |
|
alternative
|
query |
控制與參考路由相較之下,計算替代方案的指定規劃準則的最佳性。 |
||
arrive
|
query |
string date-time |
抵達目的地點的日期和時間,格式為 範例:
參數 |
|
auxiliary
|
query |
number double |
指定以千瓦為單位 (kW) 來維持輔助系統的耗電量。 它可以用來指定因為 AC 系統、無線電、熱等裝置和系統等的耗用量。 合理值:1.7 |
|
auxiliary
|
query |
number double |
指定每小時為車輛維持輔助系統所耗用的油量。 它可以用來指定因為 AC 系統、無線電、熱等裝置和系統等的耗用量。 合理值:0.2 |
|
avoid
|
query |
指定路由計算在判斷路由時應該嘗試避免的事項。 可以在一個要求中多次指定,例如『&avoid=ins&avoid=tollRoads&avoid=tollRoads』。 在 [路由範圍] 要求中,不得使用已經使用值UsedRoads。 |
||
compute
|
query |
boolean |
使用快速啟發式演算法來重新排序路線路線點,以減少路由長度。 搭配 routeType 最短使用時,產生最佳結果。 請注意,來源和目的地會從優化的方式點索引中排除。 若要在回應中包含來源和目的地,請將所有索引增加 1 以考慮來源,然後將目的地新增為最終索引。 可能的值有:true 或 false。 如果可能的話,True 會計算更好的順序,但不允許與大於 0 的 maxAlternatives 值搭配使用,或與圓形方向點搭配使用。 False 會使用指定順序中的位置,不允許與 routeRepresentation 搭配使用。 |
|
compute
|
query |
指定是否使用不同類型的交通資訊來傳回額外的交通時間, (無、歷史、即時) ,以及預設的最佳預估旅遊時間。 |
||
constant
|
query |
string |
指定耗用量的速度相依元件。 以未排序的速度/耗用量率組清單的形式提供。 此清單會定義耗用量曲線上的點。 找到不在清單中速度的耗用量率,如下所示:
此清單必須包含介於 1 到 25 點 (內含) ,而且可能不會包含相同速度的重複點。 如果它只包含單一點,則會使用該點的耗用量率,而不需進一步處理。 針對最大速度指定的耗用量必須大於或等於第二個最大速度的耗用量。 這可確保推斷不會造成負耗用量率。 同樣地,針對清單中的兩個最小速度所指定的耗用量值,無法產生任何較小速度的負耗用量率。 以 kWh/100km () 表示的取用值的有效範圍介於 0.01 和 100000.0 之間。 合理值:50,8.2:130,21.3 電力 耗用量模型需要此參數。 |
|
constant
|
query |
string |
指定耗用量的速度相依元件。 提供為未排序的冒號分隔速度清單,& 耗用量率配對。 此清單會定義耗用量曲線上的點。 找到不在清單中速度的耗用量率,如下所示:
此清單必須包含介於 1 到 25 點 (內含) ,而且可能不會包含相同速度的重複點。 如果它只包含單一點,則會使用該點的耗用量率,而不需進一步處理。 針對最大速度指定的耗用量必須大於或等於第二個最大速度的耗用量。 這可確保推斷不會造成負耗用量率。 同樣地,針對清單中的兩個最小速度所指定的耗用量值,無法產生任何較小速度的負耗用量率。 以 l/100km 表示 (取用值的有效範圍) 介於 0.01 和 100000.0 之間。 合理值:50,6.3:130,11.5 注意 :此參數是必要的,才能使用 「標準取用模型」。 |
|
current
|
query |
number double |
指定目前電力供應 (kWh) 。 此參數與 MaxChargeInkWh 參數共存。 允許的值範圍是 0.0 到 maxChargeInkWh。 合理值:43 |
|
current
|
query |
number double |
指定目前燃料的供應量。 合理值:55 |
|
deceleration
|
query |
number double |
指定當車輛減速 (時 (未耗) 用 (儲存 (效率 ,亦即,當車輛減速 (,亦即,將 KineticEnergySaved/KineticEnergyLost) 。使用fuelEnergyDensityInMJoulesPerLiter,將儲存的 (未耗用的) 燃料轉換為能源,以取得化學能源。 必須與 accelerationEfficiency 配對。 允許的值範圍是 0.0 到 1/accelerationEfficiency。 Sensible 值:針對 [電力模型 ]:0.83、適用於 電力模型 :0.91 |
|
depart
|
query |
string date-time |
從原點開始的日期和時間,格式為
範例:
參數 |
|
downhill
|
query |
number double |
指定當車輛失去提高許可權 (時,將潛在能源轉換為節省 (未耗用) 油的效率, 亦即,在) 中,將可能能源轉換成節省的 (。使用fuelEnergyDensityInMJoulesPerLiter,將儲存的 (未耗用的) 燃料轉換為能源,以取得化學能源。 必須與 uphillEfficiency 配對。 允許的值範圍是 0.0 到 1/upiciEfficiency。 Sensible 值:適用於 熱氣模型 :0.51,適用於 電力模型 :0.73 |
|
fuel
|
query |
number double |
指定在 MBjoules (MJ) 中儲存在一次燃料中的化學能源量。 它與 *效率 參數搭配使用,以在已儲存或耗用的能源和燃料之間進行轉換。 例如,能源密度是 34.2 MJ/l,而 35.8 MJ/l 則用於油箱。 如果已設定任何 *Efficiency 參數,則需要此參數。 合理值:34.2 |
|
hilliness
|
query |
令人興奮路線的峰度。 此參數只能與 |
||
instructions
|
query |
如果指定,將會傳回指引指示。 請注意,instructionsType 參數不能與 routeRepresentation=none 搭配使用 |
||
language
|
query |
string |
語言參數會決定指引訊息的語言。 適當的名詞 (以指定的語言傳回街道、街道等 ) 的名稱,或者如果無法使用,則會以接近該名稱的可用語言傳回。 允許的值 (IETF 語言標籤) 子集。 目前支援的語言列在 [ 支持的語言] 區段中。 默認值:en-GB |
|
max
|
query |
integer |
要計算的所需替代路由數目。 默認值:0、最小值:0 和最大值:5 |
|
max
|
query |
number double |
指定可能儲存在車輛電池中 (kWh) 的電力供應量上限。 此參數與 currentChargeInkWh 參數共存。 最小值必須大於或等於 currentChargeInkWh。 合理值:85 |
|
min
|
query |
integer |
傳回的所有替代路由都會遵循參考路由, (請參閱從 calculateRoute 要求的來源點) 一節,至少要有此數目的計量。 只能在重新建構路由時使用。 minDeviationDistance 參數不能與 arriveAt 搭配使用 |
|
min
|
query |
integer |
傳回的所有替代路由都會遵循參考路由, (請參閱從 calculateRoute 要求的原始點) POST 要求一節,至少要有此秒數。 只能在重新建構路由時使用。 minDeviationTime 參數不能與 arriveAt 搭配使用。 預設值為 0。 將 ) minDeviationTime_ 設定為大於零的值會產生下列結果:
|
|
report
|
query |
指定應報告哪些數據以供診斷之用。 唯一可能的值為 effectiveSettings。 報告呼叫 API 時所使用的有效參數或數據。 在預設參數的情況下,預設會反映呼叫端未指定參數的位置。 |
||
route
|
query |
指定提供做為回應之路由集的表示法。 此參數值只能與 computeBestOrder=true 搭配使用。 |
||
route
|
query |
要求的路由類型。 |
||
section
|
query |
指定路由回應中報告哪些區段類型。 |
||
traffic
|
query |
boolean |
可能的值:
|
|
travel
|
query |
所要求路由的移動模式。 如果未定義,預設值為 『car』。 請注意,要求的 travelMode 可能無法用於整個路線。 當要求之 travelMode 不適用於特定區段時,該區段回應的 travelMode 元素將會是 “other”。 請注意,旅遊模式總線、車車、計程車和貨車都是 BETA 功能。 所有區域都無法使用完整限制數據。 |
||
uphill
|
query |
number double |
指定當車輛提升提高 (時,將儲存在燃料中的化學能源轉換為潛在能源的效率 ,也就是 PotentialEnergyGained/GeographyEnergyConsumed) 。使用fuelEnergyDensityInMJoulesPerLiter,將已耗用的燃料轉換成化學能源,以取得化學能源。 必須與 downhillEfficiency 配對。 允許的值範圍是 0.0 到 1/downiciEfficiency。 Sensible 值:適用於 熱力模型 :0.27,適用於 電力模型 :0.74 |
|
vehicle
|
query |
integer |
每一車輛的重量,以磅為單位。 值為 0 表示不會考慮每個擷取的加權限制。 |
|
vehicle
|
query |
boolean |
車輛是否用於商業用途。 商業車輛可能無法在某些道路上駕駛。 |
|
vehicle
|
query |
車輛的引擎類型。 指定詳細的取用模型時,它必須與 vehicleEngineType 的值一致。 |
||
vehicle
|
query |
integer |
從 true North 開始的車輛方向標題,並以順時針方向繼續。 北是0度,東部是90度,南是180度,西部是270度。 可能的值 0-359 |
|
vehicle
|
query |
number double |
以公尺為單位的車輛高度。 值為 0 表示不會考慮高度限制。 |
|
vehicle
|
query |
number double |
以公尺為單位的車輛長度。 值為 0 表示不會考慮長度限制。 |
|
vehicle
|
query |
可能分類為危險材料且受限於某些道路的貨物類型。 可用的 vehicleLoadType 值是美國 Hazmat 類別 1 到 9,加上用於其他國家/地區的泛型分類。 從 USHazmat 開始的值適用於美國路由,而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以多次指定。 此參數目前只考慮用於 travelMode=truck。 |
||
vehicle
|
query |
integer |
以 km/小時為單位的車輛最大速度。 車輛配置檔中的最大速度是用來檢查車輛是否允許在汽車上。
|
|
vehicle
|
query |
integer |
車輛重量,以壓克為單位。
Sensible 值:適用於 熱氣模型 :1600,適用於 電力模型 :1900 |
|
vehicle
|
query |
number double |
以公尺為單位的車輛寬度。 值為 0 表示不會考慮寬度限制。 |
|
windingness
|
query |
令人興奮路線的回合層級。 此參數只能與 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-id |
string |
指定哪一個帳戶用於搭配 Microsoft Entra ID 安全性模型使用。 它代表 Azure 地圖服務 帳戶的唯一標識符,可以從 Azure 地圖服務 管理平面帳戶 API 擷取。 若要在 Azure 地圖服務 中使用 Microsoft Entra ID 安全性,請參閱下列文章以取得指引。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 |
|
Other Status Codes |
發生意外錯誤。 |
安全性
AADToken
這些是 Microsoft Entra OAuth 2.0 流程。 與 Azure 角色型存取控制配對時,可用來控制對 REST API 的存取 Azure 地圖服務。 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 的使用方式允許針對多個使用案例設定應用程式的組態型設定。
- 如需 Microsoft 身分識別平台 的詳細資訊,請參閱 Microsoft 身分識別平台 概觀。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名稱 | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
這是當您在 Azure 入口網站 或使用PowerShell、CLI、Azure SDK 或 REST API 中 Create Azure 地圖服務 帳戶時所佈建的共用密鑰。
使用此金鑰時,任何應用程式都可以存取所有 REST API。 換句話說,此金鑰可作為發行帳戶中的主要金鑰。
對於公開的應用程式,我們建議使用機密用戶端應用程式方法來存取 Azure 地圖服務 REST API,以便安全地儲存您的密鑰。
Type:
apiKey
In:
query
SAS Token
這是透過 Azure 管理平面透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 地圖服務 資源上的列出 SAS 作業建立共用存取簽章令牌。
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並精細控制到期、速率和區域 (特定令牌的使用) 。 換句話說,SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。
對於公開的應用程式,我們建議在 地圖帳戶資源 上設定允許的來源特定清單,以限制轉譯濫用,並定期更新 SAS 令牌。
Type:
apiKey
In:
header
範例
Successfully retrieve a route between an origin and a destination
Sample Request
GET https://atlas.microsoft.com/route/directions/json?api-version=1.0&query=52.50931,13.42936:52.50274,13.43872&report=effectiveSettings
Sample Response
{
"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 |
---|---|
Alternative |
相較於參考路由,控制計算替代專案的指定規劃準則的最佳性。 |
Compute |
指定是否使用不同類型的交通資訊傳回額外的行進時間, (無、歷史、即時) ,以及預設的最佳估計行進時間。 |
Delay |
事件所造成的延遲程度。 這些值會對應至 取得流量事件詳細數據 API 之回應欄位 ty 的值。 |
Driving |
表示左手與右手在操作點的駕駛。 |
Effective |
呼叫此路由 API 時所使用的有效參數或數據。 |
Error |
資源管理錯誤其他資訊。 |
Error |
錯誤詳細數據。 |
Error |
錯誤回應 |
Guidance |
指示的類型,例如道路窗體的回合或變更。 |
Guidance |
識別動作的程序代碼。 |
Incline |
令人驚豔的路線程度。 此參數只能與 =ining 搭配 |
Junction |
執行動作的連接點類型。 針對較大的圓角,會產生兩個不同的指令來輸入和離開迴圈。 |
Lat |
以緯度和經度表示的位置。 |
Report |
指定應報告哪些數據以供診斷之用。 唯一可能的值為 effectiveSettings。 報告呼叫 API 時所使用的有效參數或數據。 在預設參數的情況下,預設會反映呼叫端未指定參數的位置。 |
Response |
所需的回應格式。 值可以是 json 或 xml。 |
Response |
報告路由回應的區段類型 |
Response |
匯出路線的旅遊模式。 如果本節中無法取得要求的傳輸模式,此值將會設定 |
Route | |
Route |
指定在判斷路由時,路由計算應該嘗試避免的事項。 可以在一個要求中多次指定,例如『&avoid=&avoid=tollRoads&avoid=feries』。 在路由範圍要求中,不得使用已經使用值UsedRoads。 |
Route |
此物件會從成功的路線指示呼叫傳回 |
Route |
包含指引相關元素。 只有在要求指導方針且可供使用時,才會顯示此欄位。 |
Route |
一組描述動作的屬性,例如『Turn right』、『Keep left』、『Take the ferry』、『Take the ferry』、『Arrive』。 |
Route |
群組 彼此相關的指令元素序列。 序列範圍受限於 firstInstructionIndex 和 lastInstructionIndex。 當要求人類可讀取的文字訊息提供指引 (instructionType=text 或標記) 時,則 instructionGroup 會在可用時傳回摘要訊息。 |
Route |
如果指定,則會傳回指引指示。 請注意,instructionsType 參數不能與 routeRepresentation=none 搭配使用 |
Route |
一部分路線的描述,由點列表組成。 要求中提供的每個額外方法點,都會在傳回的路由中產生額外的步子。 |
Route |
路由區段的摘要物件。 |
Route |
優化的方式點物件。 |
Route |
報告目前呼叫中使用的有效設定。 |
Route |
指定提供做為回應之路由集的表示。 此參數值只能與 computeBestOrder=true 搭配使用。 |
Route |
路由區段包含有關路由部分的其他資訊。 每個區段至少包含、 |
Route |
流量事件的詳細數據,使用 TPEG2-TEC 標準中的定義。 可以包含 effectCode 並造成專案。 |
Route |
流量事件的原因。 可以包含mainCauseCode和subCauseCode元素。 可用來定義圖示和描述。 |
Route |
Summary 物件 |
Route |
要求的路由類型。 |
Section |
指定路由回應中報告哪些區段類型。 |
Simple |
事件的類型。 目前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 如需詳細資訊,請參閱 「tec」。 |
Travel |
所要求路線的行進模式。 如果未定義,預設值為 『car』。 請注意,要求的 travelMode 可能無法用於整個路線。 如果要求之 travelMode 不適用於特定區段,該區段之回應的 travelMode 元素將會是 “other”。 請注意,旅遊模式總線、車車、計程車和貨車都是 BETA 功能。 所有區域都無法使用完整限制數據。 |
Vehicle |
車輛的引擎類型。 指定詳細的取用模型時,它必須與 vehicleEngineType 的值一致。 |
Vehicle |
可能分類為危險材料且受限於某些道路的貨物類型。 可用的 vehicleLoadType 值是 US Hazmat 類別 1 到 9,加上用於其他國家/地區的一般分類。 從 USHazmat 開始的值適用於美國路由,而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 可以多次指定。 此參數目前只考慮 travelMode=truck。 |
Windingness |
令人興奮路線的回合層級。 此參數只能與 =ining 搭配 |
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 |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
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。 它位於左側。 |
WAYPOINT_REACHED |
string |
您已到達 waypoint。 |
WAYPOINT_RIGHT |
string |
您已到達 waypoint。 其位於右側。 |
InclineLevel
令人驚豔的路線程度。 此參數只能與 =ining 搭配 routeType
使用。
名稱 | 類型 | Description |
---|---|---|
high |
string |
high |
low |
string |
low |
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 |
|
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 |
與要求參數 |
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 |
傳回的路由已針對 Vans 進行優化。 BETA 功能。 |
Route
名稱 | 類型 | Description |
---|---|---|
guidance |
包含指引相關元素。 只有在要求指導方針且可供使用時,才會顯示此欄位。 |
|
legs |
Route |
Legs 陣列 |
sections |
區段陣列 |
|
summary |
Summary 物件 |
RouteAvoidType
指定在判斷路由時,路由計算應該嘗試避免的事項。 可以在一個要求中多次指定,例如『&avoid=&avoid=tollRoads&avoid=feries』。 在路由範圍要求中,不得使用已經使用值UsedRoads。
名稱 | 類型 | Description |
---|---|---|
alreadyUsedRoads |
string |
避免多次使用相同的道路。 最適合與 =refreshing 搭配 |
borderCrossings |
string |
避免在路線計算中跨越框線。 |
carpools |
string |
避免需要使用汽車緩衝 (HOV/高佔用車輛) 通道的路線。 |
ferries |
string |
避免水器 |
motorways |
string |
避免擷取 |
tollRoads |
string |
避免收費道路。 |
unpavedRoads |
string |
避免未修補道路 |
RouteDirections
此物件會從成功的路線指示呼叫傳回
名稱 | 類型 | Description |
---|---|---|
formatVersion |
string |
Format Version 屬性 |
optimizedWaypoints |
優化的方式點序列。 它會顯示使用者提供原始和優化清單之 Waypoint 序列的索引。 例如,回應:
表示原始序列為 [0, 1, 2] 且優化序列為 [1, 2, 0]。 由於索引從 0 開始,原始為 “first, second, third”,而優化為 “second, third, first”。 |
|
report |
報告目前呼叫中使用的有效設定。 |
|
routes |
Route[] |
路由陣列 |
RouteGuidance
包含指引相關元素。 只有在要求指導方針且可供使用時,才會顯示此欄位。
名稱 | 類型 | Description |
---|---|---|
instructionGroups |
群組 彼此相關的指令元素序列。 |
|
instructions |
描述操作的指示清單。 |
RouteInstruction
一組描述動作的屬性,例如『Turn right』、『Keep left』、『Take the ferry』、『Take the ferry』、『Arrive』。
名稱 | 類型 | Description |
---|---|---|
combinedMessage |
string |
動作的人類可讀取訊息,結合下一個指示中的訊息。 有時候,可以將兩個連續的指令結合成單一指令,讓您更容易遵循。 如果是這種情況,possibleCombineWithNext 旗標會是 true。 例如:
指示 10 上的 possibleCombineWithNext 旗標為 true。 這表示可結合指示 11 的自動程式代碼指引用戶端。 系統會針對要求人類可讀取指引的用戶端自動合併指示。 combinedMessage 字段包含合併的訊息:
|
countryCode |
string |
3 個字元 ISO 3166-1 alpha-3 國家/地區代碼。 例如美國 |
drivingSide |
表示左手與右手在操作點的駕駛。 |
|
exitNumber |
string |
目前動作所採用之高速路結束 () 數目。 如果結束有多個結束編號,則會以 “,”分隔,而且可能以 “-” 匯總,例如 “10, 13-15”。 |
instructionType |
指示的類型,例如道路窗體的回合或變更。 |
|
junctionType |
執行動作的連接點類型。 針對較大的圓角,會產生兩個不同的指令來輸入和離開迴圈。 |
|
maneuver |
識別動作的程序代碼。 |
|
message |
string |
人類看得懂的訊息。 |
point |
以緯度和經度表示的位置。 |
|
pointIndex |
integer |
對應至指令點之多邊形 「points」 清單中的點索引。 |
possibleCombineWithNext |
boolean |
您可以選擇性地將指令與下一個指令結合。 這可以用來建置訊息,例如「左轉,然後向右轉」。 |
roadNumbers |
string[] |
下一個重要道路區段) ( () ,或要追蹤 () 道路的路號。 範例:[“E34”, “N205”] |
roundaboutExitNumber |
string |
這表示要進入循環的結束。 |
routeOffsetInMeters |
integer |
從路線起點到指令點的距離。 |
signpostText |
string |
符號上的文字,與操作最相關,或與應遵循的方向有關。 |
stateCode |
string |
子 (,例如國家/地區) ,以 ISO 3166-2 程式代碼的第二個部分表示。 這僅適用於某些國家/地區,例如美國、加拿大和墨西哥。 |
street |
string |
下一個重要道路區段在動作之後的街道名稱,或應該追蹤的街道名稱。 |
travelTimeInSeconds |
integer |
估計的移動時間,最多到對應至 routeOffsetInMeters 的點。 |
turnAngleInDecimalDegrees |
integer |
指出指示的方向。 如果 junctionType 指出回合指示:
如果 junctionType 指出 bifurcation 指示:
|
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。 標記為 「左轉」訊息的範例:
|
text |
string |
以純文本傳回具有人類可讀取訊息的原始指示數據。 |
RouteLeg
一部分路線的描述,由點列表組成。 要求中提供的每個額外方法點,都會在傳回的路由中產生額外的步子。
名稱 | 類型 | Description |
---|---|---|
points |
點陣列 |
|
summary |
路由區段的摘要物件。 |
RouteLegSummary
路由區段的摘要物件。
名稱 | 類型 | Description |
---|---|---|
arrivalTime |
string |
路線或回合的預估抵達時間。 時間以UTC為單位。 |
batteryConsumptionInkWh |
number |
使用電力耗用量模型,以千瓦時 (kWh) 估計電力耗用量。 如果 vehicleEngineType 設定為電力,且常數SpeedConsumptionInkWhPerHundredkm 已指定,則包含此專案。 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。 若要使用不同類型的流量資訊傳回其他行進時間,必須新增參數 computeTravelTimeFor=all。 |
travelTimeInSeconds |
integer |
估計的行進時間以秒為單位屬性,其中包含因為即時流量而造成的延遲。 請注意,即使 traffic=false travelTimeInSeconds 仍然包含流量所造成的延遲。 如果 Future 的 TravelAt 是未來,則會使用時間相依的歷史流量數據來計算旅遊時間。 |
RouteOptimizedWaypoint
優化的方式點物件。
名稱 | 類型 | Description |
---|---|---|
optimizedIndex |
integer |
從系統優化的方式點索引。 |
providedIndex |
integer |
使用者提供的方式點索引。 |
RouteReport
報告目前呼叫中使用的有效設定。
名稱 | 類型 | Description |
---|---|---|
effectiveSettings |
呼叫此路由 API 時所使用的有效參數或數據。 |
RouteRepresentationForBestOrder
指定提供做為回應之路由集的表示。 此參數值只能與 computeBestOrder=true 搭配使用。
名稱 | 類型 | Description |
---|---|---|
none |
string |
只包含優化的 Waypoint 索引,但不包含回應中的路由幾何。 |
polyline |
string |
在回應中包含路由幾何。 |
summaryOnly |
string |
每個聚合線的摘要,但不包括回應中路由的點幾何元素。 |
RouteSection
路由區段包含有關路由部分的其他資訊。 每個區段至少包含、 endPointIndex
和sectionType
專案startPointIndex
。
名稱 | 類型 | Description |
---|---|---|
delayInSeconds |
integer |
事件所造成秒的延遲。 |
effectiveSpeedInKmh |
integer |
以 km/h 為單位的事件有效速度,平均超過整個長度。 |
endPointIndex |
integer |
本節所套用的路由中最後一個點 (位移 0) 的索引。 |
magnitudeOfDelay |
事件所造成的延遲程度。 這些值會對應至 取得流量事件詳細數據 API 之回應欄位 ty 的值。 |
|
sectionType |
報告路由回應的區段類型 |
|
simpleCategory |
事件的類型。 目前可以是 JAM、ROAD_WORK、ROAD_CLOSURE 或其他。 如需詳細資訊,請參閱 「tec」。 |
|
startPointIndex |
integer |
本節所套用的第一個點索引 (位移 0) 。 |
tec |
流量事件的詳細數據,使用 TPEG2-TEC 標準中的定義。 可以包含 effectCode 並造成專案。 |
|
travelMode |
匯出路線的旅遊模式。 如果本節中無法取得要求的傳輸模式,此值將會設定 |
RouteSectionTec
流量事件的詳細數據,使用 TPEG2-TEC 標準中的定義。 可以包含 effectCode 並造成專案。
名稱 | 類型 | Description |
---|---|---|
causes |
造成陣列 |
|
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。 若要使用不同類型的流量資訊傳回其他行進時間,必須新增參數 computeTravelTimeFor=all。 |
travelTimeInSeconds |
integer |
估計的行進時間以秒為單位屬性,其中包含因為即時流量而造成的延遲。 請注意,即使 traffic=false travelTimeInSeconds 仍然包含流量所造成的延遲。 如果 Future 的 TravelAt 是未來,則會使用時間相依的歷史流量數據來計算旅遊時間。 |
RouteType
要求的路由類型。
名稱 | 類型 | Description |
---|---|---|
eco |
string |
以經濟和速度平衡的路線。 |
fastest |
string |
最快速的路線。 |
shortest |
string |
依距離的最短路線。 |
thrilling |
string |
包含有趣或具挑戰性的道路,並盡可能使用最少的道路。 您可以選擇包含的回合層級,也可以選擇拒絕程度。 如需如何設定此動作,請參閱坡度和線圈參數。 規劃的 |
SectionType
指定路由回應中報告哪些區段類型。
例如,如果 sectionType = 允許只傳回適合耙耙的區段。 可以使用多個類型。 默認 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 |
與要求參數 |
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 |
傳回的路由已針對 Vans 優化。 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
令人興奮路線的回合層級。 此參數只能與 =ining 搭配 routeType
使用。
名稱 | 類型 | Description |
---|---|---|
high |
string |
high |
low |
string |
low |
normal |
string |
正常 |