共用方式為


Route - Get Route Range

使用 建立地圖,根據時間、距離或燃料容量,描述在特定臨界值內從指定點存取的區域。

Get Route Range (Isochrone) API 是 HTTP GET 要求,會根據指定的燃料、能源、時間或距離預算,計算一組可從源點到達的位置。 多邊形界限 (或 Isochrone) 會以反時針方向傳回,以及原點結果的精確多邊形中心。

傳回的多邊形可用於進一步處理,例如 搜尋內部幾何 ,以搜尋所提供等時序內的POI。

GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}
GET https://atlas.microsoft.com/route/range/{format}?api-version=1.0&query={query}&fuelBudgetInLiters={fuelBudgetInLiters}&energyBudgetInkWh={energyBudgetInkWh}&timeBudgetInSec={timeBudgetInSec}&distanceBudgetInMeters={distanceBudgetInMeters}&departAt={departAt}&routeType={routeType}&traffic={traffic}&avoid={avoid}&travelMode={travelMode}&hilliness={hilliness}&windingness={windingness}&vehicleAxleWeight={vehicleAxleWeight}&vehicleWidth={vehicleWidth}&vehicleHeight={vehicleHeight}&vehicleLength={vehicleLength}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&vehicleCommercial={vehicleCommercial}&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

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

api-version
query True

string

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

query
query True

number[]

範圍計算應該從其中開始的座標。

accelerationEfficiency
query

number

double

指定當車輛加速 (,也就是 KineticEnergyGained/EnergyEnergyConsumed) 時,將儲存在燃料中的化學能源轉換為動態能源的效率。使用fuelEnergyDensityInMJoulesPerLiter,將已耗用的燃料轉換成化學能源,以取得化學能源。

必須與 decelerationEfficiency 配對。

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

Sensible 值:適用於 熱氣模型 :0.33,適用於 電力模型 :0.66

auxiliaryPowerInkW
query

number

double

指定以千瓦為單位 (kW) 來維持輔助系統的耗電量。

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

合理值:1.7

auxiliaryPowerInLitersPerHour
query

number

double

指定每小時為車輛維持輔助系統所耗用的油量。

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

合理值:0.2

avoid
query

RouteAvoidType[]

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

constantSpeedConsumptionInkWhPerHundredkm
query

string

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

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

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

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

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

針對最大速度指定的耗用量必須大於或等於第二個最大速度的耗用量。 這可確保推斷不會造成負耗用量率。

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

以 kWh/100km () 表示的取用值的有效範圍介於 0.01 和 100000.0 之間。

合理值:50,8.2:130,21.3

電力 耗用量模型需要此參數。

constantSpeedConsumptionInLitersPerHundredkm
query

string

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

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

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

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

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

針對最大速度指定的耗用量必須大於或等於第二個最大速度的耗用量。 這可確保推斷不會造成負耗用量率。

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

以 l/100km 表示 (取用值的有效範圍) 介於 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

指定當車輛減速 (時 (未耗) 用 (儲存 (效率 ,亦即,當車輛減速 (,亦即,將 KineticEnergySaved/KineticEnergyLost) 。使用fuelEnergyDensityInMJoulesPerLiter,將儲存的 (未耗用的) 燃料轉換為能源,以取得化學能源。

必須與 accelerationEfficiency 配對。

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

Sensible 值:針對 [電力模型 ]:0.83、適用於 電力模型 :0.91

departAt
query

string

date-time

從原點開始的日期和時間,格式為 dateTimeRFC 3339 第 5339 節中定義的值,並具有選擇性時區位移。 未指定時區位移時,會假設為原點的位移。

  • 默認值:現在
  • 其他值: dateTime

範例:

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

參數 departAt 不能與 arriveAt一起使用。

distanceBudgetInMeters
query

number

double

以公尺為單位的距離預算,可決定可使用駕駛距離進行的最大範圍。 取用模型只會影響 routeType 為 eco 時的範圍。
必須只使用一個預算 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters) 。

downhillEfficiency
query

number

double

指定當車輛失去提高許可權 (時,將潛在能源轉換為節省 (未耗用) 油的效率, 亦即,在) 中,將可能能源轉換成節省的 (。使用fuelEnergyDensityInMJoulesPerLiter,將儲存的 (未耗用的) 燃料轉換為能源,以取得化學能源。

必須與 uphillEfficiency 配對。

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

Sensible 值:適用於 熱氣模型 :0.51,適用於 電力模型 :0.73

energyBudgetInkWh
query

number

double

以千瓦時為單位的電力預算 (kWh) ,可決定可使用指定的電力耗用量模型來擷取的最大範圍。
使用 energyBudgetInkWh 時,必須指定詳細的電力耗用量模型。
必須只使用一個預算 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters) 。

fuelBudgetInLiters
query

number

double

燃料預算,決定可使用指定之耗用量模型進行的最大範圍。
使用 fuelBudgetInLiters 時,必須指定詳細的油箱耗用量模型。
必須只使用一個預算 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters) 。

fuelEnergyDensityInMJoulesPerLiter
query

number

double

指定在 MBjoules (MJ) 中儲存在一次燃料中的化學能源量。 它與 *效率 參數搭配使用,以在已儲存或耗用的能源和燃料之間進行轉換。 例如,能源密度是 34.2 MJ/l,而 35.8 MJ/l 則用於油箱。

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

合理值:34.2

hilliness
query

InclineLevel

令人興奮路線的峰度。 此參數只能與 routeType=refreshing 搭配使用。

maxChargeInkWh
query

number

double

指定可能儲存在車輛電池中 (kWh) 的電力供應量上限。

此參數與 currentChargeInkWh 參數共存。

最小值必須大於或等於 currentChargeInkWh

合理值:85

routeType
query

RouteType

要求的路由類型。

timeBudgetInSec
query

number

double

以秒為單位的時間預算,決定可使用駕駛時間進行的最大範圍。 取用模型只會影響 routeType 為 eco 時的範圍。
必須只使用一個預算 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec 或 distanceBudgetInMeters) 。

traffic
query

boolean

可能的值:

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

TravelMode

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

uphillEfficiency
query

number

double

指定當車輛提升提高 (時,將儲存在燃料中的化學能源轉換為潛在能源的效率 ,也就是 PotentialEnergyGained/GeographyEnergyConsumed) 。使用fuelEnergyDensityInMJoulesPerLiter,將已耗用的燃料轉換成化學能源,以取得化學能源。

必須與 downhillEfficiency 配對。

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

Sensible 值:適用於 熱力模型 :0.27,適用於 電力模型 :0.74

vehicleAxleWeight
query

integer

每一車輛的重量,以磅為單位。 值為 0 表示不會考慮每個擷取的加權限制。

vehicleCommercial
query

boolean

車輛是否用於商業用途。 商業車輛可能無法在某些道路上駕駛。

vehicleEngineType
query

VehicleEngineType

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

vehicleHeight
query

number

double

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

vehicleLength
query

number

double

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

vehicleLoadType
query

VehicleLoadType

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

vehicleMaxSpeed
query

integer

以 km/小時為單位的車輛最大速度。 車輛配置檔中的最大速度是用來檢查車輛是否允許在汽車上。

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

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

vehicleWeight
query

integer

車輛重量,以壓克為單位。

  • 如果已設定任何 *效率參數,則為必要。

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

  • 如果未指定詳細的 取用模型且vehicleWeight 的值不是零,則會考慮重量限制。

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

Sensible 值:適用於 熱氣模型 :1600,適用於 電力模型 :1900

vehicleWidth
query

number

double

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

windingness
query

WindingnessLevel

令人興奮路線的回合層級。 此參數只能與 routeType=refreshing 搭配使用。

要求標頭

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

string

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

回應

名稱 類型 Description
200 OK

RouteRangeResult

確定

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 入口網站中 建立 Azure 地圖服務帳戶 或使用 PowerShell、CLI、Azure SDK 或 REST API 時所佈建的共用密鑰。

使用此金鑰時,任何應用程式都可以存取所有 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 set of locations that can be reached from the origin point based on various conditions

範例要求

GET https://atlas.microsoft.com/route/range/json?api-version=1.0&query=50.97452,5.86605&timeBudgetInSec=6000

範例回覆

{
  "formatVersion": "0.0.1",
  "reachableRange": {
    "center": {
      "latitude": 50.9745,
      "longitude": 5.86605
    },
    "boundary": [
      {
        "latitude": 52.03704,
        "longitude": 5.73602
      },
      {
        "latitude": 52.09456,
        "longitude": 5.59435
      },
      {
        "latitude": 52.16815,
        "longitude": 5.42279
      },
      {
        "latitude": 52.25047,
        "longitude": 5.21276
      },
      {
        "latitude": 52.21374,
        "longitude": 5.15355
      },
      {
        "latitude": 52.25674,
        "longitude": 4.96687
      },
      {
        "latitude": 52.07834,
        "longitude": 4.739
      },
      {
        "latitude": 52.05647,
        "longitude": 4.72513
      },
      {
        "latitude": 51.94553,
        "longitude": 4.53237
      },
      {
        "latitude": 51.70119,
        "longitude": 4.31165
      },
      {
        "latitude": 51.5837,
        "longitude": 4.28917
      },
      {
        "latitude": 51.48463,
        "longitude": 3.82685
      },
      {
        "latitude": 51.21096,
        "longitude": 3.62838
      },
      {
        "latitude": 50.6814,
        "longitude": 3.89244
      },
      {
        "latitude": 50.66791,
        "longitude": 3.93493
      },
      {
        "latitude": 50.49042,
        "longitude": 3.98156
      },
      {
        "latitude": 50.30944,
        "longitude": 4.47995
      },
      {
        "latitude": 50.24448,
        "longitude": 4.60502
      },
      {
        "latitude": 50.24467,
        "longitude": 4.89999
      },
      {
        "latitude": 50.08735,
        "longitude": 5.04206
      },
      {
        "latitude": 49.99214,
        "longitude": 5.23042
      },
      {
        "latitude": 49.88478,
        "longitude": 5.40994
      },
      {
        "latitude": 49.85797,
        "longitude": 5.46178
      },
      {
        "latitude": 49.86279,
        "longitude": 5.7196
      },
      {
        "latitude": 49.83259,
        "longitude": 5.74151
      },
      {
        "latitude": 50.22239,
        "longitude": 5.9387
      },
      {
        "latitude": 50.0011,
        "longitude": 6.08535
      },
      {
        "latitude": 50.04616,
        "longitude": 6.12089
      },
      {
        "latitude": 50.09472,
        "longitude": 6.28373
      },
      {
        "latitude": 49.95863,
        "longitude": 6.51654
      },
      {
        "latitude": 50.00485,
        "longitude": 6.61034
      },
      {
        "latitude": 50.00587,
        "longitude": 6.70295
      },
      {
        "latitude": 50.2947,
        "longitude": 6.65865
      },
      {
        "latitude": 50.36903,
        "longitude": 6.79276
      },
      {
        "latitude": 50.31614,
        "longitude": 7.32163
      },
      {
        "latitude": 50.36737,
        "longitude": 7.58782
      },
      {
        "latitude": 50.46919,
        "longitude": 7.7626
      },
      {
        "latitude": 50.96246,
        "longitude": 7.9826
      },
      {
        "latitude": 51.07086,
        "longitude": 7.55924
      },
      {
        "latitude": 51.36614,
        "longitude": 7.58138
      },
      {
        "latitude": 51.52015,
        "longitude": 7.67861
      },
      {
        "latitude": 51.65781,
        "longitude": 7.35175
      },
      {
        "latitude": 51.81916,
        "longitude": 7.21664
      },
      {
        "latitude": 51.9587,
        "longitude": 7.0467
      },
      {
        "latitude": 51.82713,
        "longitude": 6.67267
      },
      {
        "latitude": 51.81133,
        "longitude": 6.48424
      },
      {
        "latitude": 51.9368,
        "longitude": 6.27316
      },
      {
        "latitude": 52.01701,
        "longitude": 6.14452
      },
      {
        "latitude": 52.20847,
        "longitude": 6.09312
      },
      {
        "latitude": 52.23705,
        "longitude": 6.01297
      }
    ]
  }
}

定義

名稱 Description
EffectiveSetting

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

ErrorAdditionalInfo

資源管理錯誤其他資訊。

ErrorDetail

錯誤詳細數據。

ErrorResponse

錯誤回應

InclineLevel

令人興奮路線的峰度。 此參數只能與 routeType=refreshing 搭配使用。

LatLongPair

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

ResponseFormat

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

RouteAvoidType

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

RouteRange

可連線的範圍

RouteRangeResult

此物件會從成功的 Route Reachable Range 呼叫傳回

RouteReport

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

RouteType

要求的路由類型。

TravelMode

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

VehicleEngineType

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

VehicleLoadType

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

WindingnessLevel

令人興奮路線的回合層級。 此參數只能與 routeType=refreshing 搭配使用。

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 物件。

InclineLevel

令人興奮路線的峰度。 此參數只能與 routeType=refreshing 搭配使用。

名稱 類型 Description
high

string

high

low

string

low

normal

string

正常

LatLongPair

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

名稱 類型 Description
latitude

number

Latitude 屬性

longitude

number

經度屬性

ResponseFormat

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

名稱 類型 Description
json

string

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

xml

string

可延伸標記語言

RouteAvoidType

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

名稱 類型 Description
alreadyUsedRoads

string

避免多次使用相同的道路。 與 =refreshing 搭配 routeType使用最實用。

borderCrossings

string

避免在路由計算中跨越框線。

carpools

string

避免需要使用汽車緩衝處理 (HOV/高佔用車輛) 通道的路線。

ferries

string

避免鐵道

motorways

string

避免發生問題

tollRoads

string

避免收費道路。

unpavedRoads

string

避免未修補道路

RouteRange

可連線的範圍

名稱 類型 Description
boundary

LatLongPair[]

可觸達範圍的多邊形界限,以點清單表示。

center

LatLongPair

可觸達範圍的中心點

RouteRangeResult

此物件會從成功的 Route Reachable Range 呼叫傳回

名稱 類型 Description
formatVersion

string

Format Version 屬性

reachableRange

RouteRange

可連線的範圍

report

RouteReport

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

RouteReport

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

名稱 類型 Description
effectiveSettings

EffectiveSetting[]

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

RouteType

要求的路由類型。

名稱 類型 Description
eco

string

以經濟和速度平衡的路線。

fastest

string

最快速的路由。

shortest

string

依距離的最短路線。

thrilling

string

包含有趣的或具挑戰性道路,並盡可能使用最少的道路。 您可以選擇包含的回合層級,也可以選擇坡度。 如需如何設定,請參閱水位和彎曲參數。 規劃 routeType的路線限制為900公里,但有 =擷取

TravelMode

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

名稱 類型 Description
bus

string

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

car

string

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

motorcycle

string

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

taxi

string

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

truck

string

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

van

string

傳回的路由已針對 Vans 進行優化。 BETA 功能。

VehicleEngineType

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

名稱 類型 Description
combustion

string

內部性能引擎。

electric

string

電力引擎。

VehicleLoadType

可能分類為危險材料且受限於某些道路的貨物類型。 可用的 vehicleLoadType 值是美國 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=refreshing 搭配使用。

名稱 類型 Description
high

string

high

low

string

low

normal

string

正常