Route - Get Route Range

リファレンス

サービス:: Maps

API バージョン:: 1.0

時間、距離、または燃料容量に基づいて、特定のしきい値内の特定のポイントからアクセスできる領域を表すマップを作成するために使用します。

注

Azure Maps Route v1 サービス提供終了の

Azure Maps Route v1 サービスは非推奨となり、3/31/28 に廃止されます。サービスの中断を回避するには、Route v1 サービスのすべての呼び出しを更新して、3/31/28 までに Route v2025-01-01 サービスを使用する必要があります。詳細については、「Azure Maps Route 1.0 APIの移行」を参照してください。

Get Route Range (Isochrone) API は HTTP GET 要求であり、指定された燃料、エネルギー、時間、距離の予算に基づいて起点から到達できる場所のセットを計算します。ポリゴン境界 (等時線) は、原点の結果である正確な多角形の中心と同様に、反時計回りの方向で返されます。

返されたポリゴンは、ジオメトリ内の検索などの処理を行い、指定された等時線内の 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 パラメーター

名前	/	必須	型	説明
format	path	True	ResponseFormat	応答の目的の形式。値は、json することも、xml することもできます。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	number[]	範囲の計算を開始する座標。
accelerationEfficiency	query		number (double) minimum: 0 maximum: 1	車両がを加速するときに、燃料に格納されている化学エネルギーを運動エネルギーに変換する効率を指定します (つまり、キネティックEnergyGained/ChemicalEnergyConsumed)。ChemicalEnergyConsumed は、fuelEnergyDensityInMJoulesPerLiterを使用して、消費された燃料を化学エネルギーに変換することによって得られます。減速とペアリングする必要があります非効率性。使用できる値の範囲は、0.0 ~ 1/の減速効率です。良識値 : 燃焼モデル : 0.33, 電気モデル用 : 0.66
auxiliaryPowerInkW	query		number (double)	補助システムを維持するために消費される電力の量をキロワット (kW) 単位で指定します。 ACシステム、無線、暖房などのデバイスやシステムによる消費を指定するために使用できます。適切な値 : 1.7
auxiliaryPowerInLitersPerHour	query		number (double)	車両の補助システムを維持するために消費される燃料の量を 1 時間あたりのリットル単位で指定します。 ACシステム、無線、暖房などのデバイスやシステムによる消費を指定するために使用できます。適切な値 : 0.2
avoid	query		RouteAvoidType[]	ルートを決定するときに、ルートの計算で回避する必要がある何かを指定します。 1 つの要求で複数回指定できます。たとえば、'&avoid=高速道路&avoid=tollRoads&avoid=ferrys' です。ルート範囲要求では、値 alreadyUsedRoads を使用しないでください。
constantSpeedConsumptionInkWhPerHundredkm	query		string	消費の速度に依存するコンポーネントを指定します。速度/消費レートペアの順序なしリストとして提供されます。この一覧では、消費曲線上のポイントを定義します。一覧にない速度の従量課金レートは次のとおりです。指定された速度がリスト内の 2 つの速度の間にある場合は、線形補間によってそれ以外の場合は線形外挿によって、リスト内の最も近い 2 つの点によって決定される定数 (ΔConsumption/ΔSpeed) を想定しますリストには 1 ~ 25 ポイント (両端を含む) を含める必要があり、同じ速度で重複するポイントが含まれていない場合があります。 1 つのポイントのみが含まれている場合は、そのポイントの消費率がそれ以上処理されずに使用されます。最大速度に指定する消費量は、最後の最大速度以上である必要があります。これにより、外挿によって消費率が低下することはありません。同様に、一覧の 2 つの最小速度に対して指定された消費値は、速度が小さい場合に負の消費率につながることはできません。消費値 (kWh/100km で表される) の有効な範囲は 0.01 ~ 100000.0 です。適切な値 : 50,8.2:130,21.3 このパラメーターは、電力消費モデルのに必要です。
constantSpeedConsumptionInLitersPerHundredkm	query		string	消費の速度に依存するコンポーネントを指定します。コロン区切りの速度 & 従量課金レートペアの順序なしリストとして提供されます。この一覧では、消費曲線上のポイントを定義します。一覧にない速度の従量課金レートは次のとおりです。指定された速度がリスト内の 2 つの速度の間にある場合は、線形補間によってそれ以外の場合は線形外挿によって、リスト内の最も近い 2 つの点によって決定される定数 (ΔConsumption/ΔSpeed) を想定しますリストには 1 ~ 25 ポイント (両端を含む) を含める必要があり、同じ速度で重複するポイントが含まれていない場合があります。 1 つのポイントのみが含まれている場合は、そのポイントの消費率がそれ以上処理されずに使用されます。最大速度に指定する消費量は、最後の最大速度以上である必要があります。これにより、外挿によって消費率が低下することはありません。同様に、一覧の 2 つの最小速度に対して指定された消費値は、速度が小さい場合に負の消費率につながることはできません。消費値 (l/100km で表される) の有効な範囲は、0.01 から 100000.0 の間です。適切な値: 50,6.3:130,11.5 注: このパラメータは、燃焼消費モデルをするために必要です。
currentChargeInkWh	query		number (double)	現在の電力供給量をキロワット時 (kWh) 単位で指定します。このパラメーターは、maxChargeInkWh パラメーター共に存在します。使用できる値の範囲は、maxChargeInkWhをする 0.0 です。適切な値 : 43
currentFuelInLiters	query		number (double)	燃料の現在の供給量をリットル単位で指定します。適切な値 : 55
decelerationEfficiency	query		number (double) minimum: 0 maximum: 1	車両が減速するときに、運動エネルギーを節約 (消費されていない) 燃料に変換する効率を指定します (つまり、ChemicalEnergySaved/KineticEnergyLost)。ChemicalEnergySaved は、fuelEnergyDensityInMJoulesPerLiterを使用して、保存された (消費されていない) 燃料をエネルギーに変換することによって得られます。 accelerationEfficiencyとペアにする必要があります。使用できる値の範囲は、0.0 ~ 1/accelerationEfficiencyです。良識値 : 燃焼モデル : 0.83, 電気モデル用 : 0.91
departAt	query		string (date-time)	`dateTime`で定義されている値として書式設定された出発地からの出発日時。タイムゾーンオフセットは省略可能です。タイムゾーンオフセットが指定されていない場合は、原点のオフセットと見なされます。既定値: 今すぐその他の値: `dateTime` 例： 2023-12-19T16:39:57 2023-12-19T16:39:57-08:00 `departAt` パラメーターは、`arriveAt`と組み合わせて使用することはできません。
distanceBudgetInMeters	query		number (double)	走行距離を使用して移動できる最大範囲を決定する距離の予算 (メートル単位)。従量課金モデルは、routeType が eco の場合にのみ範囲に影響します。 1 つの予算 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec、または distanceBudgetInMeters) を使用する必要があります。
downhillEfficiency	query		number (double) minimum: 0 maximum: 1	車両が標高を失ったときに、潜在的なエネルギーを節約 (消費されていない) 燃料に変換する効率を指定します (つまり、ChemicalEnergySaved/PotentialEnergyLost)。ChemicalEnergySaved は、fuelEnergyDensityInMJoulesPerLiterを使用して、保存された (消費されていない) 燃料をエネルギーに変換することによって得られます。 uphillEfficiencyペアにする必要があります。使用できる値の範囲は 0.0 ~ 1/uphillEfficiencyです。良識値 : 燃焼モデル : 0.51, 電気モデル用 : 0.73
energyBudgetInkWh	query		number (double)	指定された電力消費モデルを使用して移動できる最大範囲を決定するキロワット時 (kWh) の電気エネルギー予算。 energyBudgetInkWh を使用する場合は、詳細な電力消費モデルを指定する必要があります。 1 つの予算 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec、または distanceBudgetInMeters) を使用する必要があります。
fuelBudgetInLiters	query		number (double)	指定された燃焼消費モデルを使用して走行できる最大範囲を決定するリットル単位の燃料バジェット。 fuelBudgetInLiters を使用する場合は、詳細な燃焼消費モデルを指定する必要があります。 1 つの予算 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec、または distanceBudgetInMeters) を使用する必要があります。
fuelEnergyDensityInMJoulesPerLiter	query		number (double)	メガジュール (MJ) の 1 リットルの燃料に格納される化学エネルギーの量を指定します。これは、効率パラメータと組み合わせて使用され、節約または消費されたエネルギーと燃料の間の変換に使用されます。たとえば、エネルギー密度はガソリンの場合は 34.2 MJ/l、ディーゼル燃料の場合は 35.8 MJ/l です。 Efficiency パラメーターが設定されている場合は、このパラメーターが必要です。適切な値 : 34.2
hilliness	query		InclineLevel	スリル満点のルートのためのヒルネスの程度。このパラメーターは、`routeType`=thrilling と組み合わせてのみ使用できます。
maxChargeInkWh	query		number (double)	車両のバッテリーに格納できる最大電力供給量をキロワット時 (kWh) 単位で指定します。このパラメーターは、currentChargeInkWh パラメーター共に存在します。最小値は、currentChargeInkWh以上である必要があります。賢明な値 : 85
routeType	query		RouteType	要求されたルートの種類。
timeBudgetInSec	query		number (double)	運転時間を使用して移動できる最大範囲を決定する時間の予算 (秒)。従量課金モデルは、routeType が eco の場合にのみ範囲に影響します。 1 つの予算 (fuelBudgetInLiters、energyBudgetInkWh、timeBudgetInSec、または distanceBudgetInMeters) を使用する必要があります。
traffic	query		boolean	使用可能な値: true - ルーティング中に使用可能なすべてのトラフィック情報を考慮してください false - ルーティング中に現在のトラフィックデータを無視します。現在の交通データはルーティング中は無視されますが、有効な道路速度に対する履歴トラフィックの影響は引き続き組み込まれていることに注意してください。
travelMode	query		TravelMode	要求されたルートの移動モード。定義されていない場合、既定値は 'car' です。要求された travelMode は、ルート全体で使用できない場合があることに注意してください。要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。バス、オートバイ、タクシー、バンの移動モードはベータ機能であることに注意してください。すべての領域で完全な制限データを使用できるわけではありません。
uphillEfficiency	query		number (double) minimum: 0 maximum: 1	車両が昇格 (PotentialEnergyGained/ChemicalEnergyConsumed) を取得したときに、燃料に格納されている化学エネルギーを潜在的なエネルギーに変換する効率を指定します。ChemicalEnergyConsumed は、fuelEnergyDensityInMJoulesPerLiterを使用して、消費された燃料を化学エネルギーに変換することによって得られます。ダウンヒル非効率性とペアリングする必要があります。使用できる値の範囲は 0.0 ~ 1/です。良識値 : 燃焼モデルの場合 : 0.27, 電気モデル用 : 0.74
vehicleAxleWeight	query		integer	車両の車軸あたりの重量 (kg)。値が 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 の場合は、車両に適した値が決定され、ルート計画中に適用されることを意味します。ルート計画中に 0 以外の値がオーバーライドされる場合があります。たとえば、現在のトラフィックフローは 60 km/時間です。車両の最高速度が 50 km/時に設定されている場合、現在の状況であるため、ルーティングエンジンは 60 km/時間を考慮します。車両の最高速度が 80 km/時間として提供されているが、現在の交通フローが 60 km/時間の場合、ルーティングエンジンは再び 60 km/時間を使用します。
vehicleWeight	query		integer	車両の重量 (キロ単位)。効率パラメーターのいずれかが設定されている場合は必須です。従量課金モデルのコンテキストで使用する場合は、厳密に正である必要があります。重みの制限が考慮されます。詳細な従量課金モデルのが指定されておらず、vehicleWeight の値 0 以外の場合は、重量制限が考慮されます。それ以外の場合は、このパラメーターは無視されます。良識値 : 燃焼モデル* : 1600, 電気モデル用 : 1900年
vehicleWidth	query		number (double)	車両の幅 (メートル単位)。値が 0 の場合、幅の制限は考慮されません。
windingness	query		WindingnessLevel	スリル満点のルートのターンのレベル。このパラメーターは、`routeType`=thrilling と組み合わせてのみ使用できます。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーンアカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用するには、ガイダンス次の記事を参照してください。

応答

名前	型	説明
200 OK	RouteRangeResult	わかりました
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは、Microsoft Entra OAuth 2.0 フローです。 Azure ロールベースアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、任意のユーザー、グループ、またはサービスプリンシパルにアクセス権を付与できます。

シナリオを実装するには、認証の概念表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。

注記

このセキュリティ定義使用して、アプリケーションがアクセスを要求している Azure Maps リソースを示す必要があります。これは、Maps 管理 APIから取得できます。

Authorization URL は、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、一意の承認 URL と Microsoft Entra ID 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して、Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対するアプリケーションの構成ベースのセットアップが可能になります。

Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portal で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウントを作成場合にプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。つまり、このキーは、発行されたアカウントのマスターキーとして使用できます。

パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアントアプリケーションアプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。

型: apiKey
/: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソースのリスト SAS 操作から作成される Shared Access Signature トークンです。

このトークンを使用すると、すべてのアプリケーションは、Azure ロールベースのアクセス制御と、特定のトークンに対する使用の有効期限、レート、およびリージョンに対するきめ細かな制御を使用してアクセスすることが承認されます。つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

パブリックに公開されているアプリケーションの場合は、Map アカウントリソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するようにすることをお勧めします。

型: apiKey
/: header

例

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "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
      }
    ]
  }
}

定義

名前	説明
EffectiveSetting	このルート API を呼び出すときに使用される有効なパラメーターまたはデータ。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
InclineLevel	スリル満点のルートのためのヒルネスの程度。このパラメーターは、`routeType`=thrilling と組み合わせてのみ使用できます。
LatLongPair	緯度と経度として表される場所。
ResponseFormat	応答の目的の形式。値は、json することも、xml することもできます。
RouteAvoidType	ルートを決定するときに、ルートの計算で回避する必要がある何かを指定します。 1 つの要求で複数回指定できます。たとえば、'&avoid=高速道路&avoid=tollRoads&avoid=ferrys' です。ルート範囲要求では、値 alreadyUsedRoads を使用しないでください。
RouteRange	到達可能範囲
RouteRangeResult	このオブジェクトは、ルート到達可能範囲呼び出しが成功した場合に返されます
RouteReport	現在の呼び出しで使用されている有効な設定を報告します。
RouteType	要求されたルートの種類。
TravelMode	要求されたルートの移動モード。定義されていない場合、既定値は 'car' です。要求された travelMode は、ルート全体で使用できない場合があることに注意してください。要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。バス、オートバイ、タクシー、バンの移動モードはベータ機能であることに注意してください。すべての領域で完全な制限データを使用できるわけではありません。
VehicleEngineType	車両のエンジンタイプ。詳細な従量課金モデルを指定する場合は、vehicleEngineTypeの値一致している必要があります。
VehicleLoadType	危険物として分類され、一部の道路から制限される可能性のある貨物の種類。使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国/地域で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国/地域には otherHazmat を使用する必要があります。 vehicleLoadType は複数回指定できます。このパラメーターは現在、travelMode=truck に対してのみ考慮されます。
WindingnessLevel	スリル満点のルートのターンのレベル。このパラメーターは、`routeType`=thrilling と組み合わせてのみ使用できます。

EffectiveSetting

Object

このルート API を呼び出すときに使用される有効なパラメーターまたはデータ。

名前	型	説明
key	string	使用されるパラメーターの名前。
value	string	使用されるパラメーターの値。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

InclineLevel

列挙

スリル満点のルートのためのヒルネスの程度。このパラメーターは、routeType=thrilling と組み合わせてのみ使用できます。

値	説明
high	高い
low	低い
normal	正常

LatLongPair

Object

緯度と経度として表される場所。

名前	型	説明
latitude	number (double)	Latitude プロパティ
longitude	number (double)	Longitude プロパティ

ResponseFormat

列挙

応答の目的の形式。値は、json することも、xml することもできます。

値	説明
json	JavaScript オブジェクト表記データ交換形式をする
xml	拡張マークアップ言語をする

RouteAvoidType

列挙

ルートを決定するときに、ルートの計算で回避する必要がある何かを指定します。 1 つの要求で複数回指定できます。たとえば、'&avoid=高速道路&avoid=tollRoads&avoid=ferrys' です。ルート範囲要求では、値 alreadyUsedRoads を使用しないでください。

値	説明
alreadyUsedRoads	同じ道路を複数回使用しないようにします。 `routeType`=スリルと組み合わせて最も便利です。
borderCrossings	ルート計算で境界線の交差を回避します。
carpools	カープール (HOV/高占有車) レーンの使用を必要とするルートを回避します。
ferries	フェリーを避ける
motorways	高速道路を避ける
tollRoads	有料道路を回避します。
unpavedRoads	未舗装の道路を回避する

RouteRange

Object

到達可能範囲

名前	型	説明
boundary	LatLongPair[]	ポイントのリストとして表される到達可能範囲の多角形境界。
center	LatLongPair	到達可能範囲の中心点

RouteRangeResult

Object

このオブジェクトは、ルート到達可能範囲呼び出しが成功した場合に返されます

名前	型	説明
formatVersion	string	[バージョンの書式設定] プロパティ
reachableRange	RouteRange	到達可能範囲
report	RouteReport	現在の呼び出しで使用されている有効な設定を報告します。

RouteReport

Object

現在の呼び出しで使用されている有効な設定を報告します。

名前	型	説明
effectiveSettings	EffectiveSetting[]	このルート API を呼び出すときに使用される有効なパラメーターまたはデータ。

RouteType

列挙

要求されたルートの種類。

値	説明
eco	エコノミーとスピードでバランスの取れたルート。
fastest	最速のルート。
shortest	距離別の最短ルート。
thrilling	興味深い道路や困難な道路が含まれており、できるだけ少ない高速道路を使用しています。含まれるターンのレベルと、ヒルネスの度合いを選択できます。これを設定する方法については、丘と巻き取りのパラメーターを参照してください。 `routeType`=スリルを伴って計画されているルートには900キロの制限があります

TravelMode

列挙

要求されたルートの移動モード。定義されていない場合、既定値は 'car' です。要求された travelMode は、ルート全体で使用できない場合があることに注意してください。要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。バス、オートバイ、タクシー、バンの移動モードはベータ機能であることに注意してください。すべての領域で完全な制限データを使用できるわけではありません。

値	説明
bus	返されるルートは、バス専用レーンの使用を含め、バス用に最適化されています。 BETA 機能。
car	返されるルートは、自動車用に最適化されています。
motorcycle	返されるルートは、オートバイ用に最適化されています。 BETA 機能。
taxi	返されるルートは、タクシー用に最適化されています。 BETA 機能。
truck	返されるルートは、トラックなどの商用車両用に最適化されています。
van	返されるルートはバン用に最適化されています。 BETA 機能。

VehicleEngineType

列挙

車両のエンジンタイプ。詳細な従量課金モデルを指定する場合は、vehicleEngineTypeの値一致している必要があります。

値	説明
combustion	内燃機関。
electric	電気エンジン。

VehicleLoadType

列挙

危険物として分類され、一部の道路から制限される可能性のある貨物の種類。使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国/地域で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国/地域には otherHazmat を使用する必要があります。 vehicleLoadType は複数回指定できます。このパラメーターは現在、travelMode=truck に対してのみ考慮されます。

値	説明
USHazmatClass1	爆発物
USHazmatClass2	圧縮ガス
USHazmatClass3	引火性液体
USHazmatClass4	可燃性固体
USHazmatClass5	酸化剤
USHazmatClass6	毒
USHazmatClass7	放射性
USHazmatClass8	腐食性物質
USHazmatClass9	その他
otherHazmatExplosive	爆発物
otherHazmatGeneral	その他
otherHazmatHarmfulToWater	水に有害

WindingnessLevel

列挙

スリル満点のルートのターンのレベル。このパラメーターは、routeType=thrilling と組み合わせてのみ使用できます。

値	説明
high	高い
low	低い
normal	正常

次の方法で共有

Route - Get Route Range

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

注記

スコープ

subscription-key

SAS Token

例

Successfully retrieve a set of locations that can be reached from the origin point based on various conditions

要求のサンプル

応答のサンプル

定義

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InclineLevel

LatLongPair

ResponseFormat

RouteAvoidType

RouteRange

RouteRangeResult

RouteReport

RouteType

TravelMode

VehicleEngineType

VehicleLoadType

WindingnessLevel

その他のリソース