Share via

Route - Post Route Directions

  • リファレンス
Service:
Maps
API Version:
1.0

指定したウェイポイントを通過して、指定した出発地と目的地の間のルートを計算するには、 を使用します。

Post Route Directions API は、配信元と宛先の間のルートを返す HTTP POST 要求であり、指定されている場合はウェイポイントを通過します。 ルートでは、現在のトラフィックや、要求された曜日と時刻の一般的な道路速度などの要因が考慮されます。

返される情報には、距離、推定移動時間、ルート ジオメトリの表現が含まれます。 選択したオプションに応じて、ウェイポイントの順序の最適化やターンバイターン命令などの追加のルーティング情報も利用できます。

ルーティング サービスには、車両固有の従量課金モデルの詳細な説明に関する一連のパラメーターが用意されています。 関連する概念とパラメーターの詳細については、「従量課金モデル」をチェックしてください。

POST https://atlas.microsoft.com/route/directions/{format}?api-version=1.0&query={query}
With optional parameters: 
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 パラメーター

名前 / 必須 型 説明
format
 path True

ResponseFormat

応答の目的の形式。 値には json または xml を指定できます。
api-version
 query True

string

Azure Maps API のバージョン番号。
query
 query True

string

ルートの計算に使用される座標は、コロンで区切られます。 少なくとも 2 つの座標が必要です。 最初の 1 つは配信元で、最後はルートの宛先です。 中間のオプションの座標は、ルート内の WayPoint として機能します。 最大 150 個の WayPoint を渡すことができます。
accelerationEfficiency
 query

number

double

車両が加速したときに燃料に格納されている化学エネルギーを運動エネルギーに変換する効率を指定します (つまり、キネティックEnergyGained/ChemicalEnergyConsumed)。ChemicalEnergyConsumed は、使用した燃料を fuelEnergyDensityInMJoulesPerLiter を使用して化学エネルギーに変換することによって得られます。

減速効率と組み合わせて使用する必要があります。

使用できる値の範囲は、0.0 ~ 1/減速効率です。

良識値 : 燃焼モデル の場合 : 0.33, 電気モデル の場合 : 0.66
alternativeType
 query

AlternativeRouteType

指定された計画基準に関して、参照ルートと比較して計算された代替の最適性を制御します。
arriveAt
 query

string

date-time

RFC 3339 セクション 5.6 で定義されている値としてdateTime書式設定された宛先ポイントへの到着日時。タイム ゾーン オフセットは省略可能です。 タイム ゾーン オフセットが指定されていない場合は、ターゲット ポイントのオフセットと見なされます。

例 :

  • 2023-12-19T16:39:57
  • 2023-12-20T00:39:57+00:00

パラメーターをarriveAt、、または minDeviationTimeとdepartAtminDeviationDistance組み合わせて使用することはできません。
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 を使用しないでください。
computeBestOrder
 query

boolean

高速ヒューリスティック アルゴリズムを使用してルート ウェイポイントを順序を再作成し、ルートの長さを短くします。 routeType 最短と組み合わせて使用すると 、最良の結果が得られます。 配信元と宛先は、最適化されたウェイポイント インデックスから除外されていることに注意してください。 応答に配信元と宛先を含めるには、配信元を考慮するためにすべてのインデックスを 1 ずつ増やし、最後のインデックスとして宛先を追加してください。 指定できる値は、true または false です。 True を指定すると、可能であればより良い順序が計算されますが、0 より大きい maxAlternatives 値または円のウェイポイントと組み合わせて使用することはできません。 False は指定された順序で場所を使用し、routeRepresentation none と組み合わせて使用することはできません。
computeTravelTimeFor
 query

ComputeTravelTime

さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。
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 パラメーターと共存します。

使用できる値の範囲は 0.0 から maxChargeInkWh です。

賢明な値 : 43
currentFuelInLiters
 query

number

double

燃料の現在の供給量をリットル単位で指定します。

賢明な値 : 55
decelerationEfficiency
 query

number

double

車両が減速したときに、運動エネルギーを節約 (消費されていない) 燃料に変換する効率を指定します (つまり、ChemicalEnergySaved/KineticEnergyLost)。ChemicalEnergySaved は、 fuelEnergyDensityInMJoulesPerLiter を使用して、保存された (消費されていない) 燃料をエネルギーに変換することによって取得されます。

accelerationEfficiency とペアにする必要があります。

使用できる値の範囲は、0.0 ~ 1/accelerationEfficiency です。

良識値 : 燃焼モデル の場合 : 0.83, 電気モデル の場合 : 0.91
departAt
 query

string

date-time

RFC 3339 セクション 5.6 で定義されている値としてdateTime書式設定された、任意のタイム ゾーン オフセットを含む、出発地点からの出発日時。 タイム ゾーン オフセットが指定されていない場合は、原点のオフセットと見なされます。

  • 既定値: 今すぐ
  • その他の値: dateTime

例 :

  • 2023-12-19T16:39:57
  • 2023-12-20T00:39:57+00:00

パラメーターを departAt と arriveAt組み合わせて使用することはできません。
downhillEfficiency
 query

number

double

車両が標高を失ったときに、潜在的なエネルギーを節約 (消費されていない) 燃料に変換する効率を指定します (つまり、ChemicalEnergySaved/PotentialEnergyLost)。ChemicalEnergySaved は、 fuelEnergyDensityInMJoulesPerLiter を使用して、保存された (消費されていない) 燃料をエネルギーに変換することによって取得されます。

uphillEfficiency とペアにする必要があります。

使用できる値の範囲は 0.0 ~ 1/uphillEfficiency です。

良識値 : 燃焼モデル の場合 : 0.51, 電気モデル の場合 : 0.73
fuelEnergyDensityInMJoulesPerLiter
 query

number

double

メガジュール (MJ) の 1 リットルの燃料に格納される化学エネルギーの量を指定します。 これは、保存または消費されたエネルギーと燃料の間の変換のために*効率 パラメータと組み合わせて使用されます。 たとえば、ガソリンのエネルギー密度は 34.2 MJ/l、ディーゼル燃料の場合は 35.8 MJ/l です。

*Efficiency パラメーターが設定されている場合は、このパラメーターが必要です。

賢明な値 : 34.2
hilliness
 query

InclineLevel

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

RouteInstructionsType

指定した場合は、ガイダンスの指示が返されます。 instructionsType パラメーターは routeRepresentation=none と組み合わせて使用できないことに注意してください
language
 query

string

language パラメーターは、ガイダンス メッセージの言語を決定します。 固有名詞 (通り、広場などの名前) には影響しません。instructionsType=coded の場合、効果はありません。 使用できる値は、記述されている IETF 言語タグ (のサブセット) です
maxAlternatives
 query

integer

計算する必要な代替ルートの数。 既定値: 0、最小: 0、最大: 5
maxChargeInkWh
 query

number

double

車両のバッテリーに格納できる最大電力供給量をキロワット時 (kWh) 単位で指定します。

このパラメーターは currentChargeInkWh パラメーターと共存します。

最小値は currentChargeInkWh 以上である必要があります。

賢明な値 : 85
minDeviationDistance
 query

integer

返されるすべての代替ルートは、少なくともこのメーター数の calculateRoute 要求の原点からの参照ルート (POST 要求のセクションを参照) に従います。 ルートを再構築する場合にのみ使用できます。 minDeviationDistance パラメーターを arriveAt と組み合わせて使用することはできません
minDeviationTime
 query

integer

返されるすべての代替ルートは、少なくともこの秒数だけ、calculateRoute 要求の起点からの参照ルート (POST 要求のセクションを参照) に従います。 ルートを再構築する場合にのみ使用できます。 minDeviationTime パラメーターは、arriveAt と組み合わせて使用することはできません。 既定値は 0 です。 )minDeviationTime_を 0 より大きい値に設定すると、次のような結果になります。

  • calculateRoute 要求の原点は、入力参照ルート上にある (または非常に近い) 必要があります。
    • そうでない場合は、エラーが返されます。
    • ただし、原点は入力参照ルートの先頭にある必要はありません (参照ルート上の現在の車両位置と考えることができます)。
  • calculateRoute 応答の最初のルートとして返される参照ルートは、calculateRoute 要求で指定された原点から開始されます。 原点が応答から除外されるまでの入力参照ルートの最初の部分。
  • minDeviationDistance と minDeviationTime の値によって、基準点以降の参照ルートに従うことを保証する代替ルートの距離が決まります。
  • ルートでは 、departAt を使用する必要があります。
  • vehicleHeading は無視されます。
report
 query

Report

診断のために報告するデータを指定します。 有効な値は effectiveSettings のみです。 API を呼び出すときに使用される有効なパラメーターまたはデータを報告します。 既定のパラメーターの場合、パラメーターが呼び出し元によって指定されなかった場合、既定値が反映されます。
routeRepresentation
 query

RouteRepresentationForBestOrder

応答として提供されるルートのセットの表現を指定します。 このパラメーター値は、computeBestOrder=true と組み合わせてのみ使用できます。
routeType
 query

RouteType

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

SectionType

ルート応答で報告されるセクションの種類を指定します。

たとえば、sectionType = 歩行者の場合、歩行者のみに適したセクションが返されます。 複数の型を使用できます。 既定の sectionType は、travelMode 入力を参照します。 既定では、travelMode は car に設定されています
traffic
 query

boolean

指定できる値

  • true - ルーティング中に使用可能なすべてのトラフィック情報を考慮する
  • false - ルーティング中に現在のトラフィック データを無視します。 現在のトラフィック データはルーティング中は無視されますが、有効な道路速度に対する履歴トラフィックの影響は引き続き組み込まれることに注意してください。
travelMode
 query

TravelMode

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

number

double

車両が昇格したときに、燃料に格納されている化学エネルギーを潜在的なエネルギーに変換する効率を指定します (つまり、PotentialEnergyGained/ChemicalEnergyConsumed)。ChemicalEnergyConsumed は、使用した燃料を fuelEnergyDensityInMJoulesPerLiter を使用して化学エネルギーに変換することによって得られます。

ダウンヒル効率性とペアにする必要があります。

使用できる値の範囲は、0.0 から 1/ダウンヒル効率です。

良識値 : 燃焼モデル の場合 : 0.27, 電気モデル の場合 : 0.74
vehicleAxleWeight
 query

integer

車両の車軸あたりの重量 (kg)。 値が 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 は、ルート計画中に車両に適切な値が決定され、適用されることを意味します。

  • 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

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

要求ヘッダー

名前 必須 型 説明
x-ms-client-id

string

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

要求本文

名前 型 説明
allowVignette

string[]

これは、ビネット付きの有料道路が許可されている国/地域の 3 文字の ISO 3166-1、alpha-3 国番号 (例: "AUS,CHE" ) の一覧です。 一部の国/地域で allowVignette を指定する X は、すべての国/地域で avoidVignette を指定するのと同じですが、X。空のリストで allowVignette を指定することは、ビネットを含むすべての有料道路を回避することと同じです。 注: avoidVignette と allowVignette の両方を指定するのはエラーです。
avoidAreas

GeoJsonMultiPolygon

回避する領域の一覧を表す GeoJSON MultiPolygon。 四角形の多角形のみがサポートされています。 四角形の最大サイズは約 160 x 160 km です。 回避領域の最大数は 10 です。 180 番目の子午線を越えることはできません。 -80 ~ +80 度の緯度である必要があります。
avoidVignette

string[]

これは、3 文字の ISO 3166-1、アルファ 3 の国/地域コードの一覧で、ビネットを含むすべての有料道路 (例: "AUS,CHE" など) を回避する必要があります。 リストにない国/地域のビネットがある有料道路は影響を受けません。 注: avoidVignette と allowVignette の両方を指定するのはエラーです。
supportingPoints

GeoJsonGeometryCollection

ルート再構築の入力およびこの参照ルートへの 0 個以上の代替ルートの計算に使用される座標のシーケンスを表す GeoJSON Geometry コレクション。

  • 指定されたサポート ポイントのシーケンスは、ルート再構築の入力として使用されます。
  • 代替ルートは、ベース パス パラメーターの場所で指定された始点と終点の間で計算されます。
  • minDeviationDistance と minDeviationTime の両方が 0 に設定されている場合、これらの始点と終点はそれぞれ、参照ルートの始点と終点の位置 (または非常に近い) にあると想定されます。
  • SupportPoints を使用<する場合、中間の場所 (ウェイポイント>) はサポートされません。
  • 参照ルート には、ROAD_CLOSURE型のトラフィック インシデントが含まれる場合があります。これは、参照ルートの移動時間とトラフィック遅延の計算では無視されます。 詳細については、「 サポートポイント 」を参照してください。

応答

名前 型 説明
200 OK

RouteDirections

OK
Other Status Codes

ErrorResponse

予期しないエラーが発生しました。

セキュリティ

AADToken

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

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

メモ

  • このセキュリティ定義では、 ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソース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 を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

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

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

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

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

例

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

Sample Request

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

Sample Response

Status code:
200 
{
  "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"
        }
      ]
    }
  ]
}

定義

名前 説明
AlternativeRouteType

指定された計画基準に関して、参照ルートと比較して計算された代替の最適性を制御します。
ComputeTravelTime

さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。
DelayMagnitude

インシデントによって発生する遅延の大きさ。 これらの値は、 トラフィック インシデント詳細の取得 API の応答フィールド ty の値に対応します。
DrivingSide

操縦のポイントで左手と右側の運転を示します。
EffectiveSetting

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

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

エラーの詳細。
ErrorResponse

エラー応答
GeoJsonGeometry

有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。
GeoJsonGeometryCollection

有効な GeoJSON GeometryCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。
GeoJsonLineString

有効な GeoJSON LineString geometry 型。 詳細については、 RFC 7946 を参照してください。
GeoJsonMultiLineString

有効な GeoJSON MultiLineString geometry 型。 詳細については、 RFC 7946 を参照してください。
GeoJsonMultiPoint

有効な GeoJSON MultiPoint geometry 型。 詳細については、 RFC 7946 を参照してください。
GeoJsonMultiPolygon

有効な GeoJSON MultiPolygon オブジェクト型。 詳細については、 RFC 7946 を参照してください。
GeoJsonPoint

有効な GeoJSON Point geometry 型。 詳細については、 RFC 7946 を参照してください。
GeoJsonPolygon

有効な GeoJSON Polygon geometry 型。 詳細については、 RFC 7946 を参照してください。
GuidanceInstructionType

指示の種類(道路の形状の変更など)。
GuidanceManeuver

操縦を識別するコード。
InclineLevel

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

操縦が行われるジャンクションのタイプ。 より大きなラウンドアバウト交差点の場合は、ラウンドアバウト交差点の開始と終了に対して 2 つの個別の命令が生成されます。
LatLongPair

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

診断のために報告するデータを指定します。 有効な値は effectiveSettings のみです。 API を呼び出すときに使用される有効なパラメーターまたはデータを報告します。 既定のパラメーターの場合、パラメーターが呼び出し元によって指定されなかった場合、既定値が反映されます。
ResponseFormat

応答の目的の形式。 値には json または xml を指定できます。
ResponseSectionType

報告されたルート応答のセクションの種類
ResponseTravelMode

計算されたルートの移動モード。 このセクションで要求されたトランスポート モードが不可能な場合、値は に設定 other されます
Route
RouteAvoidType

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

ルートの方向の本文パラメーターをポストします。
RouteDirections

このオブジェクトは、ルート方向の呼び出しが成功した場合に返されます
RouteGuidance

ガイダンス関連の要素が含まれています。 このフィールドは、ガイダンスが要求され、使用可能な場合にのみ表示されます。
RouteInstruction

"右に曲がる"、"左に置く"、"フェリーに乗る"、"高速道路を取る"、"到着" など、操縦を説明する属性のセット。
RouteInstructionGroup

相互に関連する命令要素のシーケンスをグループします。 シーケンス範囲は、firstInstructionIndex と lastInstructionIndex で制約されます。 人間が読み取り可能なテキスト メッセージにガイダンス (instructionType=text またはタグ付け) を要求すると、instructionGroup には、使用可能な場合に概要メッセージが返されます。
RouteInstructionsType

指定した場合は、ガイダンスの指示が返されます。 instructionsType パラメーターは routeRepresentation=none と組み合わせて使用できないことに注意してください
RouteLeg

ポイントのリストで構成されるルートの一部の説明。 要求で指定された追加の各ウェイポイントは、返されたルートに追加の区間になります。
RouteLegSummary

ルート セクションの概要オブジェクト。
RouteOptimizedWaypoint

最適化されたウェイ ポイント オブジェクト。
RouteReport

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

応答として提供されるルートのセットの表現を指定します。 このパラメーター値は、computeBestOrder=true と組み合わせてのみ使用できます。
RouteSection

ルート セクションには、ルートの一部に関する追加情報が含まれています。 各セクションには、少なくとも 要素 startPointIndex、、 endPointIndexおよび sectionTypeが含まれています。
RouteSectionTec

TPEG2-TEC 標準の定義を使用したトラフィック イベントの詳細。 effectCode を含め、要素を引き起こすことができます。
RouteSectionTecCause

トラフィック イベントの原因。 mainCauseCode 要素と subCauseCode 要素を含めることができます。 アイコンと説明を定義するために使用できます。
RouteSummary

Summary オブジェクト
RouteType

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

ルート応答で報告されるセクションの種類を指定します。

たとえば、sectionType = 歩行者の場合、歩行者のみに適したセクションが返されます。 複数の型を使用できます。 既定の sectionType は、travelMode 入力を参照します。 既定では、travelMode は car に設定されています
SimpleCategory

インシデントの種類。 現在、JAM、ROAD_WORK、ROAD_CLOSURE、またはその他にすることができます。 詳細については、「tec」を参照してください。
TravelMode

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

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

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

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

AlternativeRouteType

指定された計画基準に関して、参照ルートと比較して計算された代替の最適性を制御します。

名前 型 説明
anyRoute

string

最適性の観点から、参照ルートと比較する方法に関係なく、代替ルートを返すことを許可します。
betterRoute

string

指定された計画基準に従って参照ルートよりも優れている場合にのみ、代替ルートを返します。

ComputeTravelTime

さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。

名前 型 説明
all

string

すべての種類のトラフィック情報の移動時間を計算し、ルート応答の概要に含まれるフィールド noTrafficTravelTimeInSeconds、historicTrafficTravelTimeInSeconds、liveTrafficIncidentsTravelTimeInSeconds のすべての結果を指定します。
none

string

追加の移動時間を計算しません。

DelayMagnitude

インシデントによって発生する遅延の大きさ。 これらの値は、 トラフィック インシデント詳細の取得 API の応答フィールド ty の値に対応します。

名前 型 説明
0

string

不明。
1

string

マイナー。
2

string

中程度。
3

string

メジャー。
4

string

未定義。道路の閉鎖やその他の不定の遅延に使用されます。

DrivingSide

操縦のポイントで左手と右側の運転を示します。

名前 型 説明
LEFT

string

左側。
RIGHT

string

右側。

EffectiveSetting

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

名前 型 説明
key

string

使用されるパラメーターの名前。
value

string

使用されるパラメーターの値。

ErrorAdditionalInfo

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細です。
message

string

エラー メッセージ。
target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 型 説明
error

ErrorDetail

error オブジェクト。

GeoJsonGeometry

有効な GeoJSON geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。

名前 型 説明
type

GeoJsonObjectType

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonGeometryCollection

有効な GeoJSON GeometryCollection オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前 型 説明
geometries GeoJsonGeometry[]:

有効な GeoJSON geometry オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。
type string:

GeometryCollection

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonLineString

有効な GeoJSON LineString geometry 型。 詳細については、 RFC 7946 を参照してください。

名前 型 説明
coordinates

number[]

ジオメトリの GeoJson LineString 座標。
type string:

LineString

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiLineString

有効な GeoJSON MultiLineString geometry 型。 詳細については、 RFC 7946 を参照してください。

名前 型 説明
coordinates

number[]

ジオメトリの GeoJson MultiLineString 座標。
type string:

MultiLineString

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GeoJsonMultiPoint

有効な GeoJSON MultiPoint geometry 型。 詳細については、 RFC 7946 を参照してください。

名前 型 説明
coordinates

number[]

ジオメトリの GeoJson MultiPoint 座標。
type string:

MultiPoint

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiPolygon

有効な GeoJSON MultiPolygon オブジェクト型。 詳細については、 RFC 7946 を参照してください。

名前 型 説明
coordinates

number[]

有効な GeoJSON Polygon オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。
type string:

MultiPolygon

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPoint

有効な GeoJSON Point geometry 型。 詳細については、 RFC 7946 を参照してください。

名前 型 説明
coordinates

number[]

は Position 、2 つ以上の要素を持つ数値の配列です。 最初の 2 つの要素は 経度 と 緯度で、正確にはその順序です。 高度/標高 は、省略可能な 3 番目の要素です。 詳細については、 RFC 7946 を参照してください。
type string:

Point

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPolygon

有効な GeoJSON Polygon geometry 型。 詳細については、 RFC 7946 を参照してください。

名前 型 説明
coordinates

number[]

geometry 型の GeoJson Polygon 座標。
type string:

Polygon

型を指定します GeoJSON 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

GuidanceInstructionType

指示の種類(道路の形状の変更など)。

名前 型 説明
DIRECTION_INFO

string

方向情報。
LOCATION_ARRIVAL

string

到着場所。
LOCATION_DEPARTURE

string

出発場所。
LOCATION_WAYPOINT

string

ウェイ ポイントの位置。
ROAD_CHANGE

string

道路の変更。
TURN

string

ターンします。

GuidanceManeuver

操縦を識別するコード。

名前 型 説明
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

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

名前 型 説明
high

string

high
low

string

low
normal

string

普通

JunctionType

操縦が行われるジャンクションのタイプ。 より大きなラウンドアバウト交差点の場合は、ラウンドアバウト交差点の開始と終了に対して 2 つの個別の命令が生成されます。

名前 型 説明
BIFURCATION

string

分岐
REGULAR

string

レギュラー
ROUNDABOUT

string

ロータリー

LatLongPair

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

名前 型 説明
latitude

number

Latitude プロパティ
longitude

number

Longitude プロパティ

Report

診断のために報告するデータを指定します。 有効な値は effectiveSettings のみです。 API を呼び出すときに使用される有効なパラメーターまたはデータを報告します。 既定のパラメーターの場合、パラメーターが呼び出し元によって指定されなかった場合、既定値が反映されます。

名前 型 説明
effectiveSettings

string

API を呼び出すときに使用される有効なパラメーターまたはデータを報告します。

ResponseFormat

応答の目的の形式。 値には json または xml を指定できます。

名前 型 説明
json

string

JavaScript オブジェクト表記データ交換形式
xml

string

拡張可能なマークアップ言語

ResponseSectionType

報告されたルート応答のセクションの種類

名前 型 説明
CARPOOL

string

カープール(HOV/高占有車)レーンの使用を必要とするルートのセクション。
CAR_TRAIN

string

車または電車であるルートのセクション。
COUNTRY

string

ルートが含まれる国/地域を示すセクション。
FERRY

string

フェリーであるルートのセクション。
MOTORWAY

string

高速道路であるルートのセクション。
PEDESTRIAN

string

歩行者にのみ適したルートのセクション。
TOLL_ROAD

string

通行料の支払いが必要なルートのセクション。
TOLL_VIGNETTE

string

有料ビネットが存在する必要があるルートのセクション。
TRAFFIC

string

トラフィック情報を含むルートのセクション。
TRAVEL_MODE

string

要求パラメーター travelModeに関連するセクション。
TUNNEL

string

トンネルであるルートのセクション。
URBAN

string

都市部に位置するルートのセクション。

ResponseTravelMode

計算されたルートの移動モード。 このセクションで要求されたトランスポート モードが不可能な場合、値は に設定 other されます

名前 型 説明
bicycle

string

返されるルートは、自転車レーンの使用を含め、自転車用に最適化されています。
bus

string

返されるルートは、バス専用レーンの使用を含め、バス用に最適化されています。 BETA 機能。
car

string

返されるルートは、車用に最適化されています。
motorcycle

string

返されるルートはオートバイ用に最適化されています。 BETA 機能。
other

string

このセクションでは、指定されたトランスポート モードを使用できません
pedestrian

string

返されるルートは、歩道の使用を含め、歩行者向けに最適化されています。
taxi

string

返されるルートはタクシー用に最適化されています。 BETA 機能。
truck

string

返されるルートは、トラックなどの商用車両用に最適化されています。
van

string

返されるルートはバン用に最適化されています。 BETA 機能。

Route

名前 型 説明
guidance

RouteGuidance

ガイダンス関連の要素が含まれています。 このフィールドは、ガイダンスが要求され、使用可能な場合にのみ表示されます。
legs

RouteLeg[]

脚の配列
sections

RouteSection[]

Sections 配列
summary

RouteSummary

Summary オブジェクト

RouteAvoidType

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

名前 型 説明
alreadyUsedRoads

string

同じ道路を複数回使用しないようにします。 =スリル満点と routeType組み合わせて最も便利です。
borderCrossings

string

ルート計算で境界の交差を回避します。
carpools

string

カープール(HOV/高占有車)レーンの使用を必要とするルートを回避します。
ferries

string

フェリーを避ける
motorways

string

高速道路を避ける
tollRoads

string

有料道路を回避します。
unpavedRoads

string

未舗装道路を回避する

RouteDirectionParameters

ルートの方向の本文パラメーターをポストします。

名前 型 説明
allowVignette

string[]

これは、ビネット付きの有料道路が許可されている国/地域の 3 文字の ISO 3166-1、alpha-3 国番号 (例: "AUS,CHE" ) の一覧です。 一部の国/地域で allowVignette を指定する X は、すべての国/地域で avoidVignette を指定するのと同じですが、X。空のリストで allowVignette を指定することは、ビネットを含むすべての有料道路を回避することと同じです。 注: avoidVignette と allowVignette の両方を指定するのはエラーです。
avoidAreas

GeoJsonMultiPolygon

回避する領域の一覧を表す GeoJSON MultiPolygon。 四角形の多角形のみがサポートされています。 四角形の最大サイズは約 160 x 160 km です。 回避領域の最大数は 10 です。 180 番目の子午線を越えることはできません。 -80 ~ +80 度の緯度である必要があります。
avoidVignette

string[]

これは、3 文字の ISO 3166-1、アルファ 3 の国/地域コードの一覧で、ビネットを含むすべての有料道路 (例: "AUS,CHE" など) を回避する必要があります。 リストにない国/地域のビネットがある有料道路は影響を受けません。 注: avoidVignette と allowVignette の両方を指定するのはエラーです。
supportingPoints

GeoJsonGeometryCollection

ルート再構築の入力およびこの参照ルートへの 0 個以上の代替ルートの計算に使用される座標のシーケンスを表す GeoJSON Geometry コレクション。

  • 指定されたサポート ポイントのシーケンスは、ルート再構築の入力として使用されます。
  • 代替ルートは、ベース パス パラメーターの場所で指定された始点と終点の間で計算されます。
  • minDeviationDistance と minDeviationTime の両方が 0 に設定されている場合、これらの始点と終点はそれぞれ、参照ルートの始点と終点の位置 (または非常に近い) にあると想定されます。
  • SupportPoints を使用<する場合、中間の場所 (ウェイポイント>) はサポートされません。
  • 参照ルート には、ROAD_CLOSURE型のトラフィック インシデントが含まれる場合があります。これは、参照ルートの移動時間とトラフィック遅延の計算では無視されます。 詳細については、「 サポートポイント 」を参照してください。

RouteDirections

このオブジェクトは、ルート方向の呼び出しが成功した場合に返されます

名前 型 説明
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[]

Routes 配列

RouteGuidance

ガイダンス関連の要素が含まれています。 このフィールドは、ガイダンスが要求され、使用可能な場合にのみ表示されます。

名前 型 説明
instructionGroups

RouteInstructionGroup[]

相互に関連する命令要素のシーケンスをグループします。
instructions

RouteInstruction[]

操作を説明する命令の一覧。

RouteInstruction

"右に曲がる"、"左に置く"、"フェリーに乗る"、"高速道路を取る"、"到着" など、操縦を説明する属性のセット。

名前 型 説明
combinedMessage

string

操縦のための人間が判読できるメッセージと、次の指示からのメッセージを組み合わせた。 場合によっては、2 つの連続する命令を 1 つの命令に結合して、従いやすくすることができます。 この場合、possibleCombineWithNext フラグは true になります。 例:

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

命令 10 で指定できるCombineWithNext フラグは 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

操縦が行われるジャンクションのタイプ。 より大きなラウンドアバウト交差点の場合は、ラウンドアバウト交差点の開始と終了に対して 2 つの個別の命令が生成されます。
maneuver

GuidanceManeuver

操縦を識別するコード。
message

string

操縦のための人間が判読できるメッセージ。
point

LatLongPair

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

integer

命令の点に対応するポリライン "points" のリスト内の点のインデックス。
possibleCombineWithNext

boolean

必要に応じて、命令を次の命令と組み合わせることができます。 これは、"左に曲がって右に曲がる" などのメッセージを作成するために使用できます。
roadNumbers

string[]

操縦後の次に重要な道路セグメントの道路番号、または従う道路の道路番号。 例: ["E34", "N205"]
roundaboutExitNumber

string

これは、ラウンドアバウト交差点で実行する終了を示します。
routeOffsetInMeters

integer

ルートの開始から命令のポイントまでの距離。
signpostText

string

操縦または従うべき方向に最も関連する道標のテキスト。
stateCode

string

ISO 3166-2 コードの 2 番目の部分で表される国の下位区分 (州など)。 これは、米国、カナダ、メキシコなどの一部の国/地域でのみ使用できます。
street

string

操縦後の次に重要な道路セグメントの通り名、または従う必要がある通りの道路名。
travelTimeInSeconds

integer

routeOffsetInMeters に対応するポイントまでの推定移動時間。
turnAngleInDecimalDegrees

integer

命令の方向を示します。 junctionType がターン命令を示す場合:

  • 180 = U ターン
  • [-179, -1] = 左折
  • 0 = ストレートオン ('0 度' ターン)
  • [1, 179] = 右折

junctionType が分岐命令を示す場合:

  • <0 - 左に保つ
  • >0 - 正しい状態に保つ

RouteInstructionGroup

相互に関連する命令要素のシーケンスをグループします。 シーケンス範囲は、firstInstructionIndex と lastInstructionIndex で制約されます。 人間が読み取り可能なテキスト メッセージにガイダンス (instructionType=text またはタグ付け) を要求すると、instructionGroup には、使用可能な場合に概要メッセージが返されます。

名前 型 説明
firstInstructionIndex

integer

命令内の最初の命令と、このグループに属するインデックス。
groupLengthInMeters

integer

グループの長さ。
groupMessage

string

人間が判読できるテキスト メッセージがガイダンスを求められた場合の概要メッセージ (instructionType=text またはタグ付け)。
lastInstructionIndex

integer

命令の最後の命令のインデックスで、このグループに属します。

RouteInstructionsType

指定した場合は、ガイダンスの指示が返されます。 instructionsType パラメーターは routeRepresentation=none と組み合わせて使用できないことに注意してください

名前 型 説明
coded

string

人間が読み取り可能なメッセージを含まない生の命令データを返します。
tagged

string

書式設定を許可するために、人間が読み取り可能なメッセージにタグ付けされた生の命令データを返します。 人間が判読できるメッセージは、繰り返し可能な識別された要素から構築されます。 これらは、クライアント アプリケーションが正しく書式設定できるようにタグ付けされています。 instructionsType=tagged: street、roadNumber、signpostText、exitNumber、roundaboutExitNumber の場合、次のメッセージ コンポーネントにタグが付きます。

タグ付けされた "左に曲がる" メッセージの例:

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

string

人間が判読できるメッセージを含む生の命令データをプレーン テキストで返します。

RouteLeg

ポイントのリストで構成されるルートの一部の説明。 要求で指定された追加の各ウェイポイントは、返されたルートに追加の区間になります。

名前 型 説明
points

LatLongPair[]

Points 配列
summary

RouteLegSummary

ルート セクションの概要オブジェクト。

RouteLegSummary

ルート セクションの概要オブジェクト。

名前 型 説明
arrivalTime

string

ルートまたは区間の推定到着時間。 時刻は UTC です。
batteryConsumptionInkWh

number

電力消費量モデルを使用したキロワット時 (kWh) の推定電力消費量。 vehicleEngineType が電気に設定され、constantSpeedConsumptionInkWhPerHundredkm が指定されている場合に含まれます。 batteryConsumptionInkWh の値には再計算された電気エネルギーが含まれているため、負の値 (エネルギーの増加を示します) にすることができます。 maxChargeInkWh と currentChargeInkWh の両方を指定すると、バッテリの充電レベルが maxChargeInkWh を超えないようにするために、再循環が制限されます。 maxChargeInkWh も currentChargeInkWh も指定されていない場合、従量課金の計算では制約のない回復が想定されます。
departureTime

string

ルートまたは区間の推定出発時刻。 時刻は UTC です。
fuelConsumptionInLiters

number

燃焼消費モデルを使用した推定燃料消費量 (リットル単位)。 vehicleEngineType が 燃焼 に設定され、constantSpeedConsumptionInLitersPerHundredkm が指定されている場合に含まれます。 値は負以外になります。
historicTrafficTravelTimeInSeconds

integer

時間依存の履歴トラフィック データを使用して計算された推定移動時間。 computeTravelTimeFor = all がクエリで使用されている場合にのみ含まれます。
lengthInMeters

integer

Length In Meters プロパティ
liveTrafficIncidentsTravelTimeInSeconds

integer

リアルタイム速度データを使用して計算された推定移動時間。 computeTravelTimeFor = all がクエリで使用されている場合にのみ含まれます。
noTrafficTravelTimeInSeconds

integer

交通状況 (輻輳など) により、ルートに遅延がないかのように計算された推定移動時間。 computeTravelTimeFor = all がクエリで使用されている場合にのみ含まれます。
trafficDelayInSeconds

integer

トラフィック情報に従ってリアルタイム インシデントによって引き起こされる推定遅延 (秒単位)。 今後出発時刻が予定されているルートの場合、遅延は常に 0 です。 さまざまな種類の交通情報を使用して追加の移動時間を返すには、パラメーター computeTravelTimeFor=all を追加する必要があります。
travelTimeInSeconds

integer

リアルタイム トラフィックによる遅延を含む推定移動時間 (秒) プロパティ。 traffic=false travelTimeInSeconds の場合でも、トラフィックによる遅延が含まれていることに注意してください。 DepartAt が将来の場合、移動時間は時間に依存する履歴トラフィック データを使用して計算されます。

RouteOptimizedWaypoint

最適化されたウェイ ポイント オブジェクト。

名前 型 説明
optimizedIndex

integer

システムからの最適化されたウェイ ポイント インデックス。
providedIndex

integer

ユーザーによって提供されるウェイ ポイント インデックス。

RouteReport

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

名前 型 説明
effectiveSettings

EffectiveSetting[]

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

RouteRepresentationForBestOrder

応答として提供されるルートのセットの表現を指定します。 このパラメーター値は、computeBestOrder=true と組み合わせてのみ使用できます。

名前 型 説明
none

string

最適化されたウェイポイント インデックスのみが含まれますが、応答にルート ジオメトリは含まれません。
polyline

string

応答にルート ジオメトリが含まれます。
summaryOnly

string

ポリラインに従って要約しますが、応答のルートのポイント ジオメトリ要素を除外します。

RouteSection

ルート セクションには、ルートの一部に関する追加情報が含まれています。 各セクションには、少なくとも 要素 startPointIndex、、 endPointIndexおよび sectionTypeが含まれています。

名前 型 説明
delayInSeconds

integer

インシデントによって発生した遅延 (秒単位)。
effectiveSpeedInKmh

integer

インシデントの有効速度 (km/h) は、その全体の長さにわたって平均化されています。
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 を含め、要素を引き起こすことができます。

名前 型 説明
causes

RouteSectionTecCause[]

配列の原因
effectCode

integer

トラフィック フローへの影響。 TPEG2-TEC 標準で定義されている tec001:EffectCode テーブルの値を格納します。 重要度に応じてトラフィック イベントを色分けするために使用できます。

RouteSectionTecCause

トラフィック イベントの原因。 mainCauseCode 要素と subCauseCode 要素を含めることができます。 アイコンと説明を定義するために使用できます。

名前 型 説明
mainCauseCode

integer

トラフィック イベントのメイン原因。 TPEG2-TEC 標準で定義されているように、tec002:CauseCode テーブルの値を格納します。
subCauseCode

integer

トラフィック イベントのサブユース。 TPEG2-TEC 標準で定義されている mainCauseCode によって定義されたサブ原因テーブルの値を格納します。

RouteSummary

Summary オブジェクト

名前 型 説明
arrivalTime

string

ルートまたは区間の推定到着時間。 時刻は UTC です。
departureTime

string

ルートまたは区間の推定出発時刻。 時刻は UTC です。
lengthInMeters

integer

Length In Meters プロパティ
trafficDelayInSeconds

integer

トラフィック情報に従ってリアルタイム インシデントによって引き起こされる推定遅延 (秒単位)。 今後出発時刻が予定されているルートの場合、遅延は常に 0 です。 さまざまな種類の交通情報を使用して追加の移動時間を返すには、パラメーター computeTravelTimeFor=all を追加する必要があります。
travelTimeInSeconds

integer

リアルタイム トラフィックによる遅延を含む推定移動時間 (秒) プロパティ。 traffic=false travelTimeInSeconds の場合でも、トラフィックによる遅延が含まれていることに注意してください。 DepartAt が将来の場合、移動時間は時間に依存する履歴トラフィック データを使用して計算されます。

RouteType

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

名前 型 説明
eco

string

経済とスピードでバランスの取れたルート。
fastest

string

最速のルート。
shortest

string

距離別の最短ルート。
thrilling

string

興味深いまたは困難な道路が含まれており、できるだけ少ない高速道路を使用します。 含まれるターンのレベルと、ヒルネスの度合いを選択できます。 これを設定する方法については、丘陵性と巻き上げ性のパラメーターを参照してください。 =スリル満点で計画された routeTypeルートには900kmの制限があります

SectionType

ルート応答で報告されるセクションの種類を指定します。

たとえば、sectionType = 歩行者の場合、歩行者のみに適したセクションが返されます。 複数の型を使用できます。 既定の sectionType は、travelMode 入力を参照します。 既定では、travelMode は car に設定されています

名前 型 説明
carTrain

string

車または列車であるルートのセクション。
carpool

string

カープール(HOV/高占有車)レーンの使用を必要とするルートのセクション。
country

string

ルートが含まれる国/地域を示すセクション。
ferry

string

フェリーであるルートのセクション。
motorway

string

高速道路であるルートのセクション。
pedestrian

string

歩行者にのみ適したルートのセクション。
tollRoad

string

料金を支払う必要があるルートのセクション。
tollVignette

string

有料ビネットが存在する必要があるルートのセクション。
traffic

string

トラフィック情報を含むルートのセクション。
travelMode

string

要求パラメーター travelModeに関連するセクション。
tunnel

string

トンネルであるルートのセクション。
urban

string

都市部内に位置するルートのセクション。

SimpleCategory

インシデントの種類。 現在、JAM、ROAD_WORK、ROAD_CLOSURE、またはその他にすることができます。 詳細については、「tec」を参照してください。

名前 型 説明
JAM

string

交通渋滞。
OTHER

string

その他。
ROAD_CLOSURE

string

道路閉鎖。
ROAD_WORK

string

道路工事。

TravelMode

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

名前 型 説明
bicycle

string

返されるルートは、自転車レーンの使用を含め、自転車用に最適化されています。
bus

string

返されるルートは、バス専用レーンの使用を含め、バス用に最適化されています。 BETA 機能。
car

string

返されるルートは、車用に最適化されています。
motorcycle

string

返されるルートはオートバイ用に最適化されています。 BETA 機能。
pedestrian

string

返されるルートは、歩道の使用を含め、歩行者向けに最適化されています。
taxi

string

返されるルートはタクシー用に最適化されています。 BETA 機能。
truck

string

返されるルートは、トラックなどの商用車用に最適化されています。
van

string

返されるルートはバン用に最適化されています。 BETA 機能。

VehicleEngineType

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

名前 型 説明
combustion

string

内燃機関。
electric

string

電気エンジン。

VehicleLoadType

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

名前 型 説明
USHazmatClass1

string

火薬類
USHazmatClass2

string

圧縮ガス
USHazmatClass3

string

引火性液体
USHazmatClass4

string

引火性固体
USHazmatClass5

string

酸化 剤
USHazmatClass6

string

毒
USHazmatClass7

string

放射性物質
USHazmatClass8

string

腐食性
USHazmatClass9

string

その他
otherHazmatExplosive

string

火薬類
otherHazmatGeneral

string

その他
otherHazmatHarmfulToWater

string

水に害を

WindingnessLevel

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

名前 型 説明
high

string

high
low

string

low
normal

string

普通