@azure-rest/maps-route package

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

Batch 要求オブジェクト

Batch API から返される項目。 'response' プロパティを使用して拡張します。

このオブジェクトは、成功した Batch サービス呼び出しから返されます。 'batchItems' プロパティを使用して拡張します。

バッチ要求の結果の概要

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

エラーの詳細。

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

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

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

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

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

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

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

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

GeoJson MultiPointに含まれるデータ。

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

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

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

GeoJson Pointに含まれるデータ。

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

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

ルート案内の事後本文パラメーター。

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

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

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

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

に適用: 価格 レベルを参照してください。

出発地と目的地の間のルートを返し、指定されている場合はウェイポイントを通過します。 ルートでは、現在のトラフィックや、要求された曜日と時間帯の一般的な道路速度などの要因が考慮されます。

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

ルーティング サービスでは、車両固有の従量課金モデルの詳細な説明に関するパラメーターのセットが提供されます。 関連 概念とパラメーターの詳細については、従量課金モデルの を確認してください。

に適用: 価格 レベルを参照してください。

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

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

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

バッチ結果をダウンロードするための一般的な一連の操作を次に示します。

1. クライアントは、ダウンロード URLを使用して GET 要求を送信します。

2. サーバーは、次のいずれかの応答を返します。

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

に適用: 価格 レベルを参照してください。

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

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

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

バッチ結果をダウンロードするための一般的な一連の操作を次に示します。

1. クライアントは、ダウンロード URLを使用して GET 要求を送信します。

2. サーバーは、次のいずれかの応答を返します。

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

に適用: 価格 レベルを参照してください。

出発地と目的地の間のルートを返し、指定されている場合はウェイポイントを通過します。 ルートでは、現在のトラフィックや、要求された曜日と時間帯の一般的な道路速度などの要因が考慮されます。

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

ルーティング サービスでは、車両固有の従量課金モデルの詳細な説明に関するパラメーターのセットが提供されます。 関連 概念とパラメーターの詳細については、従量課金モデルの を確認してください。

に適用: 価格 レベルを参照してください。

出発地と目的地の間のルートを返し、指定されている場合はウェイポイントを通過します。 ルートでは、現在のトラフィックや、要求された曜日と時間帯の一般的な道路速度などの要因が考慮されます。

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

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

に適用: 価格 レベルを参照してください。

出発地と目的地の間のルートを返し、指定されている場合はウェイポイントを通過します。 ルートでは、現在のトラフィックや、要求された曜日と時間帯の一般的な道路速度などの要因が考慮されます。

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

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

に適用: 価格 レベルを参照してください。

マトリックス ルート要求が正常に受け入れられた場合、応答の Location ヘッダーには、要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

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

同期結果のダウンロード

ルート マトリックス同期 API に対して POST 要求を行うと、成功した要求と応答配列に対して 200 応答コードが返されます。 応答本文にはデータが含まれるため、後で結果を取得することはできません。

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

要求が 202 Accepted 応答を発行すると、非同期パイプラインを使用して要求が処理されます。 応答の location ヘッダーで非同期要求の進行状況を確認する URL が表示されます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

location ヘッダーによって提供される URL は、GET 要求が発行されたときに次の応答を返します。

HTTP 202 Accepted - マトリックス要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

HTTP 200 OK - マトリックス要求が正常に処理されました。 応答本文には、すべての結果が含まれています。

に適用: 価格 レベルを参照してください。

マトリックス ルート要求が正常に受け入れられた場合、応答の Location ヘッダーには、要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

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

同期結果のダウンロード

ルート マトリックス同期 API に対して POST 要求を行うと、成功した要求と応答配列に対して 200 応答コードが返されます。 応答本文にはデータが含まれるため、後で結果を取得することはできません。

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

要求が 202 Accepted 応答を発行すると、非同期パイプラインを使用して要求が処理されます。 応答の location ヘッダーで非同期要求の進行状況を確認する URL が表示されます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

location ヘッダーによって提供される URL は、GET 要求が発行されたときに次の応答を返します。

HTTP 202 Accepted - マトリックス要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

HTTP 200 OK - マトリックス要求が正常に処理されました。 応答本文には、すべての結果が含まれています。

ルート範囲 (Isochrone) API

に適用: 価格 レベルを参照してください。

このサービスは、指定された燃料、エネルギー、時間、または距離の予算に基づいて、出発地から到達できる一連の場所を計算します。 ポリゴン境界 (等時線) は、原点の結果である正確な多角形の中心と同様に、反時計回りの方向で返されます。

返されるポリゴンは、ジオメトリ内の検索 などの処理を行い、指定されたアイソクロネ内の POI を検索するために使用できます。

ルート範囲 (Isochrone) API

に適用: 価格 レベルを参照してください。

このサービスは、指定された燃料、エネルギー、時間、または距離の予算に基づいて、出発地から到達できる一連の場所を計算します。 ポリゴン境界 (等時線) は、原点の結果である正確な多角形の中心と同様に、反時計回りの方向で返されます。

返されるポリゴンは、ジオメトリ内の検索 などの処理を行い、指定されたアイソクロネ内の POI を検索するために使用できます。

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

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

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

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

Matrix の結果オブジェクト

座標の行列を持つオブジェクト。

このオブジェクトは、成功したルート マトリックス呼び出しから返されます。 たとえば、2 つのオリジンと 3 つの変換先が指定されている場合、それぞれに 3 つの要素を含む 2 つの配列が存在します。 各要素の内容は、クエリで提供されるオプションによって異なります。

入力マトリックス内の現在のセルの Response オブジェクト。

Summary オブジェクト

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

到達可能範囲

このオブジェクトは、ルート到達可能範囲呼び出しが成功した場合に返されます

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

Route Directions Batch API

に適用: 価格 レベルを参照してください。

Route Directions Batch API は、単一の API 呼び出しを使用して、Route Directions API にクエリのバッチを送信します。 Route Directions Batch API を呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 700 個の クエリをバッチ処理し、最大 100 個の クエリ API を同期できます。

非同期バッチ要求の送信

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

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

非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドのリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 非同期応答は、14 日間格納されます。 リダイレクト URL は、有効期限後に使用された場合、404 応答を返します。

非同期バッチ要求は実行時間の長い要求であることに注意してください。 一般的な一連の操作を次に示します。

1. クライアントが Route Directions Batch POST 要求を Azure Maps に送信する

2. サーバーは、次のいずれかの応答を返します。

   HTTP 202 Accepted - バッチ要求が受け入れされました。

   HTTP Error - Batch 要求の処理中にエラーが発生しました。 これは、400 Bad Request またはその他の Error 状態コードのいずれかです。

3. バッチ要求が正常に受け入れられた場合、応答の Location ヘッダーには、バッチ要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 注:- AUTH 情報 (サブスクリプション キー/azure_auth - セキュリティを参照) を実行する前に、状態 URI に追加してください。
4. クライアントは、手順 3 で取得 ダウンロード URL に 要求を発行して、バッチ結果をダウンロードします。

バッチ要求の 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}

バッチ結果をダウンロードするための一般的な一連の操作を次に示します。

1. クライアントは、ダウンロード URLを使用して GET 要求を送信します。

2. サーバーは、次のいずれかの応答を返します。

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

Route Directions Batch API

に適用: 価格 レベルを参照してください。

Route Directions Batch API は、単一の API 呼び出しを使用して、Route Directions API にクエリのバッチを送信します。 Route Directions Batch API を呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 700 個の クエリをバッチ処理し、最大 100 個の クエリ API を同期できます。

非同期バッチ要求の送信

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

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

非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドのリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 非同期応答は、14 日間格納されます。 リダイレクト URL は、有効期限後に使用された場合、404 応答を返します。

非同期バッチ要求は実行時間の長い要求であることに注意してください。 一般的な一連の操作を次に示します。

1. クライアントが Route Directions Batch POST 要求を Azure Maps に送信する

2. サーバーは、次のいずれかの応答を返します。

   HTTP 202 Accepted - バッチ要求が受け入れされました。

   HTTP Error - Batch 要求の処理中にエラーが発生しました。 これは、400 Bad Request またはその他の Error 状態コードのいずれかです。

3. バッチ要求が正常に受け入れられた場合、応答の Location ヘッダーには、バッチ要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0 注:- AUTH 情報 (サブスクリプション キー/azure_auth - セキュリティを参照) を実行する前に、状態 URI に追加してください。
4. クライアントは、手順 3 で取得 ダウンロード URL に 要求を発行して、バッチ結果をダウンロードします。

バッチ要求の 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}

バッチ結果をダウンロードするための一般的な一連の操作を次に示します。

1. クライアントは、ダウンロード URLを使用して GET 要求を送信します。

2. サーバーは、次のいずれかの応答を返します。

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

Route Directions Batch API

に適用: 価格 レベルを参照してください。

Route Directions Batch API は、単一の API 呼び出しを使用して、Route Directions API にクエリのバッチを送信します。 Route Directions Batch API を呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 700 個の クエリをバッチ処理し、最大 100 個の クエリ API を同期できます。

同期バッチ要求の送信

軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。

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

バッチ応答モデル

返されるデータ コンテンツは、非同期要求と同期要求に似ています。 非同期バッチ要求の結果をダウンロードするときに、バッチの処理が完了した場合、応答本文にはバッチ応答が含まれます。 このバッチ応答には、元のバッチ要求の一部であった 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."
                }
            }
        }
    ]
}

Route Directions Batch API

に適用: 価格 レベルを参照してください。

Route Directions Batch API は、単一の API 呼び出しを使用して、Route Directions API にクエリのバッチを送信します。 Route Directions Batch API を呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 700 個の クエリをバッチ処理し、最大 100 個の クエリ API を同期できます。

同期バッチ要求の送信

軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。

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

バッチ応答モデル

返されるデータ コンテンツは、非同期要求と同期要求に似ています。 非同期バッチ要求の結果をダウンロードするときに、バッチの処理が完了した場合、応答本文にはバッチ応答が含まれます。 このバッチ応答には、元のバッチ要求の一部であった 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."
                }
            }
        }
    ]
}

Route Directions Batch API

に適用: 価格 レベルを参照してください。

Route Directions Batch API は、単一の API 呼び出しを使用して、Route Directions API にクエリのバッチを送信します。 Route Directions Batch API を呼び出して、非同期 (非同期) または同期 (同期) のいずれかを実行できます。 非同期 API を使用すると、呼び出し元は最大 700 個の クエリをバッチ処理し、最大 100 個の クエリ API を同期できます。

同期バッチ要求の送信

軽量バッチ要求には、同期 API をお勧めします。 サービスが要求を受け取ると、バッチ項目が計算されるとすぐに応答し、後で結果を取得することはできません。 要求に 60 秒を超える時間がかかる場合、同期 API はタイムアウト エラー (408 応答) を返します。 バッチ項目の数は、この API の 100 に制限されています。

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

バッチ応答モデル

返されるデータ コンテンツは、非同期要求と同期要求に似ています。 非同期バッチ要求の結果をダウンロードするときに、バッチの処理が完了した場合、応答本文にはバッチ応答が含まれます。 このバッチ応答には、元のバッチ要求の一部であった 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 要求を使用して、出発地と宛先の場所によって定義された一連のルートのルートの概要のマトリックスを計算できます。 サービスは、指定された配信元ごとに、その配信元から特定の宛先へのルーティングのコストを計算します。 起点のセットと宛先のセットは、テーブルの列ヘッダーと行ヘッダーと考えることができます。テーブル内の各セルには、そのセルの起点から宛先へのルーティングコストが含まれます。 たとえば、食品配達会社に 20 人のドライバーがあり、レストランから配送を受け取るために最も近いドライバーを見つける必要があるとします。 このユース ケースを解決するために、Matrix Route API を呼び出すことができます。

ルートごとに、移動時間と距離が返されます。 計算されたコストを使用して、Route Directions API を使用して計算する詳細なルートを決定できます。

非同期要求のマトリックスの最大サイズは 700 で、同期要求の場合は 100 (配信元の数に宛先の数を乗算) 。

同期ルート マトリックス要求の送信

シナリオで同期要求が必要で、マトリックスの最大サイズが 100 以下の場合は、同期要求を行うことができます。 この API のマトリックスの最大サイズは、100 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 10x10、6x8、9x8 です (正方形である必要はありません)。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

非同期ルート マトリックス要求を送信する

非同期 API は、比較的複雑なルーティング要求の大量の処理に適しています。 非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドのリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 要求 waitForResults パラメーターが true に設定されている場合、要求が 120 秒以内に完了すると、ユーザーは 200 応答を受け取ります。

この API のマトリックスの最大サイズは、700 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 50x10、10x10、28x25 です。 10 x 70 (正方形である必要はありません)。

非同期応答は、14 日間格納されます。 リダイレクト URL は、有効期限後に使用された場合、404 応答を返します。

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

非同期操作の一般的なシーケンスを次に示します。

1. クライアントがルート マトリックス POST 要求を Azure Maps に送信する

2. サーバーは、次のいずれかの応答を返します。

   HTTP 202 Accepted - ルート マトリックス要求が受け入れされました。

   HTTP Error - ルート マトリックス要求の処理中にエラーが発生しました。 これは、400 Bad Request またはその他のエラー状態コードのいずれかです。

3. マトリックス ルート要求が正常に受け入れられた場合、応答の Location ヘッダーには、要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

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

同期結果のダウンロード

ルート マトリックス同期 API に対して POST 要求を行うと、成功した要求と応答配列に対して 200 応答コードが返されます。 応答本文にはデータが含まれるため、後で結果を取得することはできません。

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

要求が 202 Accepted 応答を発行すると、非同期パイプラインを使用して要求が処理されます。 応答の location ヘッダーで非同期要求の進行状況を確認する URL が表示されます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

location ヘッダーによって提供される URL は、GET 要求が発行されたときに次の応答を返します。

HTTP 202 Accepted - マトリックス要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

HTTP 200 OK - マトリックス要求が正常に処理されました。 応答本文には、すべての結果が含まれています。

に適用: 価格 レベルを参照してください。

マトリックス ルーティング サービスでは、非同期 (非同期) または同期 (同期) POST 要求を使用して、出発地と宛先の場所によって定義された一連のルートのルートの概要のマトリックスを計算できます。 サービスは、指定された配信元ごとに、その配信元から特定の宛先へのルーティングのコストを計算します。 起点のセットと宛先のセットは、テーブルの列ヘッダーと行ヘッダーと考えることができます。テーブル内の各セルには、そのセルの起点から宛先へのルーティングコストが含まれます。 たとえば、食品配達会社に 20 人のドライバーがあり、レストランから配送を受け取るために最も近いドライバーを見つける必要があるとします。 このユース ケースを解決するために、Matrix Route API を呼び出すことができます。

ルートごとに、移動時間と距離が返されます。 計算されたコストを使用して、Route Directions API を使用して計算する詳細なルートを決定できます。

非同期要求のマトリックスの最大サイズは 700 で、同期要求の場合は 100 (配信元の数に宛先の数を乗算) 。

同期ルート マトリックス要求の送信

シナリオで同期要求が必要で、マトリックスの最大サイズが 100 以下の場合は、同期要求を行うことができます。 この API のマトリックスの最大サイズは、100 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 10x10、6x8、9x8 です (正方形である必要はありません)。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

非同期ルート マトリックス要求を送信する

非同期 API は、比較的複雑なルーティング要求の大量の処理に適しています。 非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドのリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 要求 waitForResults パラメーターが true に設定されている場合、要求が 120 秒以内に完了すると、ユーザーは 200 応答を受け取ります。

この API のマトリックスの最大サイズは、700 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 50x10、10x10、28x25 です。 10 x 70 (正方形である必要はありません)。

非同期応答は、14 日間格納されます。 リダイレクト URL は、有効期限後に使用された場合、404 応答を返します。

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

非同期操作の一般的なシーケンスを次に示します。

1. クライアントがルート マトリックス POST 要求を Azure Maps に送信する

2. サーバーは、次のいずれかの応答を返します。

   HTTP 202 Accepted - ルート マトリックス要求が受け入れされました。

   HTTP Error - ルート マトリックス要求の処理中にエラーが発生しました。 これは、400 Bad Request またはその他のエラー状態コードのいずれかです。

3. マトリックス ルート要求が正常に受け入れられた場合、応答の Location ヘッダーには、要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

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

同期結果のダウンロード

ルート マトリックス同期 API に対して POST 要求を行うと、成功した要求と応答配列に対して 200 応答コードが返されます。 応答本文にはデータが含まれるため、後で結果を取得することはできません。

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

要求が 202 Accepted 応答を発行すると、非同期パイプラインを使用して要求が処理されます。 応答の location ヘッダーで非同期要求の進行状況を確認する URL が表示されます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

location ヘッダーによって提供される URL は、GET 要求が発行されたときに次の応答を返します。

HTTP 202 Accepted - マトリックス要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

HTTP 200 OK - マトリックス要求が正常に処理されました。 応答本文には、すべての結果が含まれています。

に適用: 価格 レベルを参照してください。

マトリックス ルーティング サービスでは、非同期 (非同期) または同期 (同期) POST 要求を使用して、出発地と宛先の場所によって定義された一連のルートのルートの概要のマトリックスを計算できます。 サービスは、指定された配信元ごとに、その配信元から特定の宛先へのルーティングのコストを計算します。 起点のセットと宛先のセットは、テーブルの列ヘッダーと行ヘッダーと考えることができます。テーブル内の各セルには、そのセルの起点から宛先へのルーティングコストが含まれます。 たとえば、食品配達会社に 20 人のドライバーがあり、レストランから配送を受け取るために最も近いドライバーを見つける必要があるとします。 このユース ケースを解決するために、Matrix Route API を呼び出すことができます。

ルートごとに、移動時間と距離が返されます。 計算されたコストを使用して、Route Directions API を使用して計算する詳細なルートを決定できます。

非同期要求のマトリックスの最大サイズは 700 で、同期要求の場合は 100 (配信元の数に宛先の数を乗算) 。

同期ルート マトリックス要求の送信

シナリオで同期要求が必要で、マトリックスの最大サイズが 100 以下の場合は、同期要求を行うことができます。 この API のマトリックスの最大サイズは、100 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 10x10、6x8、9x8 です (正方形である必要はありません)。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

非同期ルート マトリックス要求を送信する

非同期 API は、比較的複雑なルーティング要求の大量の処理に適しています。 非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドのリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 要求 waitForResults パラメーターが true に設定されている場合、要求が 120 秒以内に完了すると、ユーザーは 200 応答を受け取ります。

この API のマトリックスの最大サイズは、700 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 50x10、10x10、28x25 です。 10 x 70 (正方形である必要はありません)。

非同期応答は、14 日間格納されます。 リダイレクト URL は、有効期限後に使用された場合、404 応答を返します。

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

非同期操作の一般的なシーケンスを次に示します。

1. クライアントがルート マトリックス POST 要求を Azure Maps に送信する

2. サーバーは、次のいずれかの応答を返します。

   HTTP 202 Accepted - ルート マトリックス要求が受け入れされました。

   HTTP Error - ルート マトリックス要求の処理中にエラーが発生しました。 これは、400 Bad Request またはその他のエラー状態コードのいずれかです。

3. マトリックス ルート要求が正常に受け入れられた場合、応答の Location ヘッダーには、要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

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

同期結果のダウンロード

ルート マトリックス同期 API に対して POST 要求を行うと、成功した要求と応答配列に対して 200 応答コードが返されます。 応答本文にはデータが含まれるため、後で結果を取得することはできません。

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

要求が 202 Accepted 応答を発行すると、非同期パイプラインを使用して要求が処理されます。 応答の location ヘッダーで非同期要求の進行状況を確認する URL が表示されます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

location ヘッダーによって提供される URL は、GET 要求が発行されたときに次の応答を返します。

HTTP 202 Accepted - マトリックス要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

HTTP 200 OK - マトリックス要求が正常に処理されました。 応答本文には、すべての結果が含まれています。

に適用: 価格 レベルを参照してください。

マトリックス ルーティング サービスでは、非同期 (非同期) または同期 (同期) POST 要求を使用して、出発地と宛先の場所によって定義された一連のルートのルートの概要のマトリックスを計算できます。 サービスは、指定された配信元ごとに、その配信元から特定の宛先へのルーティングのコストを計算します。 起点のセットと宛先のセットは、テーブルの列ヘッダーと行ヘッダーと考えることができます。テーブル内の各セルには、そのセルの起点から宛先へのルーティングコストが含まれます。 たとえば、食品配達会社に 20 人のドライバーがあり、レストランから配送を受け取るために最も近いドライバーを見つける必要があるとします。 このユース ケースを解決するために、Matrix Route API を呼び出すことができます。

ルートごとに、移動時間と距離が返されます。 計算されたコストを使用して、Route Directions API を使用して計算する詳細なルートを決定できます。

非同期要求のマトリックスの最大サイズは 700 で、同期要求の場合は 100 (配信元の数に宛先の数を乗算) 。

同期ルート マトリックス要求の送信

シナリオで同期要求が必要で、マトリックスの最大サイズが 100 以下の場合は、同期要求を行うことができます。 この API のマトリックスの最大サイズは、100 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 10x10、6x8、9x8 です (正方形である必要はありません)。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

非同期ルート マトリックス要求を送信する

非同期 API は、比較的複雑なルーティング要求の大量の処理に適しています。 非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドのリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 要求 waitForResults パラメーターが true に設定されている場合、要求が 120 秒以内に完了すると、ユーザーは 200 応答を受け取ります。

この API のマトリックスの最大サイズは、700 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 50x10、10x10、28x25 です。 10 x 70 (正方形である必要はありません)。

非同期応答は、14 日間格納されます。 リダイレクト URL は、有効期限後に使用された場合、404 応答を返します。

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

非同期操作の一般的なシーケンスを次に示します。

1. クライアントがルート マトリックス POST 要求を Azure Maps に送信する

2. サーバーは、次のいずれかの応答を返します。

   HTTP 202 Accepted - ルート マトリックス要求が受け入れされました。

   HTTP Error - ルート マトリックス要求の処理中にエラーが発生しました。 これは、400 Bad Request またはその他のエラー状態コードのいずれかです。

3. マトリックス ルート要求が正常に受け入れられた場合、応答の Location ヘッダーには、要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

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

同期結果のダウンロード

ルート マトリックス同期 API に対して POST 要求を行うと、成功した要求と応答配列に対して 200 応答コードが返されます。 応答本文にはデータが含まれるため、後で結果を取得することはできません。

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

要求が 202 Accepted 応答を発行すると、非同期パイプラインを使用して要求が処理されます。 応答の location ヘッダーで非同期要求の進行状況を確認する URL が表示されます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

location ヘッダーによって提供される URL は、GET 要求が発行されたときに次の応答を返します。

HTTP 202 Accepted - マトリックス要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

HTTP 200 OK - マトリックス要求が正常に処理されました。 応答本文には、すべての結果が含まれています。

に適用: 価格 レベルを参照してください。

マトリックス ルーティング サービスでは、非同期 (非同期) または同期 (同期) POST 要求を使用して、出発地と宛先の場所によって定義された一連のルートのルートの概要のマトリックスを計算できます。 サービスは、指定された配信元ごとに、その配信元から特定の宛先へのルーティングのコストを計算します。 起点のセットと宛先のセットは、テーブルの列ヘッダーと行ヘッダーと考えることができます。テーブル内の各セルには、そのセルの起点から宛先へのルーティングコストが含まれます。 たとえば、食品配達会社に 20 人のドライバーがあり、レストランから配送を受け取るために最も近いドライバーを見つける必要があるとします。 このユース ケースを解決するために、Matrix Route API を呼び出すことができます。

ルートごとに、移動時間と距離が返されます。 計算されたコストを使用して、Route Directions API を使用して計算する詳細なルートを決定できます。

非同期要求のマトリックスの最大サイズは 700 で、同期要求の場合は 100 (配信元の数に宛先の数を乗算) 。

同期ルート マトリックス要求の送信

シナリオで同期要求が必要で、マトリックスの最大サイズが 100 以下の場合は、同期要求を行うことができます。 この API のマトリックスの最大サイズは、100 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 10x10、6x8、9x8 です (正方形である必要はありません)。

POST https://atlas.microsoft.com/route/matrix/sync/json?api-version=1.0&subscription-key={subscription-key}

非同期ルート マトリックス要求を送信する

非同期 API は、比較的複雑なルーティング要求の大量の処理に適しています。 非同期要求を使用して要求を行うと、既定では、サービスは応答ヘッダーの Location フィールドのリダイレクト URL に沿って 202 応答コードを返します。 この URL は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。 要求 waitForResults パラメーターが true に設定されている場合、要求が 120 秒以内に完了すると、ユーザーは 200 応答を受け取ります。

この API のマトリックスの最大サイズは、700 です (起点の数に宛先の数を乗算)。 この制約を念頭に置いて、可能な行列ディメンションの例は 50x10、10x10、28x25 です。 10 x 70 (正方形である必要はありません)。

非同期応答は、14 日間格納されます。 リダイレクト URL は、有効期限後に使用された場合、404 応答を返します。

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&subscription-key={subscription-key}

非同期操作の一般的なシーケンスを次に示します。

1. クライアントがルート マトリックス POST 要求を Azure Maps に送信する

2. サーバーは、次のいずれかの応答を返します。

   HTTP 202 Accepted - ルート マトリックス要求が受け入れされました。

   HTTP Error - ルート マトリックス要求の処理中にエラーが発生しました。 これは、400 Bad Request またはその他のエラー状態コードのいずれかです。

3. マトリックス ルート要求が正常に受け入れられた場合、応答の Location ヘッダーには、要求の結果をダウンロードするための URL が含まれます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

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

同期結果のダウンロード

ルート マトリックス同期 API に対して POST 要求を行うと、成功した要求と応答配列に対して 200 応答コードが返されます。 応答本文にはデータが含まれるため、後で結果を取得することはできません。

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

要求が 202 Accepted 応答を発行すると、非同期パイプラインを使用して要求が処理されます。 応答の location ヘッダーで非同期要求の進行状況を確認する URL が表示されます。 この状態 URI は次のようになります。

  GET https://atlas.microsoft.com/route/matrix/{matrixId}?api-version=1.0?subscription-key={subscription-key}

location ヘッダーによって提供される URL は、GET 要求が発行されたときに次の応答を返します。

HTTP 202 Accepted - マトリックス要求は受け入れられましたが、まだ処理中です。 しばらくしてからやり直してください。

HTTP 200 OK - マトリックス要求が正常に処理されました。 応答本文には、すべての結果が含まれています。

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

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

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

Summary オブジェクト

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

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

多数のルート方向要求のバッチ要求本文を作成します。

サブスクリプション キーから MapsRouteClient のインスタンスを作成します。

例

import MapsRoute from "@azure-rest/maps-route";
import { AzureKeyCredential } from "@azure/core-auth";

const credential = new AzureKeyCredential("<subscription-key>");
const client = MapsRoute(credential);

Azure ID TokenCredentialから MapsRoute のインスタンスを作成します。

例

import MapsRoute from "@azure-rest/maps-route";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = MapsRoute(credential, "<maps-account-client-id>");

Azure ID AzureSASCredentialから MapsRoute のインスタンスを作成します。

例

import MapsRoute from "@azure-rest/maps-route";
import { AzureSASCredential } from "@azure/core-auth";

const credential = new AzureSASCredential("<SAS Token>");
const client = MapsRoute(credential);

実行時間の長い操作のポーリングに役立つ Poller オブジェクトを構築するヘルパー関数。

[Latitude, Longtitute] の配列を、"Latitude_1,Longtitute_1:Latitude_2,Longtitute_2:.." の形式の文字列に変換します。