Route - Post Route Matrix

リファレンス

Service:: Maps

API Version:: 1.0

非同期要求を使用して、出発地と目的地のリスト内のすべての可能なペアの移動時間と距離を示すルートマトリックスを取得するには、を使用します。

API は Post Route Matrix HTTP POST 要求であり、非同期 (非同期) 要求を使用して、配信元と宛先の場所によって定義された一連のルートのルート概要のマトリックスを計算できます。同期 (同期) 要求を行うには、「 Post Route Matrix Sync」を参照してください。指定された配信元ごとに、サービスは、その配信元から特定のすべての宛先へのルーティングのコストを計算します。一連の配信元と宛先のセットは、テーブルの列ヘッダーと行ヘッダーと考えることができます。テーブル内の各セルには、配信元からそのセルの宛先へのルーティングコストが含まれます。たとえば、食品配達会社には 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 は、応答データまたはエラー情報が使用可能になるまで定期的に確認する必要があります。要求のパラメーターが true に設定されている場合 waitForResults 、要求が 120 秒で完了すると、ユーザーは 200 応答を受け取ります。

この API のマトリックスの最大サイズは 700 です (配信元の数に宛先の数を乗算)。その制約を念頭に置いて、考えられる行列次元の例は、50x10、10x10、28x25 です。 10x70 (正方形である必要はありません)。

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

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

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

クライアントがルートマトリックス POST 要求を Azure Maps に送信する
サーバーは、次のいずれかで応答します。

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

HTTP Error - ルートマトリックス要求の処理中にエラーが発生しました。これは、400 Bad Request またはその他のエラー状態コードのいずれかである可能性があります。
マトリックスルート要求が正常に受け入れられた場合、応答の Location ヘッダーには、要求の結果をダウンロードするための URL が含まれます。この状態 URI は次のようになります。

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

クライアントは、手順 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 https://atlas.microsoft.com/route/matrix/json?api-version=1.0

With optional parameters:

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&waitForResults={waitForResults}&computeTravelTimeFor={computeTravelTimeFor}&sectionType={sectionType}&arriveAt={arriveAt}&departAt={departAt}&vehicleAxleWeight={vehicleAxleWeight}&vehicleLength={vehicleLength}&vehicleHeight={vehicleHeight}&vehicleWidth={vehicleWidth}&vehicleMaxSpeed={vehicleMaxSpeed}&vehicleWeight={vehicleWeight}&windingness={windingness}&hilliness={hilliness}&travelMode={travelMode}&avoid={avoid}&traffic={traffic}&routeType={routeType}&vehicleLoadType={vehicleLoadType}

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
api-version	query	True	string	Azure Maps API のバージョン番号。
arriveAt	query		string date-time	RFC 3339 セクション 5.6 で定義されている値として`dateTime`書式設定された宛先ポイントへの到着日時。タイムゾーンオフセットは省略可能です。タイムゾーンオフセットが指定されていない場合は、ターゲットポイントのオフセットと見なされます。例 : 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 パラメーターを`arriveAt`、、または `minDeviationTime`と`departAtminDeviationDistance`組み合わせて使用することはできません。
avoid	query		RouteAvoidType[]	ルートの決定時にルート計算で回避する必要がある何かを指定します。 1 つの要求で複数回指定できます。たとえば、'&avoid=高速道路&avoid=tollRoads&avoid=ferrys' です。ルート範囲要求では、値 alreadyUsedRoads を使用しないでください。
computeTravelTimeFor	query		ComputeTravelTime	さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。
departAt	query		string date-time	RFC 3339 セクション 5.6 で定義されている値として`dateTime`書式設定された、任意のタイムゾーンオフセットを含む、出発地点からの出発日時。タイムゾーンオフセットが指定されていない場合は、原点のオフセットと見なされます。既定値: 今すぐその他の値: `dateTime` 例 : 2023-12-19T16:39:57 2023-12-20T00:39:57+00:00 パラメーターを `departAt` と `arriveAt`組み合わせて使用することはできません。
hilliness	query		InclineLevel	スリル満点のルートのための丘陵性の程度。このパラメーターは、=thrilling と `routeType`組み合わせてのみ使用できます。
routeType	query		RouteType	要求されたルートの種類。
sectionType	query		SectionType	ルート応答で報告されるセクションの種類を指定します。たとえば、sectionType = 歩行者の場合、歩行者のみに適したセクションが返されます。複数の型を使用できます。既定の sectionType は、travelMode 入力を参照します。既定では、travelMode は car に設定されています
traffic	query		boolean	指定できる値 true - ルーティング中に使用可能なすべてのトラフィック情報を考慮する false - ルーティング中に現在のトラフィックデータを無視します。現在のトラフィックデータはルーティング中は無視されますが、有効な道路速度に対する履歴トラフィックの影響は引き続き組み込まれることに注意してください。
travelMode	query		TravelMode	要求されたルートの移動モード。定義されていない場合、既定値は 'car' です。要求された travelMode は、ルート全体で使用できない場合があることに注意してください。要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。移動モードバス、オートバイ、タクシー、バンはベータ機能であることに注意してください。すべての領域で完全な制限データを使用できるわけではありません。
vehicleAxleWeight	query		integer	車両の車軸あたりの重量 (kg)。値が 0 の場合、車軸あたりの重量制限は考慮されません。
vehicleHeight	query		number double	車両の高さ (メートル単位)。値が 0 の場合、高さの制限は考慮されません。
vehicleLength	query		number double	車両の長さ (メートル単位)。値 0 は、長さの制限が考慮されないことを意味します。
vehicleLoadType	query		VehicleLoadType	危険物として分類され、一部の道路から制限される可能性のある貨物の種類。使用可能な vehicleLoadType 値は、US Hazmat クラス 1 から 9 に加えて、他の国/地域で使用するための一般的な分類です。 USHazmat で始まる値は米国ルーティング用であり、otherHazmat は他のすべての国/地域に使用する必要があります。 vehicleLoadType は複数回指定できます。このパラメーターは現在、travelMode=truck でのみ考慮されています。
vehicleMaxSpeed	query		integer	キロ/時の車両の最高速度。車両プロファイルの最大速度は、高速道路で車両が許可されているかどうかをチェックするために使用されます。値 0 は、ルート計画中に車両に適切な値が決定され、適用されることを意味します。 0 以外の値は、ルート計画中にオーバーライドされる可能性があります。たとえば、現在のトラフィックフローは 60 km/時です。車両の最高速度が 50 km/時に設定されている場合、現在の状況であるため、ルーティングエンジンは 60 km/時を考慮します。車両の最高速度が 80 km/時として提供されているが、現在の交通フローが 60 km/時である場合、ルーティングエンジンは再び 60 km/時を使用します。
vehicleWeight	query		integer	車両の重量 (キロ単位)。
vehicleWidth	query		number double	車両の幅 (メートル単位)。値が 0 の場合、幅の制限は考慮されません。
waitForResults	query		boolean	要求を同期的に実行するかどうかを示すブール値。 true に設定すると、要求が 120 秒で完了すると、ユーザーは 200 応答を受け取ります。それ以外の場合、ユーザーはすぐに 202 応答を受け取ります。 202 応答の詳細については、API の説明を参照してください。非同期要求でのみサポートされます。
windingness	query		WindingnessLevel	スリル満点のルートのターンのレベル。このパラメーターは、=thrilling と `routeType`組み合わせてのみ使用できます。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

要求本文

名前	型	説明
destinations	GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、 RFC 7946 を参照してください。
origins	GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、 RFC 7946 を参照してください。

応答

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

名前

型

説明

200 OK

RouteMatrixResult

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

202 Accepted

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

Headers

Location: string

Other Status Codes

ErrorResponse

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

セキュリティ

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 matrix request

Sample Request

HTTP

POST https://atlas.microsoft.com/route/matrix/json?api-version=1.0&routeType=shortest

{
  "origins": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85106,
        52.36006
      ],
      [
        4.85056,
        52.36187
      ]
    ]
  },
  "destinations": {
    "type": "MultiPoint",
    "coordinates": [
      [
        4.85003,
        52.36241
      ],
      [
        13.42937,
        52.50931
      ]
    ]
  }
}

Sample Response

Status code:: 200

{
  "formatVersion": "0.0.1",
  "matrix": [
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 495,
            "travelTimeInSeconds": 134,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:43+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647651,
            "travelTimeInSeconds": 26835,
            "trafficDelayInSeconds": 489,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:22:44+00:00"
          }
        }
      }
    ],
    [
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 338,
            "travelTimeInSeconds": 104,
            "trafficDelayInSeconds": 0,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-27T22:57:13+00:00"
          }
        }
      },
      {
        "statusCode": 200,
        "response": {
          "routeSummary": {
            "lengthInMeters": 647494,
            "travelTimeInSeconds": 26763,
            "trafficDelayInSeconds": 469,
            "departureTime": "2018-07-27T22:55:29+00:00",
            "arrivalTime": "2018-07-28T06:21:32+00:00"
          }
        }
      }
    ]
  ],
  "summary": {
    "successfulRoutes": 4,
    "totalRoutes": 4
  }
}

Status code:: 202

operation-Location: New URL to check the status of the long-running operation.

定義

名前	説明
ComputeTravelTime	さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適な推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、 RFC 7946 を参照してください。
InclineLevel	スリリングなルートのためのヒルネスの程度。このパラメーターは、=thrilling と `routeType`組み合わせてのみ使用できます。
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
RouteAvoidType	ルートの決定時にルート計算で回避する必要のあるものを指定します。 "&avoid=motorways&avoid=tollRoads&avoid=ferrys" など、1 つの要求で複数回指定できます。ルート範囲要求では、既にUsedRoads の値を使用することはできません。
RouteLegSummary	ルートセクションの概要オブジェクト。
RouteMatrix	マトリックスの結果オブジェクト
RouteMatrixQuery	座標の行列を持つオブジェクト。
RouteMatrixResult	このオブジェクトは、成功した Route Matrix 呼び出しから返されます。たとえば、2 つのオリジンと 3 つの宛先が指定されている場合は、それぞれに 3 つの要素を含む 2 つの配列が存在します。各要素の内容は、クエリで提供されるオプションによって異なります。
RouteMatrixResultResponse	入力マトリックス内の現在のセルの応答オブジェクト。
RouteMatrixSummary	Summary オブジェクト
RouteType	要求されたルートの種類。
SectionType	ルート応答で報告されるセクションの種類を指定します。たとえば、sectionType = 歩行者の場合、歩行者のみに適したセクションが返されます。複数の型を使用できます。既定の sectionType は travelMode 入力を参照します。既定では、travelMode は car に設定されています
TravelMode	要求されたルートの移動モード。定義されていない場合、既定値は 'car' です。要求された travelMode がルート全体で使用できない場合があることに注意してください。要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。移動モードバス、オートバイ、タクシー、バンはベータ機能であることに注意してください。すべての領域で完全な制限データを使用できるわけではありません。
VehicleLoadType	危険物として分類され、一部の道路から制限される可能性のある貨物の種類。使用可能な vehicleLoadType 値は、US Hazmat クラス 1 から 9 に加えて、他の国/地域で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、otherHazmat は他のすべての国/地域に使用する必要があります。 vehicleLoadType は複数回指定できます。このパラメーターは現在、travelMode=truck でのみ考慮されています。
WindingnessLevel	スリリングなルートのためのターンのレベル。このパラメーターは、=thrilling と `routeType`組み合わせてのみ使用できます。

ComputeTravelTime

さまざまな種類の交通情報 (なし、履歴、ライブ) と既定の最適な推定移動時間を使用して、追加の移動時間を返すかどうかを指定します。

名前	型	説明
all	string	すべての種類の交通情報の移動時間を計算し、ルート応答の概要に含まれるフィールド noTrafficTravelTimeInSeconds、historicTrafficTravelTimeInSeconds、liveTrafficIncidentsTravelTimeInSeconds のすべての結果を指定します。
none	string	追加の移動時間を計算しません。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

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

GeoJsonMultiPoint

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

名前	型	説明
coordinates	number[]	ジオメトリの `GeoJson MultiPoint` 座標。
type	string: MultiPoint	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトタイプのいずれかである必要があります。

InclineLevel

スリリングなルートのためのヒルネスの程度。このパラメーターは、=thrilling と routeType組み合わせてのみ使用できます。

名前	型	説明
high	string	high
low	string	low
normal	string	普通

JsonFormat

応答の目的の形式。サポートされているのは json 形式のみです。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式

RouteAvoidType

ルートの決定時にルート計算で回避する必要のあるものを指定します。 "&avoid=motorways&avoid=tollRoads&avoid=ferrys" など、1 つの要求で複数回指定できます。ルート範囲要求では、既にUsedRoads の値を使用することはできません。

名前	型	説明
alreadyUsedRoads	string	同じ道路を複数回使用しないようにします。 =スリリングと `routeType`組み合わせて最も便利です。
borderCrossings	string	ルート計算で境界線の交差を回避します。
carpools	string	カープール(HOV/高占有車)レーンの使用を必要とするルートを回避します。
ferries	string	フェリーを避ける
motorways	string	高速道路を避ける
tollRoads	string	有料道路を回避します。
unpavedRoads	string	未舗装道路を回避する

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 が将来の場合、移動時間は時間に依存する履歴トラフィックデータを使用して計算されます。

RouteMatrix

マトリックスの結果オブジェクト

名前	型	説明
response	RouteMatrixResultResponse	入力マトリックス内の現在のセルの応答オブジェクト。
statusCode	integer	入力マトリックス内の現在のセルの StatusCode プロパティ。

RouteMatrixQuery

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

名前	型	説明
destinations	GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、 RFC 7946 を参照してください。
origins	GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、 RFC 7946 を参照してください。

RouteMatrixResult

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

名前	型	説明
formatVersion	string	[バージョンの書式設定] プロパティ
matrix	RouteMatrix[]	ルートの概要の 2 次元配列としての結果。
summary	RouteMatrixSummary	Summary オブジェクト

RouteMatrixResultResponse

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

名前	型	説明
routeSummary	RouteLegSummary	ルートセクションの概要オブジェクト。

RouteMatrixSummary

Summary オブジェクト

名前	型	説明
successfulRoutes	integer	応答内の成功したルートの数。
totalRoutes	integer	要求されたルートの合計数。入力マトリックス内のセルの数。

RouteType

要求されたルートの種類。

名前	型	説明
eco	string	経済とスピードのバランスが取れたルート。
fastest	string	最速のルート。
shortest	string	距離別の最短ルート。
thrilling	string	興味深い道路や困難な道路が含まれており、できるだけ少ない高速道路を使用しています。含まれるターンのレベルと、ヒルネスの度合いを選択できます。これを設定する方法については、ヒルネスとワインディングネスのパラメーターを参照してください。 =スリル満点で計画された `routeType`ルートには900kmの制限があります

SectionType

ルート応答で報告されるセクションの種類を指定します。

たとえば、sectionType = 歩行者の場合、歩行者のみに適したセクションが返されます。複数の型を使用できます。既定の sectionType は travelMode 入力を参照します。既定では、travelMode は car に設定されています

名前	型	説明
carTrain	string	車または電車であるルートのセクション。
carpool	string	カープール(HOV/高占有車)レーンの使用を必要とするルートのセクション。
country	string	ルートが含まれる国/地域を示すセクション。
ferry	string	フェリーであるルートのセクション。
motorway	string	高速道路であるルートのセクション。
pedestrian	string	歩行者にのみ適したルートのセクション。
tollRoad	string	通行料の支払いが必要なルートのセクション。
tollVignette	string	有料ビネットが存在する必要があるルートのセクション。
traffic	string	トラフィック情報を含むルートのセクション。
travelMode	string	要求パラメーター `travelMode`に関連するセクション。
tunnel	string	トンネルであるルートのセクション。
urban	string	都市部に位置するルートのセクション。

TravelMode

要求されたルートの移動モード。定義されていない場合、既定値は 'car' です。要求された travelMode がルート全体で使用できない場合があることに注意してください。要求された travelMode が特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。移動モードバス、オートバイ、タクシー、バンはベータ機能であることに注意してください。すべての領域で完全な制限データを使用できるわけではありません。

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

VehicleLoadType

危険物として分類され、一部の道路から制限される可能性のある貨物の種類。使用可能な vehicleLoadType 値は、US Hazmat クラス 1 から 9 に加えて、他の国/地域で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、otherHazmat は他のすべての国/地域に使用する必要があります。 vehicleLoadType は複数回指定できます。このパラメーターは現在、travelMode=truck でのみ考慮されています。

名前	型	説明
USHazmatClass1	string	火薬類
USHazmatClass2	string	圧縮ガス
USHazmatClass3	string	引火性液体
USHazmatClass4	string	引火性固体
USHazmatClass5	string	酸化剤
USHazmatClass6	string	毒
USHazmatClass7	string	放射性物質
USHazmatClass8	string	腐食性
USHazmatClass9	string	その他
otherHazmatExplosive	string	火薬類
otherHazmatGeneral	string	その他
otherHazmatHarmfulToWater	string	水に有害

WindingnessLevel

スリリングなルートのためのターンのレベル。このパラメーターは、=thrilling と routeType組み合わせてのみ使用できます。

名前	型	説明
high	string	high
low	string	low
normal	string	普通

Route - Post Route Matrix

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

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

同期結果のダウンロード

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

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

AADToken

メモ

Scopes

subscription-key

SAS Token

例

Successfully submit a route matrix request

Sample Request

Sample Response

定義

ComputeTravelTime

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeoJsonMultiPoint

InclineLevel

JsonFormat

RouteAvoidType

RouteLegSummary

RouteMatrix

RouteMatrixQuery

RouteMatrixResult

RouteMatrixResultResponse

RouteMatrixSummary

RouteType

SectionType

TravelMode

VehicleLoadType

WindingnessLevel

その他のリソース

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

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