道順 API | API Docs

道順 API バージョン

このドキュメントは道順 API の v5 バージョンに対応しています。以前のバージョンについては、v4 ドキュメントもしくはチェンジログを参照してください。

Mapbox 道順 API は目的地までの行き方を示します。道順 API を使用すると以下のことができます:

交通とインシデントを考慮したルーティングで、運転、歩行、自転車の最適なルートを計算
ターンバイターンの指示を生成
driving、driving-traffic、walking、cyclingプロファイルで最大25座標のルートを生成
電気自動車が最適な充電停止とバッテリー予測を伴って目的地に到達するためのルートを計算

PLAYGROUND

道順 API プレイグラウンド

ウェイポイント間の道順を取得し、地図上で結果を表示します。

TUTORIAL

道順 API チュートリアル

道順 API に関連するすべてのチュートリアルを見るには、チュートリアルページの製品フィルタを使用してください。

ルーティングプロファイル

道順 API は異なる 4 種類のルーティングプロファイルをサポートします:

プロファイル	説明
`mapbox/driving-traffic`	自動車のルーティング用。このプロファイルは現在および過去の交通状況を考慮して遅延を避けます。サポートされている地理情報については、交通データページを参照してください。このプロファイルを使用するリクエストは最大 25 座標を受け入れます。
`mapbox/driving`	自動車のルーティング用。このプロファイルは高速道路などの高速道路を優先して最速のルートを表示します。このプロファイルを使用するリクエストは最大 25 座標を受け入れます。
`mapbox/walking`	歩行者およびハイキングのルーティング用。このプロファイルは歩道やトレイルを使用して最短パスを表示します。このプロファイルを使用するリクエストは最大 25 座標を受け入れます。
`mapbox/cycling`	自転車のルーティング用。このプロファイルは短くて安全なルートを示し、高速道路を避け、自転車レーンのある道路を優先します。このプロファイルを使用するリクエストは最大 25 座標を受け入れます。

道順を取得する

get

https://api.mapbox.com/directions/v5/{profile}/{coordinates}

必須パラメータ

ウェイポイント間の道順を取得します。道順リクエストには、少なくとも 2 つのウェイポイントを開始点および終了点として指定する必要があります。

必須パラメータ	種類	説明
`profile`	`string`	使用するルーティングプロファイル。可能な値は `mapbox/driving-traffic`、`mapbox/driving`、`mapbox/walking`、または `mapbox/cycling` です。
`coordinates`	`number`	訪れる順序で 2 から 25 の `{経度},{緯度}` 座標ペアのセミコロン区切りのリスト。

任意パラメータ

次の任意パラメータを使用して、このエンドポイントからの結果をさらに細かく指定できます:

任意パラメータ種類説明

alternatives boolean 代替ルートを返すか (true)、返さないか (false、デフォルト)。代替ルートは、最速のルートとは大きく異なりますが、時間的にはまだ近いルートです。こうしたルートはすべての状況で存在するわけではありません。最大 2 つの代替ルートが返されることがあります。これは mapbox/driving-traffic、mapbox/driving、mapbox/cycling および mapbox/walking に使用できます。

annotations

string

ルートに沿った追加のメタデータを返します。カンマ区切りのリストとして複数の注釈を含めることができます。 overview=full と組み合わせて使用する必要があります。

可能な値	説明
`distance`	各座標ペア間の距離 (メートル)。
`duration`	各座標ペア間の時間 (秒)。
`speed`	各座標ペア間の速度 (メートル/秒)。
`congestion`	ルート区切りの各座標ペアの配列内の渋滞レベル。この注釈は `mapbox/driving-traffic` プロファイルでのみ利用可能です。
`congestion_numeric`	ルート区切りの各座標ペアの配列内の渋滞数値レベル。この注釈は `mapbox/driving-traffic` プロファイルでのみ利用可能です。
`maxspeed` BETA	区間の座標間の最高速度制限。この注釈は `mapbox/driving` および `mapbox/driving-traffic` プロファイルでのみ利用可能です。
`closure`	ルートに沿って発生したライブトラフィック関連の閉鎖を記述する閉鎖オブジェクトの配列。この注釈は `mapbox/driving-traffic` プロファイルでのみ利用可能です。
`state_of_charge` BETA	バッテリーの最大容量に対する現在の充電状態 (% 単位)。値が負の場合、充電不足を意味します。正の値はバッテリーの充電レベルを示します。

注釈に含まれる内容の詳細についてはルート区切りオブジェクトを参照してください。

avoid_maneuver_radius number API が重大な操作を返さないように開始点の周囲に半径を追加します。可能な値は 1 から 1000 メートルの範囲です。再ルーティング時に重大な操作を避けるため、車両がかなりの速度で移動している場合にこのオプションを使用します。指定された値を使用してルートが見つからない場合は無視されます。大きな半径が使用される場合、API は重要なターンを無視し、最初の操作前に長い直線パスを返すことがあります。avoid_maneuver_radius パラメータは、arrive_by=<時間> または depart_at=<時間> オプションと一緒に使用できません。これらのモードはリアルタイムルーティング用ではなく、参照リクエスト用だからです。しかし、depart_at=now オプションは使用できます。これは mapbox/driving-traffic および mapbox/driving に対応しています。

bearings integer ウェイポイントからのルートの開始方向に影響を与えます。方向によってウェイポイントが配置される道路のセグメントをフィルタリングするために使用されます。再ルーティングされた車両の新しいルートが現在の方向で継続するようにするために役立ちます。この操作を行うリクエストでは、最初のウェイポイントの方向と範囲の値を提供し、残りの値を空のままにします。各ウェイポイントに対して時計回りに真北から 0 から 360 までの角度、および角度が偏れる度数の範囲 (推奨値は45° または 90°) をカンマ区切りで指定します。形式は {angle, degrees} です。提供された場合、方向のリストは座標のリストと同じ長さでなければなりません。ただし、座標をスキップして ; セパレータを使用してその位置をリストに示すことができます。

layers integer ウェイポイントからのルート開始のレイヤーに影響を与えます。Z 順に、ウェイポイントが配置される道路セグメントをフィルタリングするために使用されます。例えば、道路の下のトンネルのように、複数レベルの道路の場合のあいまいさを避けるために役立ちます。各ウェイポイントに 1 つの符号付き整数を指定します。提供された場合、レイヤーのリストは座標のリストと同じ長さでなければなりません。ただし、座標をスキップしてその位置を ; セパレータでリストに示すことができます。 Mapbox Streets v8 の layer フィールドに対応します。レイヤーが見つからない場合、API は他の提供されたパラメータに従って適切なレイヤーを選択します。

continue_straight boolean 中間ウェイポイントから出発する際の走行方向を設定します。true の場合、ルートは同じ走行方向に続きます。false の場合、ルートは走行方向の反対方向に続くことがあります。デフォルトは mapbox/driving では true であり、mapbox/walking および mapbox/cycling では false です。

exclude

string

ルーティングから特定の道路タイプやカスタムロケーションを除外します。デフォルトでは、以下のリストのいかなる項目も除外しないことです。カンマ区切りのリストとして複数の値を指定できます。利用可能な除外値は次の通りです:

可能な値	説明
`motorway`	ハイウェイや高速道路を除外します。`mapbox/driving` および `mapbox/driving-traffic` プロファイルで利用可能です。
`toll`	通行料のかかる道路を除外します。`mapbox/driving` および `mapbox/driving-traffic` プロファイルで利用可能です。
`ferry`	水路を渡るフェリーを除外します。`mapbox/driving`、`mapbox/driving-traffic`、`mapbox/cycling` および `mapbox/walking` プロファイルで利用可能です。
`unpaved`	未舗装道路を除外します。`mapbox/driving` および `mapbox/driving-traffic` プロファイルで利用可能です。
`cash_only_tolls`	現金のみ受け付ける有料道路を除外します。`mapbox/driving`、`mapbox/driving-traffic`、`mapbox/walking` および `mapbox/cycling` プロファイルで利用可能です。
`point(longitude latitude)` BETA	危険な出入り口、橋、トンネル、低品質の道路や国境道路などのカスタムロケーションを除外します。WKT 形式で指定された座標は最も近い道路にスナップされ、スナップされた座標はルーティングから除外されます。複数の座標をカンマ区切りのリストとして指定できます。例えば `point(lon1 lat1)、point(lon2 lat2)`。各 API リクエストあたり最大 50 ポイントまでです。`mapbox/driving` および `mapbox/driving-traffic` プロファイルで利用可能です。
`country_border` BETA	国境を除外します (ISO3166-1 標準を参照 ISO3166-1 standard)。`mapbox/driving` および `mapbox/driving-traffic` プロファイルで利用可能です。
`state_border` BETA	州境を除外します (ISO3166-2 標準を参照 ISO3166-2 standard)。`mapbox/driving` および `mapbox/driving-traffic` プロファイルで利用可能です。

geometries string 返されたジオメトリの形式です。許可される値は次の通りです: geojson (LineString として)、polyline (デフォルト、5 桁の小数点精度を持つポリライン)、polyline6 (6 桁の小数点精度を持つポリライン)。

include

string

ルーティングのために特定の追加の道路タイプを含めます。デフォルトではこれらの道路タイプが含まれません。カンマ区切りのリストとして複数の値を指定できます。利用可能な含める値は次の通りです:

可能な値	説明
`hov2`	最低 2 人の乗車定員を要する道路タイプ。`mapbox/driving` および `mapbox/driving-traffic` プロファイルで利用可能です。
`hov3`	最低 3 人の乗車定員を要する道路タイプ。`mapbox/driving` および `mapbox/driving-traffic` プロファイルで利用可能です。
`hot`	乗車定員の要件を満たしていない場合、料金が発生する高占有料金道路。`mapbox/driving` および `mapbox/driving-traffic` プロファイルで利用可能です。

overview string リクエストされたタイプの概要ジオメトリを表示します。full (最も詳細なジオメトリ)、simplified (デフォルト、fullジオメトリの簡略版)、または false (概要ジオメトリなし) が可能です。

radiuses number または string 座標が道路ネットワークにスナップする最大距離 (メートル) です。リクエストの座標と同じ数の半径を ; で区切って指定する必要があります。値は 0 より大きい任意の数値または unlimited です。ルート化可能な道路が半径内に見つからない場合、NoSegment エラーが返されます。

approaches string リクエストされたルートでのウェイポイントに接近する道路側を示す ; 区切りリストを指定します。unrestricted (デフォルト、ルートは道路のどちら側からでもウェイポイントに到達できる) または curb (ルートは地域の driving_side に基づいてウェイポイントに到達する) を許可します。提供された場合、アプローチの数はウェイポイントの数と同じでなければなりません。ただし、座標をスキップしてリストの位置を ; 区切りで示すことができます。ウェイポイントが道路から 1 メートル以内の場合、このパラメータは無視されます。

steps boolean ステップとターンバイターンの指示 (true) を返すか、返さないか (false、デフォルト)。 steps を true に設定すると、次のガイダンス関連パラメータが使用可能になります: banner_instructions、language、roundabout_exits、voice_instructions、voice_units、waypoint_names、waypoint_targets および waypoints。

banner_instructions boolean ルートステップに関連するバナーオブジェクト (true) を返すか、返さないか (false、デフォルト)。steps=true と組み合わせて使用する必要があります。

language string ターンバイターンテキスト指示の言語。このサポートされている言語を参照してください。デフォルトは en (英語) です。steps=true と組み合わせて使用する必要があります。

roundabout_exits boolean ロータリー出口での指示 (true) を生成するか、返さないか (false、デフォルト)。このパラメータがない場合、ロータリーマヌーバーは入り口と出口の指示を含む1つの指示として返されます。roundabout_exits=true の場合、このマヌーバーはロータリーに入るための1つの指示とロータリーから出るための1つの指示になります。steps=true と組み合わせて使用する必要があります。

voice_instructions boolean ルートに沿ったボイスガイダンスのテキスト (true) を返すか、返さないか (false、デフォルト)。steps=true と組み合わせて使用する必要があります。

voice_units string 音声指示のテキストで返す単位のタイプを指定します。imperial (デフォルト) または metric が可能です。steps=true および voice_instructions=true と組み合わせて使用する必要があります。

waypoints integer 入力座標をウェイポイントとして扱う必要があることを示す ; 区切りのリスト。ウェイポイントは返されるルートの各 leg の開始および終了地点を形成し、steps=true パラメータが使用されている場合、depart および arrive ステップに対応します。ウェイポイントのリストが提供されていない場合、すべての座標がウェイポイントとして扱われます。waypoints パラメータは、追加のレグおよび arrive/depart 指示を導入せずにルートの経路をガイドするために使用できます。steps=true と組み合わせて使用する必要があります。

waypoints_per_route boolean true の場合、ウェイポイント配列はルートオブジェクト内に返され、それ以外の場合はレスポンスボディのルートに返されます。指定されていない場合、デフォルトは false です。mapbox/driving、mapbox/driving-traffic および mapbox/walking プロファイルで利用可能です。
代替ルートの EV 最適化ルートを求める場合、各代替ルートが別々のウェイポイント (充電ステーション) セットを生成するため、waypoints_per_route を true に設定する必要があります。

waypoint_names string coordinates のリストのエントリ用のカスタム名の ; 区切りリスト。バナーおよび音声指示の到着指示に使用されます。値は任意の文字列で、すべての文字の合計は 500 を超えることはできません。提供された場合、waypoint_names のリストは waypoints のリストと同じ長さである必要がありますが、ウェイポイントの座標をスキップし、; 区切りリストでその位置を示すことができます。リストの最初の値はルートの起点に対応し、最初の目的地には対応していません。起点を無名のままにするには、リストをセミコロンで始めます。steps=true と組み合わせて使用する必要があります。

waypoint_targets number coordinates で指定されたロケーションとは異なるドロップオフロケーションを指定するための座標ペアの ; 区切りリスト。このパラメータが提供されている場合、Directions API は運転方向に基づいて、各ターゲットの道の側面 (左または右) を計算します。maneuver.modifier、バナーおよび音声指示は計算された道の側面で更新されます。waypoint_targets の数は waypoints の数と同じである必要がありますが、ウェイポイントの座標をスキップし、; 区切りリストでその位置を示すことができます。最初の値は評価されないため、リストをセミコロンで始めます。steps=true と組み合わせて使用する必要があります。

notifications

BETA

string

ルートオブジェクトのレグに関連する通知メタデータを返します。通知はアプリケーション内で警告や安全メッセージを表示する、もしくはルートについての重要なインサイトを提供するために役立ちます。mapbox/driving および mapbox/driving-traffic プロファイルで利用可能です。

可能な値	説明
`all`	すべての通知メタデータを含めます。
`none`	ルートメタデータに通知を提供しません。

デフォルトは all です。通知に含まれる内容の詳細については通知オブジェクトを参照してください。

`mapbox/walking` プロファイル用の任意パラメータ

任意 `v5/mapbox/walking` パラメータ	種類	説明
`walking_speed`	`number`	歩行速度 (メートル/秒)、最小の `0.14` m/s（もしくは `0.5` km/h）および最大の `6.94` m/s（もしくは `25.0` km/h）。デフォルトは `1.42` m/s（`5.1` km/h）。
`walkway_bias`	`number`	ルートがウォークウェイに対してバイアスされる度合いを `-1` から `1` の範囲でスケールします。`-1` はウォークウェイに対するバイアスを表し、`1`はウォークウェイに向かってバイアスをかけます。デフォルトは `0`（中立）。

クエリ文字列に認識されないオプションを含めると InvalidInput エラーが発生します。

`mapbox/driving` プロファイル用の任意パラメータ

任意 `v5/mapbox/driving` パラメータ	種類	説明
`alley_bias`	`number`	アレイに対してバイアスされる度合いを `-1` から `1` の範囲でスケールします。`-1` はアレイに対するバイアスを表し、`1` はアレイに向かってバイアスをかけます。デフォルトは `0`（中立）。
`arrive_by`	`string`	希望の到着時間を 3 つの ISO 8601 形式のいずれかでフォーマットします: `YYYY-MM-DDThh:mm:ssZ`、`YYYY-MM-DDThh:mmss±hh:mm`、または `YYYY-MM-DDThh:mm`。最後の形式では、タイムゾーンはルートの目的地から計算されます。`duration` に返される所要時間は、過去の旅行データに基づいた所要時間の予測です。ルートは時間依存的に計算されます。例えば、2 時間かかる旅行は、2 時間の間に変化する過去の交通状況を考慮します。ルートはリクエストされた到着時刻に基づいて制限されたターンや条件付きアクセス制限を考慮します。
`depart_at`	`string`	出発時間を 3 つの ISO 8601 形式のいずれかでフォーマットします: `YYYY-MM-DDThh:mm:ssZ`、`YYYY-MM-DDThh:mmss±hh:mm`、または `YYYY-MM-DDThh:mm`。最後の形式では、タイムゾーンはルートの出発地から計算されます。`duration` に返される所要時間は、過去の旅行データに基づいた所要時間の予測です。ルートは時間依存的に計算されます。例えば、2 時間かかる旅行は、指定された `depart_at` 時間だけでなく、2 時間の間に変化する交通状況を考慮します。ルートはリクエストされた出発時刻に基づいて制限されたターンや条件付きアクセス制限を考慮します。
`max_height`	`number`	車両の最大高さ (メートル)。このパラメータが提供されている場合、Directions API は車両の最大高さに等しいかそれ以上の高さ制限を持つ道路のみを含むルートを計算します。`max_height` は 0 から 10 メートルの範囲でなければなりません。デフォルト値は 1.6 メートルです。道路の高さ制限の適用範囲は地域によって異なる場合があります。
`max_width`	`number`	車両の最大幅 (メートル)。このパラメータが提供されている場合、Directions API は車両の最大幅に等しいかそれ以上の幅制限を持つ道路のみを含むルートを計算します。`max_width` は 0 から 10 メートルの範囲でなければなりません。デフォルト値は 1.9 メートルです。道路の幅制限の適用範囲は地域によって異なる場合があります。
`max_weight`	`number`	車両の最大重量 (メートルトン、1000 kg)。このパラメータが提供されている場合、Directions API は車両の最大重量に等しいかそれ以上の重量制限を持つ道路のみを含むルートを計算します。`max_weight` は 0 から 100 メートルトンの範囲でなければなりません。デフォルト値は 2.5 メートルトンです。道路の重量制限の適用範囲は地域によって異なる場合があります。

`mapbox/driving-traffic` プロファイル用の任意パラメータ

任意 `v5/mapbox/driving-traffic` パラメータ	種類	説明
`depart_at`	`string`	出発時間を 3 つの ISO 8601 形式のいずれかでフォーマットします: `YYYY-MM-DDThh:mm:ssZ`、`YYYY-MM-DDThh:mmss±hh:mm`、または `YYYY-MM-DDThh:mm`。最後の形式では、タイムゾーンはルートの出発地から計算されます。`duration` に返される所要時間は、過去の旅行データおよびライブトラフィックに基づいた所要時間の予測です。ライブトラフィックは、 `depart_at` の値が現在時刻に近い場合、穏やかに過去のデータと混ぜ合わされます。ルートはリクエストされた到着時刻に基づいて制限されたターンや条件付きアクセス制限を考慮します。
`snapping_include_closures`	`boolean`	座標位置を道路セグメントにスナップする際に影響を与えるブール値のセミコロン区切りリスト。`true` の場合、ライブトラフィック閉鎖による閉鎖された道路セグメントがスナップの対象となります。`false` の場合、スナップの対象となりません。提供された場合、 `snapping_include_closures` の数は座標の数と同じでなければなりません。ただし、座標をスキップしてリストの位置をセミコロン区切りで示すことができます。指定されていない場合、このパラメータのデフォルトは `false` です。
`snapping_include_static_closures`	`boolean`	座標位置を道路セグメントにスナップする際に影響を与えるブール値のセミコロン区切りリスト。`true` の場合、長期間の閉鎖道路セグメント (例えば、建設中の道路) がスナップの対象となります。`false` の場合、スナップの対象となりません。提供された場合、`snapping_include_static_closures` の数は座標の数と同じでなければなりません。ただし、座標をスキップしてリストの位置をセミコロン区切りで示すことができます。指定されていない場合、このパラメータのデフォルトは `false` です。
`max_height`	`number`	車両の最大高さ (メートル)。このパラメータが提供されている場合、Directions API は車両の最大高さに等しいかそれ以上の高さ制限を持つ道路のみを含むルートを計算します。`max_height` は 0 から 10 メートルの範囲でなければなりません。デフォルト値は 1.6 メートルです。道路の高さ制限の適用範囲は地域によって異なる場合があります。
`max_width`	`number`	車両の最大幅 (メートル)。このパラメータが提供されている場合、Directions API は車両の最大幅に等しいかそれ以上の幅制限を持つ道路のみを含むルートを計算します。`max_width` は 0 から 10 メートルの範囲でなければなりません。デフォルト値は 1.9 メートルです。道路の幅制限の適用範囲は地域によって異なる場合があります。
`max_weight`	`number`	車両の最大重量 (メートルトン、1000 kg)。このパラメータが提供されている場合、Directions API は車両の最大重量に等しいかそれ以上の重量制限を持つ道路のみを含むルートを計算します。`max_weight` は 0 から 100 メートルトンの範囲でなければなりません。デフォルト値は 2.5 メートルトンです。道路の重量制限の適用範囲は地域によって異なる場合があります。

サンプルリクエスト: 道順を取得する

# 追加オプションなしで道順をリクエスト

$ curl "https://api.mapbox.com/directions/v5/mapbox/cycling/-122.42,37.78;-77.03,38.91?access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# maxspeed annotation を使用して速度制限情報にアクセスするためのリクエスト
$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/-122.39636,37.79129;-122.39732,37.79283;-122.39606,37.79349?annotations=maxspeed&overview=full&geometries=geojson&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# 複数のウェイポイントを介して radiuses パラメータと polyline6 形式でのレスポンスを指定したリクエスト

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.42,52.5;13.41,52.5?radiuses=40;;100&geometries=polyline6&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# bearings と radiuses を指定するリクエスト

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.42,52.5;13.43,52.5?bearings=60,45;;45,45&radiuses=100;100;100&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# 複数レベルの道路のあいまいさを処理するためにレイヤーをウェイポイントに割り当てるリクエスト

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.42,52.5;13.43,52.5?layers=-1;;3&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# 運転側の縁石にアプローチするルートをリクエストする

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.43,52.5?approaches=unrestricted;curb&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# voice と banner の指示で waypoint_names を指定する道順をリクエストする

$ curl "https://api.mapbox.com/directions/v5/mapbox/cycling/-122.42,37.78;-77.03,38.91?steps=true&voice_instructions=true&banner_instructions=true&voice_units=imperial&waypoint_names=Home;Work&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# waypoints を指定するリクエスト

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/13.43,52.51;13.42,52.5;13.43,52.5?waypoints=0;2&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

# 出発時間を指定するリクエスト

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/-122.396112,37.791399;-122.433904,37.757812?access_token=YOUR_MAPBOX_ACCESS_TOKEN&depart_at=2019-05-02T15:00"

サポートされているライブラリ：道順を取得する

Mapbox ラッパーライブラリは、既存のアプリケーションに Mapbox API を統合するのに役立ちます。次の SDK はこのエンドポイントをサポートしています：

関連するメソッドを使用してこのエンドポイントをクエリする方法の詳細と例については、SDK ドキュメントを参照してください。

レスポンス：道順を取得する

Directions API リクエストへのレスポンスは、次のプロパティを含む JSON オブジェクトです：

プロパティ	種類	説明
`code`	`string`	レスポンスの状態を示すコードです。これは HTTP ステータスコードとは異なるコードです。通常の有効なレスポンスの場合、値は `Ok` になります。他のレスポンスについては、Directions API のエラーテーブルを参照してください。
`waypoints` LEGACY	`array`	ウェイポイントオブジェクトの配列です。各ウェイポイントは道路とパスネットワークにスナップされます。ウェイポイントは入力座標の順序で配列に表示されます。 📌 非推奨通知 root レスポンスでのウェイポイントのプロパティの位置は非推奨となりました。これを使用し続けることができますが、そのまま機能します。デフォルト構造のまま (`waypoints_per_route=false`) です。代替ルートの EV 最適化ルートを求める場合、`waypoints_per_route=true` パラメータを追加して新しいウェイポイントのレスポンスをリクエストしてください。この新しい `waypoints_per_route` パラメータについては、任意パラメータで確認し、新しいルートの `waypoints` オブジェクト内に含まれる新しい `waypoints` を参照してください。
`routes`	`array`	注文の推奨ランク順に並べられたルートオブジェクトの配列です。レスポンスオブジェクトには最大で 2 つのルートが含まれることがあります。
`uuid`	`string`	成功したルートのレスポンスを参照するために使用できる一意の識別子です。`uuid` と `routes` 配列内のインデックスの組み合わせでルートを一意に識別します。

サンプルレスポンス：道順を取得する

新 waypoints_per_route=true

{
  "routes": [
    {
      "geometry": "mnn_Ick}pAfBiF`CzA",
      "waypoints": [ // このルート固有のウェイポイント配列
        { // 通常のユーザーが送信したウェイポイント (起点)。
          "name": "Köpenicker Straße",
          "location": [ 13.426579, 52.508068 ]
        },
        { // 通常のユーザーが送信したウェイポイント (目的地)。
          "name": "Engeldamm",
          "location": [ 13.427292, 52.506902 ]
        }
      ],
      "legs": [
        {
          "summary": "Köpenicker Straße, Engeldamm",
          "weight": 44.4,
          "duration": 26.2,
          "steps": [
            {
              "intersections": [
                {
                  "out": 0,
                  "entry": [ true ],
                  "bearings": [ 125 ],
                  "location": [ 13.426579, 52.508068 ]
                },
                {
                  "out": 1,
                  "in": 2,
                  "entry": [ true, true, false ],
                  "bearings": [ 30, 120, 300 ],
                  "location": [ 13.426688, 52.508022 ]
                }
              ],
              "driving_side": "右",
              "geometry": "mnn_Ick}pAHUlAqDNa@",
              "mode": "運転中",
              "maneuver": {
                "bearing_after": 125,
                "bearing_before": 0,
                "location": [ 13.426579, 52.508068 ],
                "modifier": "右",
                "type": "出発",
                "instruction": "Köpenicker Straße (L 1066) で南東へ進む"
              },
              "ref": "L 1066",
              "weight": 35.9,
              "duration": 17.7,
              "name": "Köpenicker Straße (L 1066)",
              "distance": 98.1,
              "voiceInstructions": [
                {
                  "distanceAlongGeometry": 98.1,
                  "announcement": "Köpenicker Straße (L 1066) で南東へ進み、次に Engeldamm で右折",
                  "ssmlAnnouncement": "<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">Köpenicker Straße (L <say-as interpret-as=\"address\">1066</say-as>) で南東へ進み、次に Engeldamm で右折</prosody></amazon:effect></speak>"
                },
                {
                  "distanceAlongGeometry": 83.1,
                  "announcement": "Engeldamm で右折し、次に目的地に到着します",
                  "ssmlAnnouncement": "<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">Engeldamm で右折し、次に目的地に到着します</prosody></amazon:effect></speak>"
                }
              ],
              "bannerInstructions": [
                {
                  "distanceAlongGeometry": 98.1,
                  "primary": {
                    "text": "Engeldamm",
                    "components": [ { "text": "Engeldamm" } ],
                    "type": "右折",
                    "modifier": "右"
                  },
                  "secondary": null,
                  "sub": null
                }
              ]
            },
            {
              "intersections": [
                {
                  "out": 2,
                  "in": 3,
                  "entry": [ false, true, true, false ],
                  "bearings": [ 30, 120, 210, 300 ],
                  "location": [ 13.427752, 52.50755 ]
                }
              ],
              "driving_side": "右",
              "geometry": "ekn_Imr}pARL\\T^RHDd@\\",
              "mode": "運転中",
              "maneuver": {
                "bearing_after": 202,
                "bearing_before": 125,
                "location": [ 13.427752, 52.50755 ],
                "modifier": "右",
                "type": "右折",
                "instruction": "Engeldamm で右折"
              },
              "weight": 8.5,
              "duration": 8.5,
              "name": "Engeldamm",
              "distance": 78.6,
              "voiceInstructions": [
                {
                  "distanceAlongGeometry": 27.7,
                  "announcement": "目的地に到着しました",
                  "ssmlAnnouncement": "<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">目的地に到着しました</prosody></amazon:effect></speak>"
                }
              ],
              "bannerInstructions": [
                {
                  "distanceAlongGeometry": 78.6,
                  "primary": {
                    "text": "目的地に到着します",
                    "components": [ { "text": "目的地に到着します" } ],
                    "type": "到着",
                    "modifier": "直進"
                  },
                  "secondary": {
                    "text": "Engeldamm",
                    "components": [ { "text": "Engeldamm" } ],
                    "type": "到着",
                    "modifier": "直進"
                  }
                },
                {
                  "distanceAlongGeometry": 15,
                  "primary": {
                    "text": "目的地に到着しました",
                    "components": [ { "text": "目的地に到着しました" } ],
                    "type": "到着",
                    "modifier": "直進"
                  },
                  "secondary": {
                    "text": "Engeldamm",
                    "components": [ { "text": "Engeldamm" } ]
                  }
                }
              ]
            },
            {
              "intersections": [
                {
                  "in": 0,
                  "entry": [ true ],
                  "bearings": [ 25 ],
                  "location": [ 13.427292, 52.506902 ]
                }
              ],
              "driving_side": "右",
              "geometry": "cgn_Iqo}pA",
              "mode": "運転中",
              "maneuver": {
                "bearing_after": 0,
                "bearing_before": 205,
                "location": [ 13.427292, 52.506902 ],
                "type": "到着",
                "instruction": "目的地に到着しました"
              },
              "weight": 0,
              "duration": 0,
              "name": "Engeldamm",
              "distance": 0,
              "voiceInstructions": [ ],
              "bannerInstructions": [ ]
            }
          ],
          "distance": 176.7
        }
      ],
      "weight_name": "自動",
      "weight": 44.4,
      "duration": 26.2,
      "distance": 176.7
    },
    {  // 2つ目のルートオブジェクトまたは代替ルートであり、別のセットのウェイポイントを持つ可能性があります
      "geometry": "mnn_Ick}pAfBiF`CzA",
      "waypoints": [ // このルート固有のウェイポイント配列
        { // 通常のユーザーが送信したウェイポイント (起点)。
          "name": "alt1_origin",
          "location": [ 13.426579, 52.508068 ]
        },
        { // 通常のユーザーが送信したウェイポイント (目的地)。
          "name": "alt1_destination",
          "location": [ 13.427292, 52.506902 ]
        }
      ],
      "legs": [
        { ... }
      ],
      "weight_name": "自動",
      "weight": 44.4,
      "duration": 26.2,
      "distance": 176.7
    }
  ],
  "code": "Ok",
  "uuid": "cjd51uqn5005447p8nte2zc4w"
}

旧 `waypoints_per_route=false` / デフォルト

{
  "routes": [
    {
      ...
    }
  ],
  "waypoints": [
    {
      "name": "Köpenicker Straße",
      "location": [ 13.426579, 52.508068 ]
    },
    {
      "name": "Engeldamm",
      "location": [ 13.427292, 52.506902 ]
    }
  ],
  "code": "Ok",
  "uuid": "cjd51uqn5005447p8nte2zc4w"
}

HTTP POST を使用して道順を取得する

Directions API では、HTTP POST メソッドを使用してアクセスすることもサポートしています。大量のリクエストには HTTP POST を使用する必要があります。Directions API は、GET リクエスト URL のサイズ制限が約 8100 バイトあるためです。POST リクエストもアカウントのリクエストサイズ制限の対象となります。

このプロセスの詳細については、HTTP POST の使用セクションを参照してください。

電気自動車ルーティング

EV ルーティングプライベートプレビュー

道順 API では、EV の旅の計画とルートに沿ったバッテリー予測を含む電気自動車 (EV) ルーティングをサポートしています。よりスマートで使いやすい EV を実現します。価格やプライベートプレビューにサインアップするには、EV セールスにお問い合わせください。

EV ルーティングは、充電が必要かどうかを自動的に識別し、必要に応じて充電停車を追加し、各停車の最適な充電時間と充電レベルを提供します。充電停車は、ルートレスポンスの追加メタデータ付きウェイポイントとして返されます。特定の範囲が充電ステーションに到達するために低すぎる場合など、充電停車なしで充電状態の注釈が 0% 未満になることもあります。電池の特性、車両の動力特性、およびユーザーの好みに応じて EV ルートをカスタマイズできます。EV ルーティングのためのパラメータについてを参照してください。

電気自動車ルーティングのためのパラメータ

EV ルーティングは、driving および driving-traffic プロファイルで利用できます。EV ルートをリクエストするには、パラメータ engine=electric を設定します。他のパラメータは、これが真のときのみ適用されます。EV ルーティングリクエストは、全体で最大 12 のウェイポイントを指定できます。もし ev_add_charging_stops が false に設定されている場合、EV ルーティングリクエストは最大 25 のウェイポイントを指定できます。

パラメータ種類説明

engine string 電気自動車ルーティングを有効にするために electric に設定します。このパラメータが指定されていない場合、ルーティングは非電気自動車のデフォルトに設定されます。

ev_initial_charge integer ルートの開始時点で車両の初期充電量 (Wh)。例えば、値が 10000 の場合、初期のバッテリーは 10 kWh です。デフォルト値は ev_max_charge に等しいです。

ev_max_charge integer 車両の最大充電量 (Wh)。例えば、値が 80000 の場合、バッテリー容量は 80 kWh です。

ev_connector_types

string

車両に対応するコネクタタイプを定義するためのパラメータ。ルーターはコネクタタイプに対応する充電ステーションを選択します。次のコネクタタイプがサポートされています:

可能な値	説明
`ccs_combo_type1`	DC 高速充電に対応する CCS J プラグ
`ccs_combo_type2`	DC 高速充電に対応する CCS メネケス
`tesla`	テスラ専用コネクタ
`chademo`	CHAdeMO 高速充電システム

energy_consumption_curve string 速度毎 (km/h) のキロメートル当たりの消費エネルギーをペアで指定するためのパラメータ。例えば、0,300;20,160;80,140;120,180 の値は、20 km/h 時の消費エネルギーが 160 Wh/km であることを示します。

ev_charging_curve string バッテリー充電レベル毎 (Wh) の最大充電速度 (W) をペアで指定するためのパラメータ。例えば、0,100000; 40000,70000; 60000,30000; 80000,10000 の値は、バッテリーが 40 kWh の充電レベルのとき、70 kW の充電を示します。充電カーブの充電レベルは 0 から最大充電レベルまで広がる必要があります。最初のエントリーの充電速度は、0 から最初のエントリーの充電レベルの間で一定であると見なされます。最後のエントリーの充電速度は、最後のエントリーの充電レベルと ev_max_charge の間で一定であると見なされます。

ev_unconditioned_charging_curve string バッテリーが非コンディショニング状態 (例えば、冷えた状態) のときの最大充電速度 (W) をペアで指定するパラメータ。このフィールドは ev_pre_conditioning_time パラメータと一緒に使用されます。それを使用する場合、両方のフィールドが供給される必要があります。両方のパラメータが供給されない場合、無効なクエリとして拒否されます。非コンディショニングバッテリーは充電時間に影響を与え、結果として ETA に影響を与える可能性があります。ev_unconditioned_charging_curve と ev_pre_conditioning_time を使用して非コンディショニングバッテリーを考慮することで、より正確な ETA を計算できます。例: 値 0,50000; 42000,35000; 60000,15000; 80000,5000 は、バッテリーが 42 kWh の充電レベルのとき、35 kW の充電を示します。バッテリーコンディショニングパラメータが提供されない場合、標準の ev_charging_curve が充電時間を計算するために使用されます。非コンディショニング充電カーブの充電レベルは 0 から最大充電レベルまで広がる必要があります。最初のエントリーの充電速度は、0 から最初のエントリーの充電レベルの間で一定であると見なされます。最後のエントリーの充電速度は、最後のエントリーの充電レベルと ev_max_charge の間で一定であると見なされます。

ev_pre_conditioning_time integer 車両のバッテリーをコンディショニングするために必要な時間を指定するパラメータ。このフィールドは ev_unconditioned_charging_curve パラメータと一緒に使用されます。それを使用する場合、両方のフィールドが供給される必要があります。両方のパラメータが供給されない場合、無効なクエリとして拒否されます。非コンディショニングバッテリーは充電時間に影響を与え、結果として ETA に影響を与える可能性があります。ev_unconditioned_charging_curve と ev_pre_conditioning_time を使用して非コンディショニングバッテリーを考慮することで、より正確な ETA を計算できます。例: 値 10 は、バッテリーがコンディショニング状態に達するまでに 10 分かかることを示します。EV 充電停止が予想されるドライブタイムの 10 分以内であれば、 ev_unconditioned_battery_charging_curve が EV 停止で充電時間を見積もるために使用されます。EV 充電停止が ev_pre_conditioning_time のドライブタイムの経過後に発生する場合、バッテリーがコンディショニングされていると見なされ、標準の ev_charging_curve が充電時間を見積もるために使用されます。最小 ev_pre_conditioning_time 値は 0 分で、最大値は 240 分です。バッテリーコンディショニングパラメータが供給されていない場合、標準の ev_charging_curve が充電時間を計算するために使用されます。

ev_max_ac_charging_power integer 車両のオンボード充電器が供給できる最大 AC 充電電力 (W) を指定するオプションパラメータ。このパラメータは ev_charging_curve と一緒に、バッテリーの充電速度を決定します。例: 16kW の AC 電力アウトレットで充電しており、車両のオンボード AC コンバータの出力量が 10kW (ev_max_ac_charging_power) である場合、ルーターは 10kW の最大充電電力を使用します。デフォルト値は 14400W です。

ev_min_charge_at_destination integer ルートの最終目的地で必要な最小バッテリー充電量 (Wh)。例: 値 20000 は、車両が最終目的地に到達する際に少なくとも 20 kWh の充電量を持っていることを意味します。ev_min_charge_at_destination は 0 から ev_max_charge の範囲である必要があります。デフォルト値は ev_max_charge の 10% です。

ev_min_charge_at_charging_station integer 充電ステーションに到着する際の最小充電量 (Wh) を定義するオプションパラメータ。例: 値 20000 は、車両が各充電停車に到着する際に少なくとも 20 kWh の充電量を持っていることを意味します。ev_min_charge_at_charging_station は 0 から ev_max_charge の範囲である必要があります。デフォルト値は ev_max_charge の 10% です。

auxiliary_consumption integer 助手システム (例えば、暖房、ラジオ、エアコン) の連続電力消費量 (W) を定義するオプションパラメータ。助系统の消費量は旅行中の予想電力消費量に影響を与え、その結果としてルーティングに影響を与える可能性があります。例: 値 300 は、車両の助手システムが 300 ワットの電力を消費していることを示します。最小値は 0 ワットで、最大値は 10000 ワットです。

ev_add_charging_stops boolean EV ルートに充電停止を追加するかどうかを指定するオプションパラメータ。false に設定した場合、EV ルートは車両が旅を完了するための十分な範囲を持たない場合でも充電停止を追加しません。これは、ユーザーまたはクライアントが適切な充電停止を手動で選択する場合の EV 旅行計画に役立ちます。true に設定した場合 (デフォルト)、EV ルートは、旅を完了するために必要に応じて、最適な充電時間と充電レベルで充電停止を追加します。

充電ステーションデータ

Mapbox EV ルーティングは、ヨーロッパと北アメリカの充電ステーションを処理し、相互接続されたステーションのデジタルグラフを構築します。EV ルートリクエストを行うと、ルーターはルート沿いの最寄りのステーションを選び、ドライバーの EV モデルに適した最速の充電器を特定します。

EV ルーティングの対応地理範囲

Mapbox EV ルーターは、次の地域で EV 旅程計画をサポートしています：

アメリカ合衆国
カナダ
ドイツ
イギリス

ノルウェー
フランス
スウェーデン
イタリア

ポルトガル
スペイン
オランダ
オーストリア

サンプル EV ルートリクエスト

$ curl "https://api.mapbox.com/directions/v5/mapbox/driving/11.59838875578771,48.1498484882143;11.646071564986642,48.157168731123306.json?overview=false&alternatives=true&waypoints_per_route=true&engine=electric&ev_initial_charge=600&ev_max_charge=50000&ev_connector_types=ccs_combo_type1,ccs_combo_type2&energy_consumption_curve=0,300;20,160;80,140;120,180&ev_charging_curve=0,100000;40000,70000;60000,30000;80000,10000&ev_min_charge_at_charging_station=1&access_token=YOUR_MAPBOX_ACCESS_TOKEN"

EV 充電停止付き代替ルートレスポンスの例

新 waypoints_per_route=true, alternatives=true

{
  "routes": [
    {
      "weight_name": "自動",
      "weight": 729.764,
      "duration": 1371.657958984375,
      "distance": 4575.367,
      "waypoints": [  // このルート固有のウェイポイント配列
        { // 通常のユーザーが送信したウェイポイント (起点)。
          "name": "Ifflandstraße",
          "location": [
            11.59804,
            48.149988
          ],
          "distance": 30.207000732421875,
          "metadata": null
        },
        { // サイレントウェイポイント、それは新しい区切りを作りません。
          // それはルートにマッチした場所を説明しています。
          "metadata": {
            "type": "silent",
            "distance_from_route_start": 2088,
            "geometry_index": 11
          },
          ...
        },
        { // ルーティングエンジンが EV ルートリクエスト中に挿入した充電ステーションのウェイポイント
          "name": "Arabellastraße",
          "location": [
            11.617788,
            48.153125
          ],
          "distance": 18.554000854492188,
          "metadata": {
            "type": "charging-station",
            "name": "BayWa Zentrale",
            "charge_time": 788,
            "charge_to": 5369,
            "charge_at_arrival": 250,
            "plug_type": "ccs_combo_type2",
            "power_kw": 150,
            "station_id": "ocm-128831",
            "provider_names": ["テスラ", "シェルリチャージソリューションズ"]
          }
        },
        { // 通常のユーザーが送信したウェイポイント (目的地)。
          "name": "Barlowstraße",
          "location": [
            11.646591,
            48.156744
          ],
          "distance": 1.```json
1330000162124634,
          "metadata": null
        }
      ],
      "legs": [
        {
          "via_waypoints": [],
          "summary": "Ifflandstraße, B 2R",
          "admins": [
            {
              "iso_3166_1_alpha3": "DEU",
              "iso_3166_1": "DE"
            }
          ],
          "weight": 333.797,
          "duration": 255.738,
          "steps": [],
          "distance": 2262.614
        },
        {
          "via_waypoints": [],
          "summary": "Arabellastraße, Englschalkinger Straße",
          "admins": [
            {
              "iso_3166_1_alpha3": "DEU",
              "iso_3166_1": "DE"
            }
          ],
          "weight": 395.967,
          "duration": 327.92,
          "steps": [],
          "distance": 2312.754
        }
      ]
    },
    {  // 2番目のルートオブジェクト、代替ルートであり、別のセットのウェイポイントを持つ可能性があります
      "geometry": "mnn_Ick}pAfBiF`CzA",
      "waypoints": [ // このルート固有のウェイポイント配列
        { // 通常のユーザーが送信したウェイポイント (起点)。
          "metadata": {
            "type": "regular"
          },
          "name": "alt1_origin",
          "distance": 1.1330000162124634
        },
        { // ルーティングエンジンが EV ルートリクエスト中に挿入した充電ステーションのウェイポイント
          "metadata": {
            "type": "charging-station",
            "name": "charge1",
            ...
          },
          ...
        },
        { // 通常のユーザーが送信したウェイポイント (目的地)。
          "name": "alt1_destination",
          "location": [
            11.646591,
            48.156744
          ],
          "distance": 1.1330000162124634,
          "metadata": {
            "type": "regular"
          }
        }
        ],
          "legs": [
            { ... }
          ],
          "weight_name": "auto",
          "weight": 44.4,
          "duration": 26.2,
          "distance": 176.7
        }
  ],
  "code": "Ok",
  "uuid": "QJuXPALlclx4ciVHn-UPxhqlUD0W7jjiv1tXFH_haUpp_VkdD0sqGQ=="
}

旧 `waypoints_per_route=false` / デフォルト、代替無し

{
  "routes": [
    {
      "weight_name": "auto",
      "weight": 729.764,
      "duration": 1371.657958984375,
      "distance": 4575.367,
      "legs": [
        {
          "via_waypoints": [],
          "summary": "Ifflandstraße, B 2R",
          "admins": [
            {
              "iso_3166_1_alpha3": "DEU",
              "iso_3166_1": "DE"
            }
          ],
          "weight": 333.797,
          "duration": 255.738,
          "steps": [],
          "distance": 2262.614
        },
        {
          "via_waypoints": [],
          "summary": "Arabellastraße, Englschalkinger Straße",
          "admins": [
            {
              "iso_3166_1_alpha3": "DEU",
              "iso_3166_1": "DE"
            }
          ],
          "weight": 395.967,
          "duration": 327.92,
          "steps": [],
          "distance": 2312.754
        }
      ]
    }
  ],
  "waypoints": [
    {
      "name": "Ifflandstraße",
      "location": [11.59804, 48.149988],
      "distance": 30.207000732421875,
      "metadata": null
    },
    {
      "name": "Arabellastraße",
      "location": [11.617788, 48.153125],
      "distance": 18.554000854492188,
      "metadata": {
        "type": "charging-station",
        "name": "BayWa Zentrale",
        "charge_time": 788,
        "charge_to": 5369,
        "charge_at_arrival": 250,
        "plug_type": "ccs_combo_type2",
        "power_kw": 150,
        "station_id": "ocm-128831",
        "provider_names": ["Tesla", "Shell Recharge Solutions"]
      }
    },
    {
      "name": "Barlowstraße",
      "location": [11.646591, 48.156744],
      "distance": 1.1330000162124634,
      "metadata": null
    }
  ],
  "code": "Ok",
  "uuid": "QJuXPALlclx4ciVHn-UPxhqlUD0W7jjiv1tXFH_haUpp_VkdD0sqGQ=="
}

充電ウェイポイントメタデータ

Directions API は、充電停止をルートに沿ったウェイポイントとして返します。各充電ウェイポイントは、充電停止に関する追加の metadata を持っています。metadata オブジェクトに含まれる属性は次の通りです：

プロパティ	種類	説明
`type`	`string`	ウェイポイントの種類。充電停止の場合は `charging-station` に設定されます。
`name`	`string`	EV 充電ステーションの名称。
`charge_time`	`number`	ステーションで充電するのに EV に必要な時間 (秒単位)。
`charge_to`	`number`	ステーションで充電する必要があるバッテリーの充電レベル (Wh)。
`charge_at_arrival`	`number`	ステーション到着時のバッテリー充電量 (Wh)。
`plug_type`	`string`	ステーションでの充電に使用するコネクタタイプ。可能な値は次の通りです: `ccs_combo_type1` `ccs_combo_type2` `chademo` `tesla` `mennekes_type2`
`current_type`	`string`	ステーションでの充電に使用するコネクタの電流タイプ。可能な値は次の通りです: `dc` `single_phase_ac` `three_phase_ac`
`power_kw`	`number`	コネクタタイプの最大電力 (kW)
`station_id`	`string`	充電ステーションの一意の ID。
`provider_names`	`array`	オプション。EV 充電ステーションの充電ポイントプロバイダー。プロバイダ名文字列の安定性は保証されません。

ウェイポイントオブジェクト

Directions API クエリのレスポンスボディには ウェイポイントオブジェクト があります。これは、道路ネットワークにスナップされた入力座標です。ウェイポイントオブジェクトには次のプロパティがあります：

プロパティ	種類	説明
`name`	`string`	入力座標がスナップされた道路または歩道の名称。
`location`	`array`	`[経度, 緯度]` としてのスナップされた座標。
`distance`	`number`	オプション. クエリで指定された座標からスナップされた場所までの直線距離。
`metadata`	`object`	オプション. EV ルーティングにより挿入された充電停止に関するオブジェクト。開始および終了場所を含むユーザー提供のウェイポイントについては `null` に設定されます。

ウェイポイントオブジェクトの例

{
  "name": "Kirkjubøarvegur",
  "location": [-6.80897, 62.000075],
  "distance": 25,
  "metadata": {
    // EV ルーティング専用のメタデータ
    "type": "charging-station",
    "name": "BayWa Zentrale",
    "charge_time": 788,
    "charge_to": 5369,
    "charge_at_arrival": 250,
    "plug_type": "ccs_combo_type2",
    "power_kw": 150,
    "station_id": "ocm-128831",
    "provider_names": ["Tesla", "Shell Recharge Solutions"]
  }
}

ルートオブジェクト

Directions API クエリのレスポンスボディには、ルートオブジェクトの配列があります。ルートオブジェクトは、複数のウェイポイントを通るルートを説明します。ルートオブジェクトには、次のプロパティがあります：

プロパティ	種類	説明
`duration`	`number`	ウェイポイントを通過する推定旅行時間 (秒単位)。
`distance`	`number`	ウェイポイントを通過する移動距離 (メートル単位)。
`weight_name`	`string`	使用される重みを指定します。デフォルトでは時間に基づいた重みを使用し、望ましくない操作に対する追加のペナルティを含む場合があります。`mapbox/driving` および `mapbox/driving-traffic` の場合、`auto` に設定されます。`mapbox/walking` の場合、`pedestrian` に設定されます。
`weight`	`number`	ルートの望ましさを表す数値であり、値が小さいほどルートが望ましいことを示します。同じウェイポイントを持つルートを比較する場合、重みが低い方が望ましいルートです。複数のルートが返される場合、それらは重みの昇順で並べられます。
`duration_typical`	`number`	`driving-traffic` プロファイルを使用する場合、通常の条件下でのルートの所要時間を示す浮動小数点数値が返されます (ライブトラフィックを考慮しない)。
`weight_typical`	`number`	`driving-traffic` プロファイルを使用する場合、通常の条件下での選択されたルートの重みを示す浮動小数点数値が返されます (ライブトラフィックを考慮しない)。
`geometry`	`string`	`geometries` クエリパラメータに従って、これは GeoJSON LineString または Polyline string のいずれかです。`overview` クエリパラメータに従って、これは完全なルートジオメトリ (`full`)、簡略化されたルート (`simplified`)、または含まれない (`false`) 場合があります。
`legs`	`array`	`[ルートレグ](#route-leg-object)`オブジェクトの配列。
`voiceLocale`	`string`	音声指示に使用された言語。デフォルトは `en` (英語) です。許可される指示言語のいずれかです。`voiceLocale` は `voice_instructions=true` の場合にのみレスポンスに含まれます。
`waypoints`	`array`	入力パラメータ `waypoints_per_route=true` が使用される場合、ウェイポイントはルートオブジェクトに表示され、ルート固有のウェイポイントオブジェクトの配列を表示します。各ウェイポイントは、道路とパスネットワークにスナップされた入力座標です。ウェイポイントは、ルートによって移動される順序で表示されます。これらのウェイポイントには、EV ルーティングで使用される場合、充電ステーションなどの追加のウェイポイントが含まれることがあります。

ルートオブジェクトの例

{
  "waypoints": [], // これは `waypoints_per_route=true`の場合
  "duration": 88.4,
  "distance": 830.4,
  "weight": 88.4,
  "weight_name": "ルートの可能性",
  "geometry": "oklyJ`{ph@yBuY_F{^_FxJoBrBs@d@mAT",
  "legs": [],
  "voiceLocale": "en"
}

ルートレグオブジェクト

ルートレグオブジェクトはルートオブジェクト内にネストされています。ルートレグとは、出発地点から目的地点までの旅程のことです。そのため、通常は入力座標の数よりも 1 少なくなります。waypoints= パラメータを使用するとこれをオーバーライドできます。例えば：

2 つの入力座標を持つルートリクエストは、ウェイポイントなしで 1 つのレグを定義します。
3 つの入力座標を持つルートリクエストは、1 つのウェイポイントを持つ 2 つのレグを定義します。
4 つの入力座標を持つルートリクエストは、 waypoints= パラメータを使用する場合、3 つのウェイポイントを指定する 2 つのレグを持つことになります。

各ルートレグオブジェクトには次のプロパティがあります：

プロパティ	種類	説明
`distance`	`number`	ウェイポイント間を移動する距離 (メートル単位)。
`duration`	`number`	ウェイポイント間の推定旅行時間 (秒単位)。
`weight`	`number`	`weight_name` で記述された単位の重み。
`duration_typical`	`number`	`driving-traffic` プロファイルを使用する場合、通常の条件下でのレグの所要時間を示す数値 (ライブトラフィックを考慮しない)。
`weight_typical`	`number`	`driving-traffic` プロファイルを使用する場合、通常の条件下でのレグの重みを示す数値 (ライブトラフィックを考慮しない)。
`steps`	`array`	オプションの `steps` パラメータに応じて、`ルートステップ` オブジェクトの配列 (`steps=true`) か空の配列 (`steps=false`、デフォルト)。
`summary`	`string`	ルートの概要。
`admins`	`array`	ルートレグが通過する行政境界のオブジェクト配列。交差点オブジェクトの `admin_index` を使用して、交差点の行政境界をこの配列で見つけます。
`incidents`	`array`	道路に沿って発生する一時的なイベントを説明するインシデントオブジェクトの配列。このプロパティは存在するインシデントがあり、 `mapbox/driving-traffic` プロファイルを使用する場合にのみ提供されます。
`closures`	`array`	`annotations=closure,...` を `mapbox/driving-traffic` リクエストで使用し、ルートにライブトラフィックの閉鎖がある場合にルートレグオブジェクトに含まれます。この配列は以下のプロ```json

パラメータをコンテキストとするために含まれる閉鎖オブジェクトの配列です：

プロパティ	説明
`geometry_index_start`	閉鎖が始まる座標リストの位置。レグの開始位置からの相対位置です。
`geometry_index_end`	閉鎖が終わる座標リストの位置。レグの開始位置からの相対位置です。

プロパティ	説明
`speed` (省略可能)	各セグメントの座標間の最大速度制限。値は法定速度制限または表示された推奨速度制限である場合があります。
`unit` (省略可能)	`speed` が表す単位 (km/h または mph)。 `speed` と組み合わせて返されます。
`unknown` (省略可能)	速度制限が不明な場合は `true` を返します。
`none` (省略可能)	速度制限が無制限である場合は `true` です (例えば、ドイツのアウトバーン)。

maxspeed オブジェクト内で speed と unit が存在する場合、none または unknown は存在しません。 | | annotation.state_of_charge | number | バッテリーの現在の充電状態 (最大容量の %)。値が負の場合、充電不足を示し、正の値はバッテリーの充電レベルを示します。値の範囲は負の-2³¹ から 100 まであり、100 はバッテリーが完全に充電されていることを示します。充電ステーションなしでは到達できない場合、バッテリーの充電状態は負になる可能性があり、ルートに充電停止を追加せずに返されます。この場合、適切な措置を講じるかどうかはクライアントアプリケーションに委ねられます。 | | via_waypoints | array | waypoints パラメータをリクエストで使用する場合、各レグごとに返される配列で、その特定のレグ上にあるルート全体のウェイポイントがどこで一致したかを説明します。これは、ルートに沿ったウェイポイントが通過される時に追跡するための手段を提供します。また、オプションのウェイポイントパラメータの説明も参照してください。 | | via_waypoints.waypoint_index | number | 原点 (インデックス 0) と目的地を除く、関連するウェイポイントインデックス。 | | via_waypoints.distance_from_start | double | レグの原点からの計算された距離 (メートル単位)。 | | via_waypoints.geometry_index | number | レグ形状のインデックスと関連するウェイポイントの位置。 |

ルートレグオブジェクトの例

{
  "via_waypoints": [
    {
      "waypoint_index": 1,
      "distance_from_start": 127.951,
      "geometry_index": 6
    },
    {
      "waypoint_index": 2,
      "distance_from_start": 236.822,
      "geometry_index": 10
    }
  ],
  "annotation": {
    "distance": [
      4.294596842089401, 5.051172053200946, 5.533254065167979,
      6.576513793849532, 7.4449640160938015, 8.468757534990829,
      15.202780313562714, 7.056346577326572
    ],
    "duration": [1, 1.2, 2, 1.6, 1.8, 2, 3.6, 1.7],
    "speed": [4.3, 4.2, 2.8, 4.1, 4.1, 4.2, 4.2, 4.2],
    "congestion": [
      "low",
      "moderate",
      "moderate",
      "moderate",
      "heavy",
      "heavy",
      "heavy",
      "heavy"
    ],
    "maxspeed": [
      {
        "speed": 56,
        "unit": "km/h"
      },
      {
        "speed": 56,
        "unit": "km/h"
      },
      {
        "speed": 56,
        "unit": "km/h"
      },
      {
        "speed": 56,
        "unit": "km/h"
      },
      {
        "speed": 56,
        "unit": "km/h"
      },
      {
        "speed": 56,
        "unit": "km/h"
      },
      {
        "speed": 56,
        "unit": "km/h"
      },
      {
        "speed": 56,
        "unit": "km/h"
      }
    ]
  },
  "duration": 99.824,
  "weight": 131.349,
  "distance": 580.039,
  "steps": [],
  "summary": ""
}

ルートステップオブジェクト

ルートレグオブジェクト内にはネストされたルートステップオブジェクトがあり、1つのステップマニューバーオブジェクトと次のルートステップへの旅行に関する情報が含まれています:

プロパティ種類説明

maneuver object 1つのステップマニューバーオブジェクト。

distance number マニューバーから次のルートステップまでの移動距離 (メートル単位)。

duration number マニューバーから次のルートステップまでの推定旅行時間 (秒単位)。

weight number weight_name で説明された単位の重み。

duration_typical number driving-traffic プロファイルを使用する場合、通常の条件下でのステップの所要時間を示す数値 (ライブトラフィックを考慮しない)。

weight_typical number driving-traffic プロファイルを使用する場合、通常の条件下でのステップの重みを示す数値 (ライブトラフィックを考慮しない)。

geometry string geometries パラメータに従って、これは GeoJSON LineString または Polyline string であり、このルートステップから次のルートステップまでの完全なルートジオメトリを表します。

name string このステップのマニューバーまでの道路または道の名前。

ref string 道路や道の指定。複数の道路指定がある場合、セミコロンで区切られます。一般に、アルファベットのネットワークコード (道路タイプまたは番号付けシステムを識別) と、スペースまたはハイフン、およびルート番号で構成されます。オプションで含まれる場合があります。
注意: ネットワークコードは必ずしもグローバルに一意ではなく、一意と見なすべきではありません。ルート番号は、特定のネットワーク内の道路を一意に識別しない場合があります。

destinations string 進行中の道路や道の目的地。データが利用可能な場合にオプションで含まれる。

exits string 道路や道の出入口番号または名前。データが利用可能な場合にオプションで含まれる。

driving_side string このステップの地点での法的な運転側面。left または right のいずれか。

mode

string

移動モード。

プロファイル	可能な値
`mapbox/driving`	`driving`、`ferry`、`unaccessible`
`mapbox/walking`	`walking`、`ferry`、`unaccessible`
`mapbox/cycling`	`cycling`、`walking`、`ferry`、`train`、`unaccessible`

pronunciation string name プロパティの名前の発音方法を示す IPA 音韻表記。ステップの発音データが利用できない場合省略される。

intersections array ステップに沿ったすべての交差点を表すオブジェクトの配列:

intersections.location array ターンの地点を説明する [経度, 緯度] ペア。

intersections.bearings array 交差点で利用可能な方位値のリスト。方位は交差点で利用可能なすべての道路を説明する。

intersections.classes

array

交差点を出る道路のクラスを示す文字列の配列。

可能な値	説明
`toll`	道路が有料道路に続く
`ferry`	道路がフェリーに続く
`restricted`	道路がアクセス制限を持つ続く
`motorway`	道路が高速道路に続く
`tunnel`	道路がトンネルに続く

intersections.entry array 方位リストに対応する進入フラグのリスト。フラグが true の場合、それぞれの道路に進入できることを示す。false の場合、それぞれの道路に進入すると制限違反になる。

intersections.geometry_index integer レグの開始位置からのインデックス。これを使用して、交差点に対応する所要時間注釈を適用できます。driving、driving-traffic、および walking プロファイル。

intersections.in integer 方位リストと進入リストのインデックス。ターン前の方位を計算するために使用します。具体的にはマニューバ/交差点通過前の進行方向から真北への時計回りの角度。運転方向に方位を156度回転させた後の方位。この値は出発マニューバには提供されません。

intersections.out integer 方位リストと進入リストのインデックス。ターン後の方位を抽出するために使用されます。具体的にはマニューバ/交差点通過後の進行方向から真北への時計回りの角度。この値は到着マニューバには提供されません。

intersections.lanes array 交差点で利用可能なターンレーンを表すレーンオブジェクトの配列。交差点にレーン情報がない場合、lanes プロパティは存在しません。

intersections.duration number 交差点を通過するのに必要な時間 (秒単位)。driving プロファイルのみ。

intersections.tunnel_name string 交差点を出てトンネルに続く道路の名前。このプロパティはトンネルが指定された名前を持つ場合のみ含まれます。driving プロファイルのみ。

intersections.mapbox_streets_v8 object ルートに沿った交差点を出る道路に関する詳細情報が含まれます。このプロパティのオブジェクトは Mapbox Streets v8 Road 仕様に対応します。driving プロファイルのみ。

intersections.mapbox_streets_v8.class string 交差点を出る道路のクラスは Mapbox Streets v8 Road Class仕様で定義されます。有効な値には、motorway、motorway_link、primary、street など、Mapbox Streets v8. でサポートされているものが含まれます。

intersections.is_urban boolean 交差点を出る道路が都市エリア内と見なされるかどうかを示します。この値は周囲の道路ネットワークの密度によって決まります。driving プロファイルのみ。

intersections.admin_index integer 利用されているルートレグの管理境界リストへのゼロベースインデックス。これはルートのこのポイントにおける ISO 3166-1 国コードを調べるために使用します。```json

driving プロファイルのみ。

intersections.rest_stop object ルートに沿った休憩所に関する情報が含まれます。driving プロファイルのみ。

intersections.rest_stop.type string rest_stop オブジェクトで常に含まれる休憩所の種類。有効な値には、rest_area (駐車のみを含む) と service_area (ガソリンやレストランなどのアメニティを含む) があります。日本では、rest_area と service_area は、アメニティにかかわらず、休憩所名の PA および SA に対応します。

intersections.rest_stop.name string 休憩所の名前。データが利用可能な場合にオプションで含まれる。

intersections.toll_collection object ルートに沿った通行料金収集ポイントに関する情報が含まれます。これは、通行料金が収集される支払いゲートまたはオーバーヘッド電子ゲートです。driving プロファイルのみ。

intersections.toll_collection.type string toll_collection オブジェクトに常に含まれる通行料金収集ポイントの種類。有効な値には toll_booth と toll_gantry があります。

intersections.toll_collection.name string 通行料金収集ポイントの名前。データが利用可能な場合にオプションで含まれる。

intersections.railway_crossing boolean 交差点に鉄道の交差があるかどうかを示す。

intersections.traffic_signal boolean 交差点に信号機があるかどうかを示す。

intersections.stop_sign boolean 交差点に停止標識があるかどうかを示す。

intersections.yield_sign boolean 交差点に譲歩標識があるかどうかを示す。

speedLimitSign string ルートステップ沿いの速度制限標識のデザイン。mutcd (Manual on Uniform Traffic Control Devices) または vienna (Vienna Convention on Road Signs and Signals)。レスポンスには annotations クエリパラメータに maxspeed が含まれる場合にのみ存在します。

speedLimitUnit string ステップ沿いで使用される速度の単位。km/h または mph のいずれか。この単位は、ユーザーの優先単位が存在しない場合に表示する適切なデフォルト単位として使用されます。annotations クエリパラメータに maxspeed が含まれる場合にのみレスポンスに存在します。

ルートステップオブジェクトの例

{
  "intersections": [
    {
      "out": 1,
      "location": [13.424671, 52.508812],
      "bearings": [120, 210, 300],
      "entry": [false, true, true],
      "in": 0,
      "stop_sign": true,
      "lanes": [
        {
          "valid": true,
          "active": true,
          "valid_indication": "straight",
          "indications": ["left", "straight"]
        },
        {
          "valid": true,
          "active": false,
          "valid_indication": "straight",
          "indications": ["straight", "right"]
        },
        {
          "valid": false,
          "active": false,
          "indications": ["right"]
        }
      ]
    }
  ],
  "geometry": "asn_Ie_}pAdKxG",
  "maneuver": {
    "bearing_after": 202,
    "type": "turn",
    "modifier": "left",
    "bearing_before": 299,
    "location": [13.424671, 52.508812],
    "instruction": "Turn left onto Adalbertstraße"
  },
  "duration": 59.1,
  "distance": 236.9,
  "driving_side": "right",
  "weight": 59.1,
  "name": "Adalbertstraße",
  "mode": "driving"
}

ステップマニューバーオブジェクト

ルートステップオブジェクトには、ネストされたステップマニューバーオブジェクトが含まれています。このオブジェクトには次のプロパティがあります：

プロパティ種類説明

bearing_before integer マニューバー前の進行方向から真北への時計回りの角度 (0〜360)。

bearing_after integer マニューバー後の進行方向から真北への時計回りの角度 (0〜360)。

instruction string マニューバーの実行方法の人間が読みやすい指示。

location array [経度, 緯度] としてのマニューバーの座標。

modifier

string

省略可能. マニューバーの方向変更。各 modifier の意味は type プロパティによって異なります。

可能な値	説明
`uturn`	進行方向の逆転を示します。`type` は `turn` 、または `continue` になります。
`sharp right`	鋭い右折。
`right`	通常の右折。
`slight right`	わずかな右折。
`straight`	方向の変化なし。
`slight left`	わずかな左折。
`left`	通常の左折。
`sharp left`	鋭い左折。

出発や到着の地点が非常に近い場合、modifier が供給されないことがあります。

type string マニューバーのタイプを示します。マニューバータイプの完全なリストについては、マニューバータイプ表を参照してください。modifier が提供されない場合、マニューバーの type は depart および arrive に制限されます。

マニューバータイプ

`type`	説明
`turn`	`modifier` の方向へのターン。
`new name`	強制ターン後の道路名変更。
`depart`	レグからの出発を示します。`modifier` の値は現在の進行方向と比較した出発地点の位置を示します。
`arrive`	レグの目的地への到着を示します。`modifier` の値は現在の進行方向と比較した到着地点の位置を示します。
`merge`	道路に合流します。
`on ramp`	高速道路に入るためのランプを取ります。
`off ramp`	高速道路を出るためのランプを取ります。
`fork`	分岐点で左または右、または分岐点での左/右/直進を保持します。
`end of road`	道路が T 字路で終わります。
`continue`	ターン後に道路を継続します。
`roundabout`	ロータリーを通過します。ルートステップに `exit` プロパティが追加されます。`modifier` はロータリーに入る方向を指定します。
`rotary`	トラフィックサークル。ロータリーとは異なり必ずしもラウンドアバウトの規則に従う必要はありません。`rotary_name` パラメータ、`rotary_pronunciation` パラメータ、またはその両方を含む場合があります。また、 `exit` プロパティも含みます。
`roundabout turn`	交差点として扱われる小さなロータリー。
`notification`	運転条件の変化 (例えば、運転モードの `driving` から `ferry` への変更) を示します。
`exit roundabout`	ロータリーからのマニューバーを示します。これが結果に現れるのは、 `roundabout_exits=true` クエリパラメータがリクエストに含まれている場合のみです。
`exit rotary`	ロータリーからのマニューバーを示します。これが結果に現れるのは、 `roundabout_exits=true` クエリパラメータがリクエストに含まれている場合のみです。

Note

新しいプロパティは、潜在的に type に依存し、API バージョンの変更なしに将来導入される可能性があります。

ステップマニューバーオブジェクトの例

{
  "bearing_before": 299,
  "bearing_after": 202,
  "type": "turn",
  "modifier": "left",
  "location": [13.424671, 52.508812],
  "instruction": "Turn left onto Adalbertstraße"
}

レーンオブジェクト

ルートステップオブジェクトには、ネストされたレーンオブジェクトがあり、これは交差点で利用可能なターンレーンを記述します。レーンは通りの左から右へ順に提供されます。

プロパティ種類説明

valid boolean レーンがマニューバーを完了するために使用されるかどうか (true) または使用されないか (false) を示します。例えば、レーン配列に 4 つのオブジェクトがあり、最初の 2 つが有効な場合、運転手は左側のいずれかを選び、ルートに進むことができます。

active boolean このレーンが推奨レーンかどうか (true) またはそうでないか (false) を示します。推奨レーンは、複数のレーンが利用可能な場合に推奨されるレーンです。例えば、ガイダンスが交差点で左折することを示している場合、複数の左折レーンがある場合、次のマニューバーに向けて準備が整っている左折レーンが active としてマークされます。driving プロファイルのみ。

valid_indication string valid または active のいずれかが true である場合、このプロパティは現在のルートに適用されるレーン indications を示します。例: レーンが左または直進を許可し、現在のルートが左を指示する場合、この値は left になります。indications の可能な値については、以下を参照してください。active と valid の両方が false の場合、このプロパティはレスポンスに含まれません。driving プロファイルのみ。

indications

array

各ターンレーンの表示 (標識、道路標示、またはその両方)。道路は複数の表示を持つことができます。例: ターンレーンが左折矢印と直進矢印を持つ標識を持つ場合、リスト内のインデックスは次のようになります:

可能な値	説明
`none`	特定の標識が表示されません
`straight`	直進を示す標識
`sharp left`	鋭い左折を示す標識
`left`	左折を示す標識
`slight left`	わずかな左折を示す標識
`slight right`	わずかな右折を示す標識
`right`	右折を示す標識
`sharp right`	鋭い右折を示す標識
`uturn`	Uターンの表示

レーンオブジェクトの例

{
  "valid": true,
  "active": true,
  "valid_indication": "left",
  "indications": ["left"]
}

音声案内オブジェクト

ルートステップオブジェクトには、オプションのvoice_instructions=trueクエリパラメータが存在する場合、ネストされた音声案内オブジェクトが含まれています。音声案内オブジェクトには、操作からどれくらいの距離で発信すべきかと共にアナウンスすべきテキストが含まれています。システムは音声案内オブジェクトがネストされているルートステップ中にインストラクションを発表しますが、これは次のステップの操作に関するものです。

プロパティ	タイプ	説明
`distanceAlongGeometry`	`number`	メートル単位で、次の操作までの距離を示す浮動小数点数です。
`announcement`	`string`	音声案内のテキストです。
`ssmlAnnouncement`	`string`	適切なテキストと発音のための SSML マークアップを含みます。このプロパティはアマゾンポリーでの使用を目的としています。SSML タグは他のテキスト読み上げエンジンで動作しない場合があります。

音声案内オブジェクトの例

{
  "distanceAlongGeometry": 375.7,
  "announcement": "In a quarter mile, take the ramp on the right towards I 495: Baltimore",
  "ssmlAnnouncement": "<speak><amazon:effect name=\"drc\"><prosody rate=\"1.08\">In a quarter mile, take the ramp on the right towards <say-as interpret-as=\"address\">I-495</say-as>: Baltimore</prosody></amazon:effect></speak>"
}

ルートステップオブジェクトには、オプションのbanner_instructions=trueクエリパラメータが存在する場合、ネストされたバナー案内オブジェクトが含まれています。バナー案内オブジェクトには、ルートの視覚的ガイダンスとして表示すべきバナーの内容が含まれています。バナー案内は表示すべきルートステップの子供ですが、それは、次のステップの操作について指します。

プロパティ	タイプ	説明
`distanceAlongGeometry`	`number`	メートル単位で、次の操作までの距離を示す浮動小数点数です。一度に表示するバナーは一つだけです。
`primary`	`object`	ユーザーに表示する最も重要な内容です。このテキストは上部でより大きく表示されます。
`secondary`	`object` または `null`	オプション。視覚的ガイダンスに役立つ追加コンテンツです。このテキストは`primary`の下にあり、少し小さく表示されます。 `null` になることもあります。
`sub`	`object`	オプション。ドライバーに通知の必要がある場合に含まれる追加情報です。ステップが短ければ、次の操作の情報を含むことができます。レーン情報がある場合、それは次の操作に関する情報よりも優先されます。

各バナータイプ（primary、secondary、および sub ）には、以下のプロパティが含まれます：

Property Type Description

text string 表示すべき全てのテキストです。

type string オプション。 操作の種類です。modifierと組み合わせ（ラウンドアバウトの場合は degrees）て表示するアイコンに使われることがあります。可能な値は： turn、 merge、 depart、 arrive、 fork、 off ramp、 roundabout です。

modifier

string

オプション。 操作の修飾子です。type と組み合わせて（ラウンドアバウトの場合は degrees）アイコンに使用されることがあります。

可能な値	説明
`uturn`	方向の逆転を意味する
`sharp right`	右へ鋭いターン
`right`	通常の右折
`slight right`	右へわずかにターン
`straight`	方向の変化なし
`slight left`	左へわずかにターン
`left`	通常の左折
`sharp left`	左へ鋭いターン

その他省略

{
  "distanceAlongGeometry": 100,
  "primary": {
    "type": "turn",
    "modifier": "left",
    "text": "I 495 North / I 95",
    "components": [
      {
        "text": "I 495",
        "imageBaseURL": "https://s3.amazonaws.com/mapbox/shields/v3/i-495",
        "type": "icon"
      },
      {
        "text": "North",
        "type": "text",
        "abbr": "N",
        "abbr_priority": 0
      },
      {
        "text": "/",
        "type": "delimiter"
      },
      {
        "text": "I 95",
        "imageBaseURL": "https://s3.amazonaws.com/mapbox/shields/v3/i-95",
        "type": "icon"
      }
    ]
  },
  "secondary": {
    "type": "turn",
    "modifier": "left",
    "text": "Baltimore / Northern Virginia",
    "components": [
      {
        "text": "Baltimore",
        "type": "text"
      },
      {
        "text": "/",
        "type": "text"
      },
      {
        "text": "Northern Virginia",
        "type": "text"
      }
    ]
  },
  "sub": {
    "text": "",
    "components": [
      {
        "text": "",
        "type": "lane",
        "directions": ["left"],
        "active": true
      },
      {
        "text": "",
        "type": "lane",
        "directions": ["left", "straight"],
        "active": true
      },
      {
        "text": "",
        "type": "lane",
        "directions": ["right"],
        "active": false
      }
    ]
  }
}

事故オブジェクト

事故オブジェクトは、ルート沿いに事故がある場合、mapbox/driving-traffic リクエストを行った際にルートレッグオブジェクトに含まれます。

Property	Type	Description
`id`	`string`	事故の一意のID。
`type`	`string`	事故の種類です。`accident`、 `congestion`、 `construction`、 `disabled_vehicle`、 `lane_restriction`、 `mass_transit`、 `miscellaneous`、 `other_news`、 `planned_event`、 `road_closure`、 `road_hazard`、 `weather`などがあります。
`description`	`string`	事故の短い説明です。
`long_description`	`string`	事故の長い説明です。
`creation_time`	`string`	事故がマップ上で事故として最後に作成された時間（例：`2020-12-18T15:56:53Z`）。この値はリクエストの間に同じ事故に対して変更される可能性があります。
`start_time`	`string`	事故が開始したまたは開始する予定の時間（例：`2020-12-18T15:56:53Z`）。
`end_time`	`string`	事故が終了したまたは終了する予定の時間（例：`2020-12-18T15:56:53Z`）。
`impact`	`string`	事故が地元交通に与える影響。`unknown`、 `critical`、 `major`、 `minor`、 `low`のいずれかです。
`lanes_blocked`	`array`	事故によりブロックされたレーンです。例として：`left`、 `left center`、 `left turn lane`、 `center`、 `right`、 `right center`、 `right turn lane`、 `hov`などがあります。
`num_lanes_blocked`	`integer`	`lanes_blocked`配列の項目数。
`congestion`	`object`	事故周辺の道路の渋滞状況に関する情報。
`congestion.value`	`integer`	渋滞のレベルを表す0から101の数値。数値が高いほど渋滞が多い。`0`は道路に渋滞がないことを意味し、`100`は道路が閉鎖されていること、`101`は渋滞が計算されなかったことを意味します。
`closed`	`boolean`	道路が完全に閉鎖されている場合は`true`になります。
`geometry_index_start`	`integer`	事故が始まる座標リストの位置。
`geometry_index_end`	`integer`	事故が終了する座標リストの位置。
`sub_type`	`string`	事故の種類に関する追加情報。
`sub_type_description`	`string`	`sub_type`の詳細。
`iso_3166_1_alpha2`	`string`	事故が発生している国のISO 3166-1 alpha-2コード。例： `"US"`。
`iso_3166_1_alpha3`	`string`	事故が発生している国のISO 3166-1 alpha-3コード。例： `"USA"`。
`affected_road_names`	`array`	事故の影響を受ける道路名のリスト。代替道路名は `/` で区切られています。リストは最初の影響を受けた道路から最後に影響を受ける道路まで順序付けられています。
`south`	number	事故の境界ボックスの南緯度座標。
`west`	number	事故の境界ボックスの西経度座標。
`north`	number	事故の境界ボックスの北緯度座標。
`east`	number	事故の境界ボックスの東経度座標。

案内言語

以下の表は、ターンバイターン案内に使用されるlanguageパラメータとサポートされる言語コードを示しています。サポートされていない言語コードが使用された場合、language パラメータはデフォルトで en（英語）に設定されます。

Code	Language	Text	Voice
`ar` or `ar-AE`	Arabic	✅	—
`cs` or `cs-CZ`	Czech	✅	—
`da` or `da-DK`	Danish	✅	✅
`de` or `de-DE`	German	✅	✅
`de-CH`	German (Switzerland)	`de` or `de-DE`	`de` or `de-DE`
`el` or `el-GR`	Greek (Greece)	✅	—
`en-AU`	English (Australia)	`en-GB`	✅
`en-GB-WLS`	English (Welsh)	`en-GB`	✅
`en-GB`	English (UK)	✅	✅
`en-IN`	English (India)	`en-GB`	✅
`en-SG`	English (Singapore)	✅	—
`en` or `en-US`	English (United States)	✅	✅
`es-MX`	Spanish (Mexico)	✅	✅
`es-US`	Spanish (United States)	`es-MX`	✅
`es` or `es-ES`	Spanish (Spain)	✅	✅
`et` or `et-EE`	Estonian	✅	—
`fi` or `fi-FI`	Finnish	✅	—
`fr` or `fr-FR`	French	✅	✅
`fr-CA`	French (Canada)	✅	✅
`he` or `he-IL`	Hebrew	✅	—
`hr-HR`	Croatian	✅	—
`hu` or `hu-HU`	Hungarian	✅	—
`id` or `id-ID`	Bahasa (Indonesia)	✅	—
`it` or `it-IT`	Italian	✅	✅
`ja` or `ja-JP`	Japanese	✅	✅
`ko` or `ko-KR`	Korean	✅	✅
`lt` or `lt-LT`	Lithuanian	✅	—
`lv-LV`	Latvian	✅	—
`nl` or `nl-NL`	Dutch	✅	✅
`nl-BE`	Dutch (Belgium)	✅	✅
`nb-NO`	Norwegian (Bokmål)	✅	✅
`pl` or `pl-PL`	Polish	✅	✅
`pt-BR`	Portuguese (Brazil)	✅	✅
`pt` or `pt-PT`	Portuguese (Portugal)	✅	✅
`ro` or `ro-RO`	Romanian	✅	✅
`ru` or `ru-RU`	Russian	✅	✅
`sk` or `sk-SK`	Slovak	✅	—
`sl` or `sl-SI`	Slovene	✅	—
`sr` or `sr-RS`	Serbian (Cyrillic)	✅	—
`sv` or `sv-SE`	Swedish	✅	✅
`th-TH`	Thai	✅	—
`tr` or `tr-TR`	Turkish	✅	✅
`uk` or `uk-UA`	Ukrainian	✅	—
`vi` or `vi-VN`	Vietnamese	✅	—

簡体字中国語、ウェールズ語、アイスランド語はプライベートプレビューでサポートされており、詳細についてはお問い合わせください。

言語コードのセパレータとしてアンダースコアの使用もサポートされています（例：nl_NL）。 language パラメータは大文字小文字を区```md 別に扱います。

通知オブジェクト

通知のベータサポート

通知オブジェクトは、mapbox/driving または mapbox/driving-traffic リクエストに対して、ルートレッグオブジェクトに含まれる警告や安全メッセージ、または重要な情報が含まれています。

プロパティ	タイプ	説明
`notifications.type`	`string`	通知のタイプです。通知の種類には、`violation` と `alert` があります。`violation` はより深刻なもので、ユーザー設定パラメータ（例：`exclude=unpaved`）がルート生成中に違反した場合に送信されます。`alert` はそれほど深刻ではなく、暗黙の好みを満たせない場合にユーザーに情報を提供することを意図しています（例：`countryBorderCrossing`）。利用可能な値は以下の表にあります。
`notifications.subtype`	`string`	通知のオプションのサブタイプです。利用可能な値は以下の表に示されています。
`notifications.geometry_index`	`integer`	通知が発生した座標リストのオプションの位置です。これは、レグの始まりからの相対位置です。
`notifications.geometry_index_start`	`integer`	通知が始まった座標リストのオプションの位置です。これは、レグの始まりからの相対位置です。
`notifications.geometry_index_end`	`integer`	通知が終わった座標リストのオプションの位置です。これは、レグの始まりからの相対位置です。
`notifications.details`	`object`	通知タイプとサブタイプに固有のオプションの詳細です。
`notifications.details.requested_value`	`string`	リクエストで指定したオプションの値です。例えば、リクエストに`max_width=3`と指定した場合、これは3（メートル）となります。
`notifications.details.actual_value`	`string`	道路のプロパティに関連する実際の値です。例えば、最大道路幅が2.5メートルの場合、これは2.5（メートル）となります。
`notifications.details.unit`	`string`	`details.actual_value` および `details.requested_value` に関連するオプションの単位。
`notifications.details.message`	`string`	通知のオプションのメッセージです。

notifications.geometry_index_startとnotifications.geometry_index_endが存在する場合、通知はレグジオメトリの範囲に関連しています。notifications.geometry_indexが存在する場合、通知はレグジオメトリのポイントに関連しています。それ以外の場合、通知はレグジオメトリに関連していないとみなされます。単一の通知オブジェクトでは、notifications.geometry_index_startとnotifications.geometry_index_endのペアまたはnotifications.geometry_indexのいずれかが存在します。

notifications.detailsオブジェクトは、通知の種類およびサブタイプに固有のものです。

利用可能な違反通知（`notifications.type=violation`）

violation は、ユーザー設定パラメータ（例：exclude=unpaved）がルート生成中に違反した場合に送信されます。

`Subtype`	説明	例
`maxHeight`	車両の高さが道路の制限高さを超えている場合に送信されます。`max_height`が指定された場合に提供されます。	`{ "type": "violation", "subtype": "maxHeight", "geometry_index_end": 5, "geometry_index_start": 3, "details": { "actual_value": "4.60", "requested_value": "4.70", "unit": "meters", "message": "車両の高さ（4.7メートル）が道路の許容高さ（4.6メートル）を0.10メートル超えています。" } }`
`maxWidth`	車両の幅が道路の制限幅を超えている場合に送信されます。`max_width`が指定された場合に提供されます。	`{ "type": "violation", "subtype": "maxWidth", "geometry_index_end": 2, "geometry_index_start": 1, "details": { "actual_value": "4.69", "requested_value": "5.10", "unit": "meters", "message": "車両の幅（5.1メートル）が道路の許容幅（4.69メートル）を0.41メートル超えています。" } }`
`maxWeight`	車両の重量が道路の制限重量を超えている場合に送信されます。`max_weight`が指定された場合に提供されます。	`{ "type": "violation", "subtype": "maxWeight", "geometry_index_end": 1, "geometry_index_start": 0, "details": { "actual_value": "4.60", "requested_value": "5.10", "unit": "metric tons", "message": "車両の重量（5.1メトリックトン）が道路の許容重量（4.6メトリックトン）を0.50メトリックトン超えています。" } }`
`unpaved`	未舗装道路であり、ルートで未舗装道路を除外するよう明示的に要求された場合に送信されます。`exclude=unpaved`の場合に提供されます。	`{ "type": "violation", "subtype": "unpaved", "geometry_index_end": 3, "geometry_index_start": 2, "details": { "requested_value": "paved", "actual_value": "dirt", "message": "道路が未舗装の表面（ダート）を持っています。" } }`
`pointExclusion`	点によってルートから道路を除外するよう明示的に要求された場合に送信されます。`exclude=point(longitude latitude)`の場合に提供されます。	`{ "type": "violation", "subtype": "pointExclusion", "geometry_index_end": 3, "geometry_index_start": 2, "details": { "message": "道路は[1.004941,0.996407]の点を除外するためにルート生成で不適当とされました。" } }`
`countryBorderCrossing`	国境越えを意味します。`exclude=country_border`の場合に提供されます。	`{ "type": "violation", "subtype": "countryBorderCrossing", "geometry_index_end": 1, "geometry_index_start": 0, "details": { "actual_value": "US,CA", "message": "USとCAの国境を越えています。" } }`
`stateBorderCrossing`	州境越えを意味します。`exclude=state_border`の場合に提供されます。	`{ "type": "violation", "subtype": "stateBorderCrossing", "geometry_index_end": 1, "geometry_index_start": 0, "details": { "actual_value": "US-NV,US-CA", "message": "US-NVとUS-CAの州境を越えています。" } }`
`evMinChargeAtChargingStation`	`engine=electric`の場合にのみ適用されます。充電ステーションでEVのバッテリー残量が要求された値よりも少ない場合に送信されます。`ev_min_charge_at_charging_station` EVルーティングパラメータ参照。	`{ "type": "violation", "subtype": "evMinChargeAtChargingStation", "details": { "requested_value": 30000, "actual_value": 27000, "unit": "Wh" } }`
`evMinChargeAtDestination`	`engine=electric`の場合にのみ適用されます。目的地でEVのバッテリー残量が要求された値よりも少ない場合に送信されます。`ev_min_charge_at_destination` EVルーティングパラメータ参照。	`{ "type": "violation", "subtype": "evMinChargeAtDestination", "details": { "requested_value": 20000, "actual_value": 13000, "unit": "Wh" } }`

利用可能なアラート通知（`notifications.type=alert`）

alert はそれほど深刻ではなく、暗黙の好みが満たされない場合にユーザーに情報を提供することを意図しています（例：countryBorderCrossing）。

`Subtype`	説明	例
`countryBorderCrossing`	国境越えを意味します。	`{ "type": "alert", "subtype": "countryBorderCrossing", "geometry_index_end": 1, "geometry_index_start": 0, "details": { "actual_value": "US,CA", "message": "USとCAの国境を越えています。" } }`
`stateBorderCrossing`	州境越えを意味します。	`{ "type": "alert", "subtype": "stateBorderCrossing", "geometry_index_end": 1, "geometry_index_start": 0, "details": { "actual_value": "US-NV,US-CA", "message": "US-NVとUS-CAの州境を越えています。" } }`
`evInsufficientCharge`	`engine=electric`の場合にのみ適用されます。EVのバッテリー残量がゼロまたはそれより少なければ、レグの最初に送信されます。ただし、レグがゼロの充電レベルで開始された場合、この通知は送信されません。	`{ "type": "alert", "subtype": "evInsufficientCharge", "geometry_index": 3 }`

Subtype

説明

例

countryBorderCrossing

国境越えを意味します。

{
  "type": "alert",
  "subtype": "countryBorderCrossing",
  "geometry_index_end": 1,
  "geometry_index_start": 0,
  "details": {
    "actual_value": "US,CA",
    "message": "USとCAの国境を越えています。"
  }
}

stateBorderCrossing

州境越えを意味します。

{
  "type": "alert",
  "subtype": "stateBorderCrossing",
  "geometry_index_end": 1,
  "geometry_index_start": 0,
  "details": {
    "actual_value": "US-NV,US-CA",
    "message": "US-NVとUS-CAの州境を越えています。"
  }
}

evInsufficientCharge

engine=electricの場合にのみ適用されます。EVのバッテリー残量がゼロまたはそれより少なければ、レグの最初に送信されます。ただし、レグがゼロの充電レベルで開始された場合、この通知は送信されません。

{
  "type": "alert",
  "subtype": "evInsufficientCharge",
  "geometry_index": 3
}

Directions APIエラー

エラーが発生した場合、サーバーは異なるHTTPステータスコードで応答します：

HTTPステータスコードが500未満の場合、JSON応答本文にはcodeプロパティが含まれており、クライアントプログラムが制御フローを管理するために使用できます。応答本文には、エラーの理由を説明するmessageプロパティも含まれている場合があります。
サーバーエラーが発生した場合のHTTPステータスコードは500以上であり、応答にはcodeプロパティが含まれません。

応答本文`code`	HTTPステータスコード	説明
`Ok`	`200`	正常な成功ケース。
`NoRoute`	`200`	指定された座標に対してルートが見つかりませんでした。不可能なルート（例えば、フェリー接続がない海を越えるルート）がないかを確認してください。
`NoSegment`	`200`	指定された`radiuses`内で1つまたは複数の座標にマッチする道路セグメントが見つかりませんでした。道路から遠すぎる座標がないか確認してください。
`Not Authorized - No Token`	`401`	トークンがクエリに使用されていませんでした。
`Not Authorized - Invalid Token`	`401`	クエリに使用したアクセストークンを確認してください。
`Forbidden`	`403`	アカウントに問題がある可能性があります。アカウントページで詳細を確認してください。一部のケースでは、URL制限付きのアクセストークンの使用も`403`エラーを引き起こす可能性があります。詳細については、トークン管理ガイドを参照してください。
`ProfileNotFound`	`404`	ルーティングプロファイルのリストに記載されている有効なプロファイルを使用してください。
`InvalidInput`	`422`	指定されたリクエストが有効ではありません。応答の`message`キーに無効な入力の説明が表示されます。

Directions APIの制限と制約

driving、driving-traffic、walking、およびcyclingプロファイルを使用するリクエストでは、ルート全体で最大25のウェイポイント（道路ネットワークにマッチする入力座標）を指定できます。ただし、engine=electricを使用している場合は、最大12のウェイポイントを指定できます。
- driving-trafficプロファイルのトラフィックカバレッジはサポートされる地域で利用可能です。このプロファイル向けのカバレッジのない地域ではdrivingプロファイルの結果に戻ります。
最大300リクエスト/分。
複数の座標が含まれるリクエストは1リクエストとしてカウントされます。
全ウェイポイント間の最大合計距離：
- drivingおよびdriving-trafficプロファイルでは10,000 kilometers。
- cyclingプロファイルでは10,000 kilometers。
- walkingプロファイルでは1,000 kilometers。
大陸間のルートリクエストはサポートされていません。
水域を通過するルートリクエストはサポートされていません。

If you require a higher rate limit, contact us.

Directions APIの料金

Billed by requests
See rates and discounts per Directions API request in the pricing page's Navigation section

Directions APIの使用はAPIリクエストで測定されます。複数のウェイポイントを含むリクエストは1つのAPIリクエストとして課金されます。無料利用枠に含まれるDirections APIリクエストの数や、無料利用枠を超過した場合のリクエストごとの費用の詳細については、料金ページをご覧ください。

このpageは役に立ちましたか？

ルーティング プロファイル​

道順を取得する​

必須パラメータ​

任意パラメータ​

mapbox/walking プロファイル用の任意パラメータ​

mapbox/driving プロファイル用の任意パラメータ​

mapbox/driving-traffic プロファイル用の任意パラメータ​

サンプルリクエスト: 道順を取得する​

サポートされているライブラリ：道順を取得する​

レスポンス：道順を取得する​

サンプルレスポンス：道順を取得する​

新 waypoints_per_route=true​

旧 waypoints_per_route=false / デフォルト​

HTTP POST を使用して道順を取得する​

電気自動車ルーティング​

電気自動車ルーティングのためのパラメータ​

充電ステーションデータ​

EV ルーティングの対応地理範囲​

サンプル EV ルートリクエスト​

EV 充電停止付き代替ルートレスポンスの例​

新 waypoints_per_route=true, alternatives=true​

旧 waypoints_per_route=false / デフォルト、代替無し​

充電ウェイポイントメタデータ​

ウェイポイントオブジェクト​

ウェイポイントオブジェクトの例​

ルートオブジェクト​

ルートオブジェクトの例​

ルートレグオブジェクト​

ルートレグオブジェクトの例​

ルートステップオブジェクト​

ルートステップオブジェクトの例​

ステップマニューバーオブジェクト​

マニューバータイプ​

ステップマニューバーオブジェクトの例​

レーンオブジェクト​

レーンオブジェクトの例​

音声案内オブジェクト​

音声案内オブジェクトの例​

バナー案内オブジェクト​

バナー案内オブジェクトの例​

事故オブジェクト​

案内言語​

通知オブジェクト​

利用可能な違反通知（notifications.type=violation）​

利用可能なアラート通知（notifications.type=alert）​

Directions APIエラー​

Directions APIの制限と制約​

Directions APIの料金​

ルーティングプロファイル

道順を取得する

必須パラメータ

任意パラメータ

`mapbox/walking` プロファイル用の任意パラメータ

`mapbox/driving` プロファイル用の任意パラメータ

`mapbox/driving-traffic` プロファイル用の任意パラメータ

サンプルリクエスト: 道順を取得する

サポートされているライブラリ：道順を取得する

レスポンス：道順を取得する

サンプルレスポンス：道順を取得する

新 waypoints_per_route=true

旧 `waypoints_per_route=false` / デフォルト

HTTP POST を使用して道順を取得する

電気自動車ルーティング

電気自動車ルーティングのためのパラメータ

充電ステーションデータ

EV ルーティングの対応地理範囲

サンプル EV ルートリクエスト

EV 充電停止付き代替ルートレスポンスの例

新 waypoints_per_route=true, alternatives=true

旧 `waypoints_per_route=false` / デフォルト、代替無し

充電ウェイポイントメタデータ

ウェイポイントオブジェクト

ウェイポイントオブジェクトの例

ルートオブジェクト

ルートオブジェクトの例

ルートレグオブジェクト

ルートレグオブジェクトの例

ルートステップオブジェクト

ルートステップオブジェクトの例

ステップマニューバーオブジェクト

マニューバータイプ

ステップマニューバーオブジェクトの例

レーンオブジェクト

レーンオブジェクトの例

音声案内オブジェクト

音声案内オブジェクトの例

バナー案内オブジェクト

バナー案内オブジェクトの例

事故オブジェクト

案内言語

通知オブジェクト

利用可能な違反通知（`notifications.type=violation`）

利用可能なアラート通知（`notifications.type=alert`）

Directions APIエラー

Directions APIの制限と制約

Directions APIの料金