Route - Post Route Directions Batch

リファレンス

サービス:: Maps

API バージョン:: 1.0

単一の非同期要求で Get Route Directions API にクエリのバッチを送信するために使用します。

Post Route Directions Batch API は、1 つの非同期要求を使用して Get Route Directions API にクエリのバッチを送信する HTTP POST 要求です。 Route Directions Batch API を呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。非同期 API を使用すると、呼び出し元は最大 700 個のクエリをバッチ処理し、最大 100 個のクエリ API を同期できます。同期要求で Post Route Directions Batch API を呼び出すには、「ルートのルート案内後のバッチ同期」を参照してください。

非同期バッチ要求の送信

非同期 API は、比較的複雑なルート要求の大量の処理に適しています

これにより、個別の呼び出しで結果を取得できます (複数のダウンロードが可能です)。
非同期 API は信頼性のために最適化されており、タイムアウトになるとは限りません。
バッチ項目の数は、この API の 700 に制限されています。

非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドのリダイレクト URL に沿って 202 応答コードを返します。この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。非同期応答は、24 時間格納されます。リダイレクト 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 要求の処理中にエラーが発生しました。これは、400 Bad Request またはその他の Error 状態コードのいずれかです。
バッチ要求が正常に受け入れられた場合、応答の Location ヘッダーには、バッチ要求の結果をダウンロードするための URL が含まれます。この状態 URI は次のようになります。

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}

クライアントは、手順 3 で取得した ダウンロード URL に GET 要求を発行して、バッチ結果をダウンロードします。

バッチ要求の POST 本文

ルートルート案内 クエリを送信するには、要求本文に batchItems 配列が json 形式で格納され、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 バージョン、サブスクリプションキーをしない部分的な URL にすぎません。サポートされている ルートのルート案内URI パラメーター受け取ることができます。クエリルートルートの文字列値は、適切にエスケープする必要があります (例: " 文字は \ でエスケープする必要があります)、また、適切に URL エンコードする必要があります。

非同期 API を使用すると、呼び出し元は最大 700 個のクエリをバッチ処理し、最大で 100 個のクエリ API を同期でき、バッチには少なくとも 1 つのクエリ含める必要があります。

非同期バッチ結果のダウンロード

非同期バッチ結果をダウンロードするには、バッチダウンロードエンドポイントに GET 要求を発行します。この ダウンロード URL は、成功した POST バッチ要求の Location ヘッダーから取得でき、次のようになります。

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 - バッチ要求が正常に処理されました。応答本文には、すべてのバッチ結果が含まれています。

バッチ応答モデル

返されるデータコンテンツは、非同期要求と同期要求に似ています。非同期バッチ要求の結果をダウンロードするときに、バッチの処理が完了した場合、応答本文にはバッチ応答が含まれます。このバッチ応答には、元のバッチ要求の一部であった totalRequests と、正常に実行されたクエリ successfulRequests示す summary コンポーネントが含まれています。バッチ応答には、バッチ要求内の各クエリに対する応答を含む batchItems 配列も含まれます。 batchItems には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。 batchItems の各項目には、statusCode フィールドと response フィールドが含まれています。 batchItems の各 response は、次のいずれかの種類です。

RouteDirections - クエリが正常に完了した場合。
Error - クエリが失敗した場合。この場合、応答には code と message が含まれます。

成功したが 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	JsonFormat	応答の目的の形式。 `json` 形式のみがサポートされています。
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	BatchRequestItem[]	処理するクエリの一覧。

応答

名前	型	説明
200 OK	RouteDirectionsBatchResult	バッチ要求が正常に処理されました。応答本文には、すべてのバッチ結果が含まれています。
202 Accepted		非同期要求でのみサポートされます。受け入れ済み要求: 要求は処理のために受け入れ済みです。 Location ヘッダーの URL を使用して、再試行するか、結果にアクセスしてください。ヘッダー Location: string
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

名前

型

説明

200 OK

RouteDirectionsBatchResult

バッチ要求が正常に処理されました。応答本文には、すべてのバッチ結果が含まれています。

202 Accepted

非同期要求でのみサポートされます。 受け入れ済み要求: 要求は処理のために受け入れ済みです。 Location ヘッダーの URL を使用して、再試行するか、結果にアクセスしてください。

ヘッダー

Location: string

Other Status Codes

ErrorResponse

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

セキュリティ

AADToken

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

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

筆記

このセキュリティ定義 では、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 プラットフォームの概要」を参照してください。

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

スコープ

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

subscription-key

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

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

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

型: apiKey
/: query

SAS Token

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

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

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

型: apiKey
/: header

例

Successfully submit a route direction batch request

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

状態コード:: 202

operation-Location: URL to download the results of the long-running batch request.

定義

名前	説明
BatchRequest	この型は、Batch サービスの要求本文を表します。
BatchRequestItem	Batch 要求オブジェクト
DelayMagnitude	インシデントによって発生した遅延の大きさ。これらの値は、Get Traffic Incident Detail APIの応答フィールド ty の値に対応します。
DrivingSide	操縦のポイントでの左手と右側の運転を示します。
EffectiveSetting	このルート API を呼び出すときに使用される有効なパラメーターまたはデータ。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GuidanceInstructionType	指示の種類 (例: 道路の形状のターンまたは変更)。
GuidanceManeuver	操縦を識別するコード。
JsonFormat	応答の目的の形式。 `json` 形式のみがサポートされています。
JunctionType	操縦が行われるジャンクションの種類。より大きなラウンドアバウト交差点では、ラウンドアバウト交差点に入って離れる 2 つの個別の命令が生成されます。
LatLongPair	緯度と経度として表される場所。
Response	クエリの結果。クエリが正常に完了した場合は RouteDirections、それ以外の場合は ErrorResponse。
ResponseSectionType	報告されたルート応答のセクションの種類
ResponseTravelMode	計算されたルートの移動モード。このセクションで要求されたトランスポートモードが不可能な場合、値は `other` に設定されます
Route
RouteDirectionsBatchItem	Route Directions Batch サービス呼び出しから返された項目。
RouteDirectionsBatchResult	このオブジェクトは、Route Directions Batch サービス呼び出しが成功した場合に返されます。
RouteGuidance	ガイダンス関連の要素が含まれています。このフィールドは、ガイダンスが要求され、使用可能な場合にのみ表示されます。
RouteInstruction	操縦を説明する一連の属性 (例: "右に曲がる"、"左に保つ"、"フェリーに乗る"、"高速道路に乗る"、"到着" など)。
RouteInstructionGroup	相互に関連する命令要素のシーケンスをグループ化します。シーケンス範囲は、firstInstructionIndex と lastInstructionIndex で制約されます。人間が判読できるテキストメッセージにガイダンス (instructionType=text またはタグ付け) が要求されると、instructionGroup には、使用可能な場合に要約メッセージが返されます。
RouteLeg	ポイントのリストで構成されるルートの一部の説明。要求で指定された各追加のウェイポイントは、返されたルートに追加の区間になります。
RouteLegSummary	ルートセクションの概要オブジェクト。
RouteOptimizedWaypoint	最適化されたウェイポイントオブジェクト。
RouteReport	現在の呼び出しで使用されている有効な設定を報告します。
RouteSection	ルートセクションには、ルートの一部に関する追加情報が含まれています。各セクションには、少なくとも `startPointIndex`、`endPointIndex`、および `sectionType`要素が含まれています。
RouteSectionTec	TPEG2-TEC 標準の定義を使用した、トラフィックイベントの詳細。 effectCode を含め、要素を作成できます。
RouteSectionTecCause	トラフィックイベントの原因。 mainCauseCode 要素と subCauseCode 要素を含めることができます。アイコンと説明を定義するために使用できます。
RouteSummary	Summary オブジェクト
SimpleCategory	インシデントの種類。現在、JAM、ROAD_WORK、ROAD_CLOSURE、またはその他にすることができます。詳細については、「tec」を参照してください。
Summary	バッチ要求の結果の概要

BatchRequest

この型は、Batch サービスの要求本文を表します。

名前	型	説明
batchItems	BatchRequestItem[]	処理するクエリの一覧。

BatchRequestItem

Batch 要求オブジェクト

名前	型	説明
query	string	このパラメーターには、非構造化ジオコーディング操作を実行するために使用されるクエリ文字列が含まれています。クエリ文字列は、処理のために検索 API に逐語的に渡されます。

DelayMagnitude

インシデントによって発生した遅延の大きさ。これらの値は、Get Traffic Incident Detail 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	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

エラー応答

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

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	JavaScript オブジェクト表記データ交換形式をする

JunctionType

操縦が行われるジャンクションの種類。より大きなラウンドアバウト交差点では、ラウンドアバウト交差点に入って離れる 2 つの個別の命令が生成されます。

名前	型	説明
BIFURCATION	string	分岐
REGULAR	string	レギュラー
ROUNDABOUT	string	ロータリー

LatLongPair

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

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

Response

クエリの結果。クエリが正常に完了した場合は RouteDirections、それ以外の場合は ErrorResponse。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。
formatVersion	string	[バージョンの書式設定] プロパティ
optimizedWaypoints	RouteOptimizedWaypoint[]	ウェイポイントの最適化されたシーケンス。元の最適化されたリストに対してユーザーが指定したウェイポイントシーケンスからのインデックスが表示されます。たとえば、応答は次のようになります。 `<optimizedWaypoints> <waypoint providedIndex="0" optimizedIndex="1"/> <waypoint providedIndex="1" optimizedIndex="2"/> <waypoint providedIndex="2" optimizedIndex="0"/> </optimizedWaypoints>` は、元のシーケンスが [0, 1, 2] であり、最適化されたシーケンスが [1, 2, 0] であることを意味します。インデックスは 0 で始まるので、元のインデックスは "first, second, third" ですが、最適化は "second, third, first" です。
report	RouteReport	現在の呼び出しで使用されている有効な設定を報告します。
routes	Route[]	Routes 配列

ResponseSectionType

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

名前	型	説明
CARPOOL	string	カープール(HOV/高占有車)レーンの使用を必要とするルートのセクション。
CAR_TRAIN	string	車または電車であるルートのセクション。
COUNTRY	string	ルートが含まれる国/地域を示すセクション。
FERRY	string	フェリーであるルートのセクション。
MOTORWAY	string	高速道路であるルートのセクション。
PEDESTRIAN	string	歩行者にのみ適したルートのセクション。
TOLL_ROAD	string	通行料の支払いを必要とするルートのセクション。
TOLL_VIGNETTE	string	有料ビネットが存在する必要があるルートのセクション。
TRAFFIC	string	トラフィック情報を含むルートのセクション。
TRAVEL_MODE	string	要求パラメーター `travelMode`に関連するセクション。
TUNNEL	string	トンネルであるルートのセクション。
URBAN	string	市街地内に位置するルートのセクション。

ResponseTravelMode

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

名前	型	説明
bicycle	string	返されるルートは、自転車レーンの使用を含め、自転車用に最適化されています。
bus	string	返されるルートは、バス専用レーンの使用を含め、バス用に最適化されています。 BETA 機能。
car	string	返されるルートは、自動車用に最適化されています。
motorcycle	string	返されるルートは、オートバイ用に最適化されています。 BETA 機能。
other	string	このセクションでは、指定されたトランスポートモードを使用できません。
pedestrian	string	返されるルートは、歩道の使用を含め、歩行者向けに最適化されています。
taxi	string	返されるルートは、タクシー用に最適化されています。 BETA 機能。
truck	string	返されるルートは、トラックなどの商用車両用に最適化されています。
van	string	返されるルートはバン用に最適化されています。 BETA 機能。

Route

名前	型	説明
guidance	RouteGuidance	ガイダンス関連の要素が含まれています。このフィールドは、ガイダンスが要求され、使用可能な場合にのみ表示されます。
legs	RouteLeg[]	Legs 配列
sections	RouteSection[]	Sections 配列
summary	RouteSummary	Summary オブジェクト

RouteDirectionsBatchItem

Route Directions Batch サービス呼び出しから返された項目。

名前	型	説明
response	Response	クエリの結果。クエリが正常に完了した場合は RouteDirections、それ以外の場合は ErrorResponse。
statusCode	integer	HTTP 要求の状態コード。

RouteDirectionsBatchResult

このオブジェクトは、Route Directions Batch サービス呼び出しが成功した場合に返されます。

名前	型	説明
batchItems	RouteDirectionsBatchItem[]	バッチ結果を含む配列。
summary	Summary	バッチ要求の結果の概要

RouteGuidance

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

名前	型	説明
instructionGroups	RouteInstructionGroup[]	相互に関連する命令要素のシーケンスをグループ化します。
instructions	RouteInstruction[]	操作を説明する命令の一覧。

RouteInstruction

操縦を説明する一連の属性 (例: "右に曲がる"、"左に保つ"、"フェリーに乗る"、"高速道路に乗る"、"到着" など)。

名前	型	説明
combinedMessage	string	操作のための人間が判読できるメッセージと、次の命令からのメッセージを組み合わせたメッセージ。場合によっては、2 つの連続する命令を 1 つの命令に結合して、簡単に従うことができます。この場合、possibleCombineWithNext フラグは true になります。例えば： `10. Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam 11. Follow Einsteinweg/A10/E22 towards Ring Amsterdam` 命令 10 の possibleCombineWithNext フラグは true です。これは、コード化されたガイダンスのクライアントに対して、命令 11 と組み合わせることができることを示します。この手順は、人間が判読できるガイダンスを要求するクライアントに対して自動的に組み合わされます。 combinedMessage フィールドには、結合されたメッセージが含まれています。 `Turn left onto Einsteinweg/A10/E22 towards Ring Amsterdam then follow Einsteinweg/A10/E22 towards Ring Amsterdam.`
countryCode	string	ISO 3166-1 alpha-3 国コード 3 文字。例: 米国
drivingSide	DrivingSide	操縦のポイントでの左手と右側の運転を示します。
exitNumber	string	現在の操縦によって取得された高速道路出口の数。出口に複数の終了番号がある場合は、""" で区切られ、"-" で集計される可能性があります (例: "10,13-15")。
instructionType	GuidanceInstructionType	指示の種類 (例: 道路の形状のターンまたは変更)。
junctionType	JunctionType	操縦が行われるジャンクションの種類。より大きなラウンドアバウト交差点では、ラウンドアバウト交差点に入って離れる 2 つの個別の命令が生成されます。
maneuver	GuidanceManeuver	操縦を識別するコード。
message	string	操縦のための人間が判読できるメッセージ。
point	LatLongPair	緯度と経度として表される場所。
pointIndex	integer	命令のポイントに対応するポリラインの "ポイント" のリスト内のポイントのインデックス。
possibleCombineWithNext	boolean	必要に応じて、命令を次の命令と組み合わせることができます。これを使用して、"左に曲がって右に曲がる" などのメッセージを作成できます。
roadNumbers	string[]	操縦後の次に重要な道路セグメントの道路番号、または従う道路の道路番号。例: ["E34", "N205"]
roundaboutExitNumber	integer	これは、ラウンドアバウトで実行する出口を示します。
routeOffsetInMeters	integer	ルートの始点から命令のポイントまでの距離。
signpostText	string	操縦または従うべき方向に最も関連する道標のテキスト。
stateCode	string	ISO 3166-2 コードの 2 番目の部分で表される国の下位区分 (州など)。これは、米国、カナダ、メキシコなどの一部の国/地域でのみ使用できます。
street	string	操縦後の次の重要な道路セグメントの通り名、または従う必要がある通りの道路名。
travelTimeInSeconds	integer	routeOffsetInMeters に対応するポイントまでの推定移動時間。
turnAngleInDecimalDegrees	integer	命令の方向を示します。 junctionType がターン命令を示す場合: 180 = U ターン [-179, -1] = 左折 0 = 直線 ('0 度' ターン) [1, 179] = 右折 junctionType が分岐命令を示す場合: <0 - 左のままにする >0 - 右に保つ

RouteInstructionGroup

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

名前	型	説明
firstInstructionIndex	integer	命令内の最初の命令のインデックスで、このグループに属しています。
groupLengthInMeters	integer	グループの長さ。
groupMessage	string	人間が判読できるテキストメッセージにガイダンスが要求されたときの概要メッセージ (instructionType=text またはタグ付け)。
lastInstructionIndex	integer	命令内の最後の命令のインデックスで、このグループに属しています。

RouteLeg

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

名前	型	説明
points	LatLongPair[]	Points 配列
summary	RouteLegSummary	ルートセクションの概要オブジェクト。

RouteLegSummary

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

名前	型	説明
arrivalTime	string	ルートまたは区間の推定到着時間。時刻は UTC です。
batteryConsumptionInkWh	number	電力消費量モデルを使用したキロワット時 (kWh) の推定電力消費量。 vehicleEngineType が電気に設定され、constantSpeedConsumptionInkWhPerHundredkm が指定されている場合に含まれます。 batteryConsumptionInkWh の値には、再充電された電気エネルギーが含まれているため、負の値 (エネルギーの増加を示します) になる可能性があります。 maxChargeInkWh と currentChargeInkWh の両方が指定されている場合、バッテリの充電レベルが maxChargeInkWh を超えないように、再循環が制限されます。 maxChargeInkWh も currentChargeInkWh も指定されていない場合、消費計算では制約のない回復が想定されます。
departureTime	string	ルートまたは区間の推定出発時間。時刻は UTC です。
fuelConsumptionInLiters	number	燃焼消費モデルを用いた推定燃料消費量(リットル単位)。 vehicleEngineType が燃焼に設定され、constantSpeedConsumptionInLitersPerHundredkm が指定されている場合に含まれます。値は負以外になります。
historicTrafficTravelTimeInSeconds	integer	時間依存の履歴トラフィックデータを使用して計算された推定移動時間。 computeTravelTimeFor = all がクエリで使用されている場合にのみ含まれます。
lengthInMeters	integer	Length In Meters プロパティ
liveTrafficIncidentsTravelTimeInSeconds	integer	リアルタイム速度データを使用して計算された推定移動時間。 computeTravelTimeFor = all がクエリで使用されている場合にのみ含まれます。
noTrafficTravelTimeInSeconds	integer	交通状況 (輻輳など) により、ルートに遅延がないかのように計算された推定移動時間。 computeTravelTimeFor = all がクエリで使用されている場合にのみ含まれます。
trafficDelayInSeconds	integer	トラフィック情報に従ってリアルタイムインシデントによって発生した推定遅延 (秒)。将来の出発時刻で計画されているルートの場合、遅延は常に 0 です。さまざまな種類のトラフィック情報を使用して追加の移動時間を返すには、パラメーター computeTravelTimeFor=all を追加する必要があります。
travelTimeInSeconds	integer	リアルタイムトラフィックによる遅延を含む推定移動時間 (秒)。 traffic=false travelTimeInSeconds の場合でも、トラフィックによる遅延が含まれていることに注意してください。 DepartAt が将来の場合、移動時間は時間依存の履歴トラフィックデータを使用して計算されます。

RouteOptimizedWaypoint

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

名前	型	説明
optimizedIndex	integer	システムからの最適化されたウェイポイントインデックス。
providedIndex	integer	ユーザーによって提供されるウェイポイントインデックス。

RouteReport

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

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

RouteSection

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

名前	型	説明
delayInSeconds	integer	インシデントが原因で発生した遅延 (秒単位)。
effectiveSpeedInKmh	integer	インシデントの効果的な速度 (km/h) は、その全体の長さの平均です。
endPointIndex	integer	このセクションが適用されるルートの最後のポイント (オフセット 0) のインデックス。
magnitudeOfDelay	DelayMagnitude	インシデントによって発生した遅延の大きさ。これらの値は、Get Traffic Incident Detail APIの応答フィールド ty の値に対応します。
sectionType	ResponseSectionType	報告されたルート応答のセクションの種類
simpleCategory	SimpleCategory	インシデントの種類。現在、JAM、ROAD_WORK、ROAD_CLOSURE、またはその他にすることができます。詳細については、「tec」を参照してください。
startPointIndex	integer	このセクションが適用されるルートの最初のポイント (オフセット 0) のインデックス。
tec	RouteSectionTec	TPEG2-TEC 標準の定義を使用した、トラフィックイベントの詳細。 effectCode を含め、要素を作成できます。
travelMode	ResponseTravelMode	計算されたルートの移動モード。このセクションで要求されたトランスポートモードが不可能な場合、値は `other` に設定されます

RouteSectionTec

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

名前	型	説明
causes	RouteSectionTecCause[]	配列の原因
effectCode	integer	トラフィックフローへの影響。 TPEG2-TEC 標準で定義されている tec001:EffectCode テーブルの値を格納します。重大度に応じてトラフィックイベントを色分けするために使用できます。

RouteSectionTecCause

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

名前	型	説明
mainCauseCode	integer	トラフィックイベントの主な原因。 TPEG2-TEC 標準で定義されている tec002:CauseCode テーブルの値を格納します。
subCauseCode	integer	トラフィックイベントのサブキュー。 TPEG2-TEC 標準で定義されている mainCauseCode によって定義されたサブ原因テーブルの値を格納します。

RouteSummary

Summary オブジェクト

名前	型	説明
arrivalTime	string	ルートまたは区間の推定到着時間。時刻は UTC です。
departureTime	string	ルートまたは区間の推定出発時間。時刻は UTC です。
lengthInMeters	integer	Length In Meters プロパティ
trafficDelayInSeconds	integer	トラフィック情報に従ってリアルタイムインシデントによって発生した推定遅延 (秒)。将来の出発時刻で計画されているルートの場合、遅延は常に 0 です。さまざまな種類のトラフィック情報を使用して追加の移動時間を返すには、パラメーター computeTravelTimeFor=all を追加する必要があります。
travelTimeInSeconds	integer	リアルタイムトラフィックによる遅延を含む推定移動時間 (秒)。 traffic=false travelTimeInSeconds の場合でも、トラフィックによる遅延が含まれていることに注意してください。 DepartAt が将来の場合、移動時間は時間依存の履歴トラフィックデータを使用して計算されます。

SimpleCategory

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

名前	型	説明
JAM	string	交通渋滞。
OTHER	string	他。
ROAD_CLOSURE	string	道路閉鎖。
ROAD_WORK	string	道路工事。

Summary

バッチ要求の結果の概要

名前	型	説明
successfulRequests	integer	バッチ内の成功した要求の数
totalRequests	integer	バッチ内の要求の合計数

次の方法で共有

Route - Post Route Directions Batch

非同期バッチ要求の送信

バッチ要求の POST 本文

非同期バッチ結果のダウンロード

バッチ応答モデル

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

AADToken

筆記

スコープ

subscription-key

SAS Token

例

Successfully submit a route direction batch request

要求のサンプル

応答のサンプル

定義

BatchRequest

BatchRequestItem

DelayMagnitude

DrivingSide

EffectiveSetting

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuidanceInstructionType

GuidanceManeuver

JsonFormat

JunctionType

LatLongPair

Response

ResponseSectionType

ResponseTravelMode

Route

RouteDirectionsBatchItem

RouteDirectionsBatchResult

RouteGuidance

RouteInstruction

RouteInstructionGroup

RouteLeg

RouteLegSummary

RouteOptimizedWaypoint

RouteReport

RouteSection

RouteSectionTec

RouteSectionTecCause

RouteSummary

SimpleCategory

Summary

その他のリソース