RouteRequestRouteMatrixSyncQueryParamProperties interface
プロパティ
arrive |
例:
|
avoid | ルートを決定するときに、ルートの計算で回避する必要がある何かを指定します。 1 つの要求で複数回指定できます。たとえば、'&avoid=高速道路&avoid=tollRoads&avoid=ferrys' です。 ルート範囲要求では、値 alreadyUsedRoads を使用しないでください。 |
compute |
さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。 |
depart |
例:
|
hilliness | スリル満点のルートのためのヒルネスの程度。 このパラメーターは、 |
route |
要求されたルートの種類。 |
section |
ルート応答で報告されるセクションの種類を指定します。 |
traffic | 使用可能な値:
|
travel |
要求されたルートの移動モード。 定義されていない場合、既定値は 'car' です。 要求された travelMode は、ルート全体で使用できない場合があることに注意してください。 要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。 バス、オートバイ、タクシー、バンの移動モードはベータ機能であることに注意してください。 すべての領域で完全な制限データを使用できるわけではありません。 |
vehicle |
車両の車軸あたりの重量 (kg)。 値が 0 の場合、車軸あたりの重量制限は考慮されません。 |
vehicle |
車両の高さ (メートル単位)。 値が 0 の場合、高さの制限は考慮されません。 |
vehicle |
車両の長さ (メートル単位)。 値 0 は、長さの制限が考慮されないことを意味します。 |
vehicle |
危険物として分類され、一部の道路から制限される可能性のある貨物の種類。 使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国/地域で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国/地域には otherHazmat を使用する必要があります。 vehicleLoadType は複数回指定できます。 このパラメーターは現在、travelMode=truck に対してのみ考慮されます。 |
vehicle |
km/時間での車両の最高速度。 車両プロファイルの最大速度は、高速道路で車両が許可されているかどうかを確認するために使用されます。
|
vehicle |
車両の重量 (キロ単位)。 |
vehicle |
車両の幅 (メートル単位)。 値が 0 の場合、幅の制限は考慮されません。 |
wait |
要求を同期的に実行するかどうかを示すブール値。 true に設定すると、要求が 120 秒以内に完了した場合、ユーザーは 200 応答を受け取ります。 それ以外の場合、ユーザーはすぐに 202 応答を受け取ります。 202 応答の詳細については、API の説明を参照してください。 非同期要求でのみサポートされます。 |
windingness | スリル満点のルートのターンのレベル。 このパラメーターは、 |
プロパティの詳細
arriveAt
dateTime
で定義されている 値として書式設定された宛先ポイントへの到着日時(省略可能なタイム ゾーン オフセット付き)。 タイム ゾーン オフセットが指定されていない場合は、ターゲット ポイントのオフセットと見なされます。
例:
- 2023-12-19T16:39:57
- 2023-12-19T16:39:57-08:00
arriveAt
パラメーターは、departAt
、minDeviationDistance
、または minDeviationTime
と組み合わせて使用することはできません。
arriveAt?: string | Date
プロパティ値
string | Date
avoid
ルートを決定するときに、ルートの計算で回避する必要がある何かを指定します。 1 つの要求で複数回指定できます。たとえば、'&avoid=高速道路&avoid=tollRoads&avoid=ferrys' です。 ルート範囲要求では、値 alreadyUsedRoads を使用しないでください。
avoid?: ("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]
プロパティ値
("tollRoads" | "motorways" | "ferries" | "unpavedRoads" | "carpools" | "alreadyUsedRoads" | "borderCrossings")[]
computeTravelTimeFor
さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。
computeTravelTimeFor?: "none" | "all"
プロパティ値
"none" | "all"
departAt
dateTime
で定義されている 値として書式設定された出発地からの出発日時。タイム ゾーン オフセットは省略可能です。 タイム ゾーン オフセットが指定されていない場合は、原点のオフセットと見なされます。
- 既定値: 今すぐ
- その他の値:
dateTime
例:
- 2023-12-19T16:39:57
- 2023-12-19T16:39:57-08:00
departAt
パラメーターは、arriveAt
と組み合わせて使用することはできません。
departAt?: string | Date
プロパティ値
string | Date
hilliness
スリル満点のルートのためのヒルネスの程度。 このパラメーターは、routeType
=thrilling と組み合わせてのみ使用できます。
hilliness?: "low" | "normal" | "high"
プロパティ値
"low" | "normal" | "high"
routeType
要求されたルートの種類。
routeType?: "fastest" | "shortest" | "eco" | "thrilling"
プロパティ値
"fastest" | "shortest" | "eco" | "thrilling"
sectionType
ルート応答で報告されるセクションの種類を指定します。
たとえば、sectionType = 歩行者の場合、歩行者のみに適したセクションが返されます。 '§ionType=carTrain§ionType=歩行者§ionType=高速道路' など、1 つの要求で複数回指定できます。 既定の sectionType は travelMode 入力を参照します。 既定では、travelMode は car に設定されています
sectionType?: ("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]
プロパティ値
("carTrain" | "country" | "ferry" | "motorway" | "pedestrian" | "tollRoad" | "tollVignette" | "traffic" | "travelMode" | "tunnel" | "carpool" | "urban")[]
traffic
使用可能な値:
- true - ルーティング中に使用可能なすべてのトラフィック情報を考慮してください
- false - ルーティング中に現在のトラフィック データを無視します。 現在の交通データはルーティング中は無視されますが、有効な道路速度に対する履歴トラフィックの影響は引き続き組み込まれていることに注意してください。
traffic?: boolean
プロパティ値
boolean
travelMode
要求されたルートの移動モード。 定義されていない場合、既定値は 'car' です。 要求された travelMode は、ルート全体で使用できない場合があることに注意してください。 要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。 バス、オートバイ、タクシー、バンの移動モードはベータ機能であることに注意してください。 すべての領域で完全な制限データを使用できるわけではありません。
travelMode?: "pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"
プロパティ値
"pedestrian" | "car" | "truck" | "taxi" | "bus" | "van" | "motorcycle" | "bicycle"
vehicleAxleWeight
車両の車軸あたりの重量 (kg)。 値が 0 の場合、車軸あたりの重量制限は考慮されません。
vehicleAxleWeight?: number
プロパティ値
number
vehicleHeight
車両の高さ (メートル単位)。 値が 0 の場合、高さの制限は考慮されません。
vehicleHeight?: number
プロパティ値
number
vehicleLength
車両の長さ (メートル単位)。 値 0 は、長さの制限が考慮されないことを意味します。
vehicleLength?: number
プロパティ値
number
vehicleLoadType
危険物として分類され、一部の道路から制限される可能性のある貨物の種類。 使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国/地域で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国/地域には otherHazmat を使用する必要があります。 vehicleLoadType は複数回指定できます。 このパラメーターは現在、travelMode=truck に対してのみ考慮されます。
vehicleLoadType?: "USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"
プロパティ値
"USHazmatClass1" | "USHazmatClass2" | "USHazmatClass3" | "USHazmatClass4" | "USHazmatClass5" | "USHazmatClass6" | "USHazmatClass7" | "USHazmatClass8" | "USHazmatClass9" | "otherHazmatExplosive" | "otherHazmatGeneral" | "otherHazmatHarmfulToWater"
vehicleMaxSpeed
km/時間での車両の最高速度。 車両プロファイルの最大速度は、高速道路で車両が許可されているかどうかを確認するために使用されます。
値が 0 の場合は、車両に適した値が決定され、ルート計画中に適用されることを意味します。
ルート計画中に 0 以外の値がオーバーライドされる場合があります。 たとえば、現在のトラフィック フローは 60 km/時間です。 車両の最高速度が 50 km/時に設定されている場合、現在の状況であるため、ルーティング エンジンは 60 km/時間を考慮します。 車両の最高速度が 80 km/時間として提供されているが、現在の交通フローが 60 km/時間の場合、ルーティング エンジンは再び 60 km/時間を使用します。
vehicleMaxSpeed?: number
プロパティ値
number
vehicleWeight
車両の重量 (キロ単位)。
vehicleWeight?: number
プロパティ値
number
vehicleWidth
車両の幅 (メートル単位)。 値が 0 の場合、幅の制限は考慮されません。
vehicleWidth?: number
プロパティ値
number
waitForResults
要求を同期的に実行するかどうかを示すブール値。 true に設定すると、要求が 120 秒以内に完了した場合、ユーザーは 200 応答を受け取ります。 それ以外の場合、ユーザーはすぐに 202 応答を受け取ります。 202 応答の詳細については、API の説明を参照してください。 非同期要求でのみサポートされます。
waitForResults?: boolean
プロパティ値
boolean
windingness
スリル満点のルートのターンのレベル。 このパラメーターは、routeType
=thrilling と組み合わせてのみ使用できます。
windingness?: "low" | "normal" | "high"
プロパティ値
"low" | "normal" | "high"
Azure SDK for JavaScript