Route - Post Route Directions Batch
を使用して、1 つの非同期要求で Get Route Directions API にクエリのバッチを送信します。
Post Route Directions Batch
API は、1 つの非同期要求を使用して Get Route Directions API にクエリのバッチを送信する HTTP POST
要求です。 API を呼び出 Route Directions Batch
して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 700 個の クエリをバッチ処理し、API は最大 100 個のクエリを同期できます。 同期要求で API を Post Route Directions Batch
呼び出すには、「 Post Route Directions Batch Sync」を参照してください。
非同期バッチ要求を送信する
非同期 API は、比較的複雑なルート要求の大量の処理に適しています
- これにより、個別の呼び出しで結果を取得できます (複数のダウンロードが可能です)。
- 非同期 API は信頼性のために最適化されており、タイムアウトになるとは思われません。
- この API では、バッチ項目の数は 700 に制限されています。
非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドにリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 非同期応答は 14 日間格納されます。 リダイレクト URL は、有効期限が切れた後に使用された場合、404 応答を返します。
非同期バッチ要求は実行時間の長い操作であることに注意してください。 一般的な一連の操作を次に示します。
- クライアントは Route Directions Batch
POST
要求をAzure Mapsに送信します。
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
サーバーは、次のいずれかの応答を行います。
HTTP
202 Accepted
- バッチ要求が受け入れられた。HTTP
Error
- Batch 要求の処理中にエラーが発生しました。 または他Error
の400 Bad Request
状態コードを指定できます。バッチ要求が正常に受け入れられた場合、
Location
応答のヘッダーには、バッチ要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。
GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- クライアントは、
GET
手順 3 で取得した ダウンロード URL に対して要求を発行して、バッチ結果をダウンロードします。
バッチ要求の POST 本文
ルート案内クエリを送信するには、要求本文に形式のjson
配列が含まれておりbatchItems
、ヘッダーが に設定される要求をContent-Type
application/json
使用POST
します。 3 つの ルート方向 クエリを含むサンプル要求本文を次に示します。
{
"batchItems": [
{ "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
{ "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
{ "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
]
}
バッチ内の ルート案内 クエリは、プロトコル、ベース URL、パス、api-version、subscription-key を含まない 部分 URL にすぎません。 サポートされている ルート方向URI パラメーターのいずれかを受け入れます。 ルート方向クエリの文字列値は適切にエスケープする必要があります (例: " 文字は \ でエスケープする必要があります)。 また、URL エンコードも適切に行う必要があります。
非同期 API を使用すると、呼び出し元は最大 700 個のクエリをバッチ処理し、API を最大 100 個のクエリと同期でき、バッチには少なくとも 1 つの クエリを含める必要があります。
非同期バッチ結果のダウンロード
非同期バッチ結果をダウンロードするには、バッチ ダウンロード エンドポイントに要求を発行 GET
します。 このダウンロード URL は、成功したLocation
POST
バッチ要求のヘッダーから取得でき、次のようになります。
https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
バッチ結果をダウンロードするための一般的な一連の操作を次に示します。
クライアントは、ダウンロード URL を
GET
使用して要求を送信します。サーバーは、次のいずれかの応答を行います。
HTTP
202 Accepted
- バッチ要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。HTTP
200 OK
- バッチ要求が正常に処理されました。 応答本文には、すべてのバッチ結果が含まれています。
バッチ応答モデル
返されるデータ コンテンツは、非同期要求と同期要求に似ています。 非同期バッチ要求の結果をダウンロードするときに、バッチの処理が完了した場合、応答本文にはバッチ応答が含まれます。 このバッチ応答には、 summary
元のバッチ要求の一部であった を示す totalRequests
コンポーネント、 successfulRequests
つまり正常に実行されたクエリが含まれています。 バッチ応答には、 batchItems
バッチ要求内の各クエリに対する応答を含む配列も含まれます。 batchItems
には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 内の各項目にはbatchItems
、 フィールドと フィールドがstatusCode
response
含まれています。 のbatchItems
それぞれresponse
は、次のいずれかの種類です。
RouteDirections
- クエリが正常に完了した場合。Error
- クエリが失敗した場合。 この場合、応答には と がmessage
含まれますcode
。
成功した結果が 1 件、 失敗 した結果が 1 件のバッチ応答のサンプルを次 に 示します。
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"statusCode": 200,
"response": {
"routes": [
{
"summary": {
"lengthInMeters": 1758,
"travelTimeInSeconds": 387,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-17T00:49:56+00:00",
"arrivalTime": "2018-07-17T00:56:22+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1758,
"travelTimeInSeconds": 387,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-17T00:49:56+00:00",
"arrivalTime": "2018-07-17T00:56:22+00:00"
},
"points": [
{
"latitude": 47.62094,
"longitude": -122.34892
},
{
"latitude": 47.62094,
"longitude": -122.3485
},
{
"latitude": 47.62095,
"longitude": -122.3476
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 40,
"sectionType": "TRAVEL_MODE",
"travelMode": "bicycle"
}
]
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
format
|
path | True |
応答の目的の形式。 サポートされているのは |
|
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーン アカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。 |
要求本文
名前 | 型 | 説明 |
---|---|---|
batchItems |
処理するクエリの一覧。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
バッチ要求が正常に処理されました。 応答本文には、すべてのバッチ結果が含まれています。 |
|
202 Accepted |
非同期要求でのみサポートされます。 [Request Accepted]\(要求を受け入れた\): 要求は処理のために受け入れ済みです。 Location ヘッダーの URL を使用して、再試行するか、結果にアクセスしてください。 Headers Location: string |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
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 を使用すると、複数のユース ケースに対してアプリケーションを構成ベースで設定できます。
- Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。
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 submit a route direction batch request
Sample Request
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0
{
"batchItems": [
{
"query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
},
{
"query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
},
{
"query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
}
]
}
Sample Response
{
"batchItems": [
{
"statusCode": 400,
"response": {
"error": {
"code": "400 BadRequest",
"message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
}
}
},
{
"statusCode": 200,
"response": {
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1754,
"travelTimeInSeconds": 386,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:02:49+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1754,
"travelTimeInSeconds": 386,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:02:49+00:00"
},
"points": [
{
"latitude": 47.62094,
"longitude": -122.34892
},
{
"latitude": 47.62094,
"longitude": -122.3485
},
{
"latitude": 47.62095,
"longitude": -122.3476
},
{
"latitude": 47.60995,
"longitude": -122.34174
},
{
"latitude": 47.61011,
"longitude": -122.342
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 44,
"sectionType": "TRAVEL_MODE",
"travelMode": "bicycle"
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1772,
"travelTimeInSeconds": 1276,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:17:38+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1772,
"travelTimeInSeconds": 1276,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:17:38+00:00"
},
"points": [
{
"latitude": 40.75982,
"longitude": -73.98493
},
{
"latitude": 40.7601,
"longitude": -73.98483
},
{
"latitude": 40.75984,
"longitude": -73.98417
},
{
"latitude": 40.76047,
"longitude": -73.9837
},
{
"latitude": 40.77095,
"longitude": -73.9736
},
{
"latitude": 40.77114,
"longitude": -73.97356
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 47,
"sectionType": "TRAVEL_MODE",
"travelMode": "pedestrian"
}
]
}
]
}
}
],
"summary": {
"successfulRequests": 2,
"totalRequests": 3
}
}
operation-Location: URL to download the results of the long-running batch request.
定義
名前 | 説明 |
---|---|
Batch |
この型は、Batch サービスの要求本文を表します。 |
Batch |
Batch 要求オブジェクト |
Delay |
インシデントによって発生する遅延の大きさ。 これらの値は、 トラフィック インシデント詳細の取得 API の応答フィールド ty の値に対応します。 |
Driving |
操縦のポイントで左手と右側の運転を示します。 |
Effective |
このルート API を呼び出すときに使用される有効なパラメーターまたはデータ。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Guidance |
指示の種類(道路の形状の変更など)。 |
Guidance |
操縦を識別するコード。 |
Json |
応答の目的の形式。 サポートされているのは |
Junction |
操縦が行われるジャンクションのタイプ。 より大きなラウンドアバウト交差点の場合は、ラウンドアバウト交差点の開始と終了に対して 2 つの個別の命令が生成されます。 |
Lat |
緯度と経度として表される場所。 |
Response |
クエリの結果です。 クエリが正常に完了した場合は RouteDirections、それ以外の場合は ErrorResponse。 |
Response |
報告されたルート応答のセクションの種類 |
Response |
計算されたルートの移動モード。 このセクションで要求されたトランスポート モードが不可能な場合、値は に設定 |
Route | |
Route |
Route Directions Batch サービス呼び出しから返される項目。 |
Route |
このオブジェクトは、正常な Route Directions Batch サービス呼び出しから返されます。 |
Route |
ガイダンス関連の要素が含まれています。 このフィールドは、ガイダンスが要求され、使用可能な場合にのみ表示されます。 |
Route |
"右に曲がる"、"左に置く"、"フェリーに乗る"、"高速道路を取る"、"到着" など、操縦を説明する属性のセット。 |
Route |
相互に関連する命令要素のシーケンスをグループします。 シーケンス範囲は、firstInstructionIndex と lastInstructionIndex で制約されます。 人間が読み取り可能なテキスト メッセージにガイダンス (instructionType=text またはタグ付け) を要求すると、instructionGroup には、使用可能な場合に概要メッセージが返されます。 |
Route |
ポイントのリストで構成されるルートの一部の説明。 要求で指定された追加の各ウェイポイントは、返されるルートに追加の区間になります。 |
Route |
ルート セクションの概要オブジェクト。 |
Route |
最適化されたウェイ ポイント オブジェクト。 |
Route |
現在の呼び出しで使用されている有効な設定を報告します。 |
Route |
ルート セクションには、ルートの一部に関する追加情報が含まれています。 各セクションには、少なくとも 要素 |
Route |
TPEG2-TEC 標準の定義を使用したトラフィック イベントの詳細。 effectCode を含め、要素を引き起こすことができます。 |
Route |
トラフィック イベントの原因。 mainCauseCode 要素と subCauseCode 要素を含めることができます。 アイコンと説明を定義するために使用できます。 |
Route |
Summary オブジェクト |
Simple |
インシデントの種類。 現在、JAM、ROAD_WORK、ROAD_CLOSURE、またはその他にすることができます。 詳細については、「tec」を参照してください。 |
Summary |
バッチ要求の結果の概要 |
BatchRequest
この型は、Batch サービスの要求本文を表します。
名前 | 型 | 説明 |
---|---|---|
batchItems |
処理するクエリの一覧。 |
BatchRequestItem
Batch 要求オブジェクト
名前 | 型 | 説明 |
---|---|---|
query |
string |
このパラメーターには、非構造化ジオコーディング操作を実行するために使用されるクエリ文字列が含まれています。 クエリ文字列は、処理のために検索 API に逐語的に渡されます。 |
DelayMagnitude
インシデントによって発生する遅延の大きさ。 これらの値は、 トラフィック インシデント詳細の取得 API の応答フィールド ty の値に対応します。
名前 | 型 | 説明 |
---|---|---|
0 |
string |
不明。 |
1 |
string |
マイナー。 |
2 |
string |
中程度。 |
3 |
string |
メジャー。 |
4 |
string |
未定義。道路の閉鎖やその他の不定の遅延に使用されます。 |
DrivingSide
操縦のポイントで左手と右側の運転を示します。
名前 | 型 | 説明 |
---|---|---|
LEFT |
string |
左側。 |
RIGHT |
string |
右側。 |
EffectiveSetting
このルート API を呼び出すときに使用される有効なパラメーターまたはデータ。
名前 | 型 | 説明 |
---|---|---|
key |
string |
使用されるパラメーターの名前。 |
value |
string |
使用されるパラメーターの値。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
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 |
ウェイポイントに達しました。 右側にあります。 |
JsonFormat
応答の目的の形式。 サポートされているのは json
形式のみです。
名前 | 型 | 説明 |
---|---|---|
json |
string |
JunctionType
操縦が行われるジャンクションのタイプ。 より大きなラウンドアバウト交差点の場合は、ラウンドアバウト交差点の開始と終了に対して 2 つの個別の命令が生成されます。
名前 | 型 | 説明 |
---|---|---|
BIFURCATION |
string |
分岐 |
REGULAR |
string |
レギュラー |
ROUNDABOUT |
string |
ロータリー |
LatLongPair
緯度と経度として表される場所。
名前 | 型 | 説明 |
---|---|---|
latitude |
number |
Latitude プロパティ |
longitude |
number |
Longitude プロパティ |
Response
クエリの結果です。 クエリが正常に完了した場合は RouteDirections、それ以外の場合は ErrorResponse。
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
|
formatVersion |
string |
Format Version プロパティ |
optimizedWaypoints |
ウェイポイントの最適化されたシーケンス。 元の最適化されたリストに対してユーザーが指定したウェイポイント シーケンスからのインデックスが表示されます。 たとえば、応答は次のようになります。
は、元のシーケンスが [0, 1, 2] であり、最適化されたシーケンスが [1, 2, 0] であることを意味します。 インデックスは 0 で始まるので、元の は "first, second, third" ですが、最適化は "second, third, first" です。 |
|
report |
現在の呼び出しで使用されている有効な設定を報告します。 |
|
routes |
Route[] |
Routes 配列 |
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 |
要求パラメーター |
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 |
ガイダンス関連の要素が含まれています。 このフィールドは、ガイダンスが要求され、使用可能な場合にのみ表示されます。 |
|
legs |
Route |
脚の配列 |
sections |
Sections 配列 |
|
summary |
Summary オブジェクト |
RouteDirectionsBatchItem
Route Directions Batch サービス呼び出しから返される項目。
名前 | 型 | 説明 |
---|---|---|
response |
クエリの結果です。 クエリが正常に完了した場合は RouteDirections、それ以外の場合は ErrorResponse。 |
|
statusCode |
integer |
HTTP 要求の状態コード。 |
RouteDirectionsBatchResult
このオブジェクトは、正常な Route Directions Batch サービス呼び出しから返されます。
名前 | 型 | 説明 |
---|---|---|
batchItems |
バッチ結果を含む配列。 |
|
summary |
バッチ要求の結果の概要 |
RouteGuidance
ガイダンス関連の要素が含まれています。 このフィールドは、ガイダンスが要求され、使用可能な場合にのみ表示されます。
名前 | 型 | 説明 |
---|---|---|
instructionGroups |
相互に関連する命令要素のシーケンスをグループします。 |
|
instructions |
操作を記述する命令の一覧。 |
RouteInstruction
"右に曲がる"、"左に置く"、"フェリーに乗る"、"高速道路を取る"、"到着" など、操縦を説明する属性のセット。
名前 | 型 | 説明 |
---|---|---|
combinedMessage |
string |
操縦のための人間が判読できるメッセージと、次の指示からのメッセージを組み合わせた。 場合によっては、2 つの連続する命令を 1 つの命令に結合して、従いやすくすることができます。 この場合、possibleCombineWithNext フラグは true になります。 例:
命令 10 で指定できるCombineWithNext フラグは true です。 これは、コード化されたガイダンスのクライアントに対して、命令 11 と組み合わせることができることを示します。 指示は、人間が判読できるガイダンスを要求するクライアントに対して自動的に組み合わされます。 combinedMessage フィールドには、結合されたメッセージが含まれます。
|
countryCode |
string |
3 文字 の ISO 3166-1 alpha-3 国コード。 例: 米国 |
drivingSide |
操縦のポイントで左手と右側の運転を示します。 |
|
exitNumber |
string |
現在の操縦によって取得された高速道路出口の数。 出口に複数の終了番号がある場合は、"," で区切られ、"-" で集計される場合があります (例: "10,13-15")。 |
instructionType |
指示の種類(道路の形状の変更など)。 |
|
junctionType |
操縦が行われるジャンクションのタイプ。 より大きなラウンドアバウト交差点の場合は、ラウンドアバウト交差点の開始と終了に対して 2 つの個別の命令が生成されます。 |
|
maneuver |
操縦を識別するコード。 |
|
message |
string |
操縦のための人間が判読できるメッセージ。 |
point |
緯度と経度として表される場所。 |
|
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 がターン命令を示す場合:
junctionType が分岐命令を示す場合:
|
RouteInstructionGroup
相互に関連する命令要素のシーケンスをグループします。 シーケンス範囲は、firstInstructionIndex と lastInstructionIndex で制約されます。 人間が読み取り可能なテキスト メッセージにガイダンス (instructionType=text またはタグ付け) を要求すると、instructionGroup には、使用可能な場合に概要メッセージが返されます。
名前 | 型 | 説明 |
---|---|---|
firstInstructionIndex |
integer |
命令内の最初の命令と、このグループに属するインデックス。 |
groupLengthInMeters |
integer |
グループの長さ。 |
groupMessage |
string |
人間が判読できるテキスト メッセージがガイダンスを求められた場合の概要メッセージ (instructionType=text またはタグ付け)。 |
lastInstructionIndex |
integer |
命令の最後の命令のインデックスで、このグループに属します。 |
RouteLeg
ポイントのリストで構成されるルートの一部の説明。 要求で指定された追加の各ウェイポイントは、返されるルートに追加の区間になります。
名前 | 型 | 説明 |
---|---|---|
points |
Points 配列 |
|
summary |
ルート セクションの概要オブジェクト。 |
RouteLegSummary
ルート セクションの概要オブジェクト。
名前 | 型 | 説明 |
---|---|---|
arrivalTime |
string |
ルートまたは区間の推定到着時間。 時刻は UTC です。 |
batteryConsumptionInkWh |
number |
電力消費量モデルを使用した推定電力消費量 (キロワット時間 (kWh)。 vehicleEngineType が electric に設定され、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 |
このルート API を呼び出すときに使用される有効なパラメーターまたはデータ。 |
RouteSection
ルート セクションには、ルートの一部に関する追加情報が含まれています。 各セクションには、少なくとも 要素 startPointIndex
、、 endPointIndex
および sectionType
が含まれています。
名前 | 型 | 説明 |
---|---|---|
delayInSeconds |
integer |
インシデントによって発生する遅延 (秒単位)。 |
effectiveSpeedInKmh |
integer |
インシデントの有効速度 (km/h) は、その全体の長さの平均です。 |
endPointIndex |
integer |
このセクションが適用されるルートの最後のポイント (オフセット 0) のインデックス。 |
magnitudeOfDelay |
インシデントによって発生する遅延の大きさ。 これらの値は、 トラフィック インシデント詳細の取得 API の応答フィールド ty の値に対応します。 |
|
sectionType |
報告されたルート応答のセクションの種類 |
|
simpleCategory |
インシデントの種類。 現在、JAM、ROAD_WORK、ROAD_CLOSURE、またはその他にすることができます。 詳細については、「tec」を参照してください。 |
|
startPointIndex |
integer |
このセクションが適用されるルートの最初のポイント (オフセット 0) のインデックス。 |
tec |
TPEG2-TEC 標準の定義を使用したトラフィック イベントの詳細。 effectCode を含め、要素を引き起こすことができます。 |
|
travelMode |
計算されたルートの移動モード。 このセクションで要求されたトランスポート モードが不可能な場合、値は に設定 |
RouteSectionTec
TPEG2-TEC 標準の定義を使用したトラフィック イベントの詳細。 effectCode を含め、要素を引き起こすことができます。
名前 | 型 | 説明 |
---|---|---|
causes |
配列の原因 |
|
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 が将来の場合、移動時間は時間に依存する履歴トラフィック データを使用して計算されます。 |
SimpleCategory
インシデントの種類。 現在、JAM、ROAD_WORK、ROAD_CLOSURE、またはその他にすることができます。 詳細については、「tec」を参照してください。
名前 | 型 | 説明 |
---|---|---|
JAM |
string |
交通渋滞。 |
OTHER |
string |
その他。 |
ROAD_CLOSURE |
string |
道路閉鎖。 |
ROAD_WORK |
string |
道路工事。 |
Summary
バッチ要求の結果の概要
名前 | 型 | 説明 |
---|---|---|
successfulRequests |
integer |
バッチ内の成功した要求の数 |
totalRequests |
integer |
バッチ内の要求の合計数 |