Route - Post Route Matrix

サービス:: Maps

API バージョン:: 2025-01-01

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

ルートマトリックスは、複数の異なる種類のアプリケーションで使用されます。最も一般的に、旅行セールスマン問題 (TSP) と車両ルーティング問題 (VRP) を解決します。行列内の出発地と目的地のペアごとに、移動時間と距離が返されます。計算されたコストを使用して、Route Directions API を使用して計算する詳細なルートを決定できます。

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

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

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

API の制限事項

行列の同期処理は、ルート計算の高速で小さな行列に最適です。大規模なマトリックスと重いルート計算を計算するには、非同期エンドポイントを使用します。同期要求には、次の制限が適用されます。次の表の行が要求のパラメーターと一致しない場合、要求は要件を満たしていないため、処理されません。

マトリックスの最大サイズ	オリジンの最大数	宛先の最大数	追加の制限
100	100	100	なし
200	200	200	すべての原点と目的地は、軸で整列された 400 km x 400 km の境界ボックスに含める必要があります。それ以外の場合、一部のマトリックスセルはOUT_OF_REGIONとして解決されます。
2500	1000	1000	- `departAt` または `arriveAt` は任意である必要があります。 - `traffic` は履歴である必要があります。 - `travelMode` は、運転またはトラックである必要があります - 他のパラメーターは明示的に使用できません

例：

traffic=liveを含む 10 x 20 マトリックスの要求: この要求は、境界ボックスの制限を含む最大 200 の制限に一致するため、境界ボックスの制限で処理されます。
既定のパラメーターを持つ 10 x 20 マトリックスの要求 (traffic=historical): この要求は、境界ボックスの制限を課さない最大 2500 の制限に一致するため、境界ボックスの制限なしで処理されます。

POST https://atlas.microsoft.com/route/matrix?api-version=2025-01-01

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	Azure Maps API のバージョン番号。

要求ヘッダー

Media Types: "application/geo+json"

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルでの使用を目的としたアカウントを示します。 Azure Maps アカウントのこの一意の ID は、 Azure Maps 管理プレーンアカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用する方法の詳細については、「 Azure Maps での認証の管理」を参照してください。

要求本文

Media Types: "application/geo+json"

名前	必須	型	説明
features	True	InputRouteMatrixFeaturesItem[]	入力マトリックスの GeoJSON MultiPoint 特徴として渡される一連の始点と終点。 GeoJSON 形式の詳細については、 RFC 7946 を参照してください。
type	True	FeatureTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は `FeatureCollection`のみです。詳細については、 RFC 7946 を参照してください。
arriveAt		string (date-time)	RFC 3339 セクション 5.6で定義された値として書式設定された宛先ポイントへの到着日時。タイムゾーンオフセットが指定されていない場合、UTC が想定されます。 `arriveAt` パラメーターは、`departAt`と組み合わせて使用することはできません。 `arriveAt` では、時間コンテキストが無関係なユースケースに合わせて調整された `any` 値もサポートされています。 `traffic=live` パラメーター値は、`any`と共に使用することはできません。既定値: `any` が指定されていない場合に `arriveAt` します。例: "arriveAt": "2024-12-01T09:30:00.000-07:00"
avoid		RouteMatrixAvoidEnum[]	ルートを決定するときにルート計算で考慮する必要がある制限を指定します。 Avoid は要求で複数の値をサポートし、運転とトラックの travelMode でのみサポートされます。
departAt		string (date-time)	RFC 3339、セクション 5.6で定義値として書式設定された出発地からの出発日時。タイムゾーンオフセットが指定されていない場合、UTC が想定されます。 `departAt` パラメーターは、`arriveAt`と組み合わせて使用することはできません。 `departAt` では、次の機能もサポートされています。 `any` 時間コンテキストが無関係なユースケースに合わせて調整された値です。 `traffic=live` パラメーター値は、`any`と共に使用することはできません。 `now` 値を使用して、出発時間を個々のセルの処理時間に設定します。処理時間は、提出から完了までの任意の時間にすることができます。このモードは、traffic=live と共に使用するのが最適です。既定値: `any` が指定されていない場合に `departAt` します。例： "出発時": "2024-12-01T09:30:00.000-07:00"
optimizeRoute		RouteMatrixOptimizeRouteEnum	ルートの最適化に使用するパラメーターを指定します。定義されていない場合、既定値は "最速" であり、移動時間を最小限に抑えるためにルートを返します。例: "optimizeRoute":"fastest"
traffic		RouteMatrixTrafficEnum	ルートを計算するためにトラフィックを考慮する方法を指定します。既定値: `historical`
travelMode		RouteMatrixTravelModeEnum	行列を計算するときに考慮する移動プロファイルを指定します。指定しない場合、既定値は "driving" です。例: "travelMode":"driving"
vehicleSpec		RouteMatrixVehicleSpec	ルートマトリックスを計算するときに考慮する車両の高さ、重量、最大速度、貨物の種類などの車両属性を指定します。これは、車両仕様に基づいて最適化されたルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。 vehicle 属性は vehicleSpec プロパティ内で指定されます。

応答

名前	型	説明
200 OK	RouteMatrixResponse	[OK] Media Types: "application/geo+json"
Other Status Codes	MapsErrorResponse	予期しないエラーが発生しました。 Media Types: "application/geo+json" ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

RouteMatrixResponse

[OK]

Media Types: "application/geo+json"

Other Status Codes

MapsErrorResponse

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

Media Types: "application/geo+json"

ヘッダー

x-ms-error-code: string

セキュリティ

AADToken

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

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

注

このセキュリティ定義使用して、アプリケーションがアクセスを要求している 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 管理プレーンを介して Azure Maps リソースを作成するときにプロビジョニングされる共有キーです。

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

公開されているアプリケーションの場合、このキーを安全に格納できる Azure Maps REST API のサーバー間アクセスを使用することをお勧めします。

型: apiKey
/: header

SAS Token

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

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

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

型: apiKey
/: header

例

Successfully retrieve a route matrix with additional parameters in the body

要求のサンプル

HTTP

POST https://atlas.microsoft.com/route/matrix?api-version=2025-01-01

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            9.15049,
            45.458545
          ],
          [
            11.050541,
            45.403337
          ]
        ]
      },
      "properties": {
        "pointType": "origins"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiPoint",
        "coordinates": [
          [
            11.499931,
            48.149853
          ],
          [
            14.538226,
            50.033688
          ]
        ]
      },
      "properties": {
        "pointType": "destinations"
      }
    }
  ],
  "departAt": "2022-12-19T16:39:57+01:00",
  "optimizeRoute": "fastest",
  "traffic": "historical",
  "travelMode": "truck",
  "avoid": [
    "unpavedRoads"
  ]
}

応答のサンプル

状態コード:: 200

{
  "type": "Feature",
  "geometry": null,
  "properties": {
    "summary": {
      "totalCount": 4,
      "successfulCount": 4
    },
    "matrix": [
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 0,
        "durationTrafficInSeconds": 21007,
        "durationInSeconds": 21007,
        "distanceInMeters": 492466,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:30:03+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 0,
        "destinationIndex": 1,
        "durationTrafficInSeconds": 33623,
        "durationInSeconds": 33623,
        "distanceInMeters": 877028,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T02:00:19+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 0,
        "durationTrafficInSeconds": 19520,
        "durationInSeconds": 19520,
        "distanceInMeters": 427769,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-19T22:05:16+01:00"
      },
      {
        "statusCode": 200,
        "originIndex": 1,
        "destinationIndex": 1,
        "durationTrafficInSeconds": 32070,
        "durationInSeconds": 32070,
        "distanceInMeters": 836080,
        "departureAt": "2022-12-19T16:39:57+01:00",
        "arrivalAt": "2022-12-20T01:34:27+01:00"
      }
    ]
  }
}

定義

名前	説明
AdrTunnelRestrictionCodeEnum	ADR トンネル制限コード。 ADRは、道路による危険物の国際輸送に関する欧州協定です。 ADR トンネル制限コードは、車両が危険物の輸送を制限してトンネルを通過できるかどうかを判断するために使用されます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
FeaturesItemTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は Feature のみです。詳細については、 RFC 7946 を参照してください。
FeatureTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は `FeatureCollection`のみです。詳細については、 RFC 7946 を参照してください。
GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、RFC 7946 を参照してください。
InputRouteMatrixFeaturesItem	`GeoJSON` MultiPoint フィーチャーオブジェクトの入力元と変換先のポイントと追加のプロパティを指定します。詳細については、 RFC 7946 を参照してください。
InputRouteMatrixProperties	入力マトリックスのプロパティオブジェクトを指定します。
MapsErrorDetail	エラーの詳細。
MapsErrorResponse	失敗した操作のエラーの詳細を返す Azure Maps API の一般的なエラー応答。
MapsInnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
RouteMatrixAsyncResponse	ルート Leg の各操縦ポイントの運転指示と追加のプロパティを指定します。
RouteMatrixAvoidEnum	ルートを決定するときにルート計算で考慮する必要がある制限を指定します。 Avoid は要求で複数の値をサポートし、運転とトラックの travelMode でのみサポートされます。
RouteMatrixFeatureProperties	ルートマトリックスのプロパティ。
RouteMatrixItemResult	ルートマトリックス項目の結果
RouteMatrixOptimizeRouteEnum	ルートの最適化に使用するパラメーターを指定します。定義されていない場合、既定値は "最速" であり、移動時間を最小限に抑えるためにルートを返します。例: "optimizeRoute":"fastest"
RouteMatrixRequest	出発地と目的地のリスト内のすべての可能なペアの移動時間と距離を示すルートマトリックスを取得するために使用します。フィーチャーオブジェクトと追加のプロパティを `GeoJSON` します。詳細については、 RFC 7946 を参照してください。
RouteMatrixResponse	このオブジェクトは、正常な呼び出しから返されます。
RouteMatrixSummary	ルートマトリックス要求の概要
RouteMatrixTrafficEnum	ルートを計算するためにトラフィックを考慮する方法を指定します。既定値: `historical`
RouteMatrixTravelModeEnum	行列を計算するときに考慮する移動プロファイルを指定します。指定しない場合、既定値は "driving" です。例: "travelMode":"driving"
RouteMatrixTypeEnum	入力マトリックスの元の MultiPoint 型と変換先の MultiPoint 型を指定します。
RouteMatrixVehicleSpec	ルートマトリックスを計算するときに考慮する車両の高さ、重量、最大速度、貨物の種類などの車両属性を指定します。これは、車両仕様に基づいて最適化されたルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。 vehicle 属性は vehicleSpec プロパティ内で指定されます。
RouteOperationKindEnum	非同期操作の種類
VehicleLoadTypeEnum	危険物として分類され、一部の道路から制限される可能性のある貨物の種類。使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国では otherHazmat を使用する必要があります。 vehicleLoadType は、要求で複数の値をサポートします。

AdrTunnelRestrictionCodeEnum

列挙

ADR トンネル制限コード。 ADRは、道路による危険物の国際輸送に関する欧州協定です。 ADR トンネル制限コードは、車両が危険物の輸送を制限してトンネルを通過できるかどうかを判断するために使用されます。

値	説明
B	コード B を持つ車両は、ADR トンネルカテゴリ B、C、D、E の道路から制限されます。
C	コード C を持つ車両は、ADR トンネルカテゴリ C、D、E の道路から制限されます
D	コード D を持つ車両は、ADR トンネルカテゴリ D と E の道路から制限されます。
E	コード E の車両は、ADR トンネルカテゴリ E の道路から制限されます。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

FeaturesItemTypeEnum

列挙

GeoJSON 型を指定します。サポートされているオブジェクトの種類は Feature のみです。詳細については、 RFC 7946 を参照してください。

値	説明
Feature	`GeoJSON` フィーチャーオブジェクトの種類を指定します。

FeatureTypeEnum

列挙

GeoJSON 型を指定します。サポートされているオブジェクトの種類は FeatureCollectionのみです。詳細については、 RFC 7946 を参照してください。

値	説明
FeatureCollection	`GeoJSON` `FeatureCollection` オブジェクトの種類を指定します。

GeoJsonMultiPoint

Object

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

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

InputRouteMatrixFeaturesItem

Object

GeoJSON MultiPoint フィーチャーオブジェクトの入力元と変換先のポイントと追加のプロパティを指定します。詳細については、 RFC 7946 を参照してください。

名前	型	説明
geometry	GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、RFC 7946 を参照してください。
properties	InputRouteMatrixProperties	入力マトリックスの原点フィーチャと変換先フィーチャを指定する MultiPoint フィーチャプロパティオブジェクト。
type	FeaturesItemTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は Feature のみです。詳細については、 RFC 7946 を参照してください。

InputRouteMatrixProperties

Object

入力マトリックスのプロパティオブジェクトを指定します。

名前	型	説明
pointType	RouteMatrixTypeEnum	入力マトリックスの元の MultiPoint 型と変換先の MultiPoint 型を指定します。

MapsErrorDetail

Object

エラーの詳細。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	MapsErrorDetail[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	MapsInnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーについての、人間が判読できる文字列。
target	string	エラーのターゲット。

MapsErrorResponse

Object

失敗した操作のエラーの詳細を返す Azure Maps API の一般的なエラー応答。

名前	型	説明
error	MapsErrorDetail	エラーの詳細。

MapsInnerError

Object

エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

名前	型	説明
code	string	エラーコード。
innererror	MapsInnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

RouteMatrixAsyncResponse

Object

ルート Leg の各操縦ポイントの運転指示と追加のプロパティを指定します。

名前	型	説明
geometry	object	geometry オブジェクトが null です
kind	string: RouteMatrix	非同期操作の種類
properties	RouteMatrixFeatureProperties	ルートマトリックスのプロパティ。
type	FeaturesItemTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は Feature のみです。詳細については、 RFC 7946 を参照してください。

RouteMatrixAvoidEnum

列挙

ルートを決定するときにルート計算で考慮する必要がある制限を指定します。 Avoid は要求で複数の値をサポートし、運転とトラックの travelMode でのみサポートされます。

値	説明
tollRoads	ルート内の有料道路の使用を回避します。
unpavedRoads	ルート内の未舗装道路を回避します。

RouteMatrixFeatureProperties

Object

ルートマトリックスのプロパティ。

名前	型	説明
matrix	RouteMatrixItemResult[]	ルート結果のマトリックス。
summary	RouteMatrixSummary	ルートマトリックス要求の概要

RouteMatrixItemResult

Object

ルートマトリックス項目の結果

名前	型	説明
arrivalAt	string (date-time)	トラフィックの状態を考慮した推定到着時間は、RFC 3339 セクション 5.6定義された値として書式設定されます。 `departAt` または `arrivalAt`でタイムゾーンオフセットを参照します。そうでない場合は、UTC 時刻が使用されます。 departAt または arriveAt が any の場合、departureAt は存在しません。
departureAt	string (date-time)	交通状況を考慮した推定出発時間は、RFC 3339 セクション 5.6定義された値として書式設定されます。 `departAt` または `arrivalAt`でタイムゾーンオフセットを参照します。そうでない場合は、UTC 時刻が使用されます。出発時または到着時が `any`の場合、出発時は存在しません。
destinationIndex	integer (int32)	変換先ポイントのインデックス
distanceInMeters	number (double)	Length In Meters プロパティ
durationInSeconds	integer (int64)	交通状況によるルートの遅延を含まない推定移動時間 (秒単位)。
durationTrafficInSeconds	integer (int64)	現在の交通状況に対応する `TravelDistance` を移動するのに要する時間 (秒単位)。この値は、トラフィックに関する考慮事項 `optimizeRoute` 含まれている場合に提供されます。
error	ErrorDetail	エラーの詳細。
originIndex	integer (int32)	原点のインデックス
statusCode	integer (int32)	現在のセルの HTTP 状態コード。

RouteMatrixOptimizeRouteEnum

列挙

ルートの最適化に使用するパラメーターを指定します。定義されていない場合、既定値は "最速" であり、移動時間を最小限に抑えるためにルートを返します。

例: "optimizeRoute":"fastest"

値説明

fastest

値	説明
fastest	移動時間でルートを最適化する最速のルートを検索します。ルートマトリックス同期 API では、`fastest` のみがサポートされています。他の型を使用するには、ルートマトリックス非同期 API を確認します。

移動時間でルートを最適化する最速のルートを検索します。

ルートマトリックス同期 API では、fastest のみがサポートされています。他の型を使用するには、ルートマトリックス非同期 API を確認します。

RouteMatrixRequest

Object

出発地と目的地のリスト内のすべての可能なペアの移動時間と距離を示すルートマトリックスを取得するために使用します。フィーチャーオブジェクトと追加のプロパティを GeoJSON します。詳細については、 RFC 7946 を参照してください。

名前	型	規定値	説明
arriveAt	string (date-time)		RFC 3339 セクション 5.6で定義された値として書式設定された宛先ポイントへの到着日時。タイムゾーンオフセットが指定されていない場合、UTC が想定されます。 `arriveAt` パラメーターは、`departAt`と組み合わせて使用することはできません。 `arriveAt` では、時間コンテキストが無関係なユースケースに合わせて調整された `any` 値もサポートされています。 `traffic=live` パラメーター値は、`any`と共に使用することはできません。既定値: `any` が指定されていない場合に `arriveAt` します。例: "arriveAt": "2024-12-01T09:30:00.000-07:00"
avoid	RouteMatrixAvoidEnum[]		ルートを決定するときにルート計算で考慮する必要がある制限を指定します。 Avoid は要求で複数の値をサポートし、運転とトラックの travelMode でのみサポートされます。
departAt	string (date-time)		RFC 3339、セクション 5.6で定義値として書式設定された出発地からの出発日時。タイムゾーンオフセットが指定されていない場合、UTC が想定されます。 `departAt` パラメーターは、`arriveAt`と組み合わせて使用することはできません。 `departAt` では、次の機能もサポートされています。 `any` 時間コンテキストが無関係なユースケースに合わせて調整された値です。 `traffic=live` パラメーター値は、`any`と共に使用することはできません。 `now` 値を使用して、出発時間を個々のセルの処理時間に設定します。処理時間は、提出から完了までの任意の時間にすることができます。このモードは、traffic=live と共に使用するのが最適です。既定値: `any` が指定されていない場合に `departAt` します。例： "出発時": "2024-12-01T09:30:00.000-07:00"
features	InputRouteMatrixFeaturesItem[]		入力マトリックスの GeoJSON MultiPoint 特徴として渡される一連の始点と終点。 GeoJSON 形式の詳細については、 RFC 7946 を参照してください。
optimizeRoute	RouteMatrixOptimizeRouteEnum	fastest	ルートの最適化に使用するパラメーターを指定します。定義されていない場合、既定値は "最速" であり、移動時間を最小限に抑えるためにルートを返します。例: "optimizeRoute":"fastest"
traffic	RouteMatrixTrafficEnum	historical	ルートを計算するためにトラフィックを考慮する方法を指定します。既定値: `historical`
travelMode	RouteMatrixTravelModeEnum	driving	行列を計算するときに考慮する移動プロファイルを指定します。指定しない場合、既定値は "driving" です。例: "travelMode":"driving"
type	FeatureTypeEnum		`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は `FeatureCollection`のみです。詳細については、 RFC 7946 を参照してください。
vehicleSpec	RouteMatrixVehicleSpec		ルートマトリックスを計算するときに考慮する車両の高さ、重量、最大速度、貨物の種類などの車両属性を指定します。これは、車両仕様に基づいて最適化されたルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。 vehicle 属性は vehicleSpec プロパティ内で指定されます。

RouteMatrixResponse

Object

このオブジェクトは、正常な呼び出しから返されます。

名前	型	説明
geometry	object	geometry オブジェクトが null です
properties	RouteMatrixFeatureProperties	ルートマトリックスのプロパティ。
type	FeaturesItemTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は Feature のみです。詳細については、 RFC 7946 を参照してください。

RouteMatrixSummary

Object

ルートマトリックス要求の概要

名前	型	説明
successfulCount	integer (int32)	このマトリックス内の成功したルートの数。
totalCount	integer (int32)	このマトリックス内のルートの合計数。

RouteMatrixTrafficEnum

列挙

ルートを計算するためにトラフィックを考慮する方法を指定します。

既定値: historical

値説明

historical

値	説明
historical	ルートの計算では、履歴の移動時間と長期的な閉鎖が考慮されます。移動時間帯の交通渋滞や短期的な閉鎖は、ルーティングや移動時間には影響しません。
live	過去の移動時間に加えて、ルート計算では、移動時間枠中の交通渋滞と短期および長期の閉鎖が考慮されます。 `Note`: `traffic=live` は `arriveAt=any` および `departAt=any` と組み合わせて使用することはできません

ルートの計算では、履歴の移動時間と長期的な閉鎖が考慮されます。移動時間帯の交通渋滞や短期的な閉鎖は、ルーティングや移動時間には影響しません。

live

過去の移動時間に加えて、ルート計算では、移動時間枠中の交通渋滞と短期および長期の閉鎖が考慮されます。

Note: traffic=live は arriveAt=any および departAt=any と組み合わせて使用することはできません

RouteMatrixTravelModeEnum

列挙

行列を計算するときに考慮する移動プロファイルを指定します。指定しない場合、既定値は "driving" です。

例: "travelMode":"driving"

値	説明
driving	自動車に適したルーティングプロファイルは、ルートマトリックスの計算に使用されます。
truck	トラックなどの商用車両に適したルーティングプロファイルは、ルートマトリックスの計算に使用されます。
walking	返されるルートは、歩道の使用を含め、歩行者向けに最適化されています。

RouteMatrixTypeEnum

列挙

入力マトリックスの元の MultiPoint 型と変換先の MultiPoint 型を指定します。

値	説明
origins	入力マトリックス内の原点の場所を定義する MultiPoint 機能。
destinations	入力マトリックス内の移動先の場所を定義する MultiPoint 機能。

RouteMatrixVehicleSpec

Object

ルートマトリックスを計算するときに考慮する車両の高さ、重量、最大速度、貨物の種類などの車両属性を指定します。これは、車両仕様に基づいて最適化されたルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。 vehicle 属性は vehicleSpec プロパティ内で指定されます。

名前	型	規定値	説明
adrTunnelRestrictionCode	AdrTunnelRestrictionCodeEnum		ADR トンネル制限コード。 ADRは、道路による危険物の国際輸送に関する欧州協定です。 ADR トンネル制限コードは、車両が危険物の輸送を制限してトンネルを通過できるかどうかを判断するために使用されます。
axleWeight	integer (int64) minimum: 0 maximum: 1000000	0	車両の車軸あたりの重量 (kg)。値が 0 の場合、車軸あたりの重量制限は考慮されません。
height	number (double) minimum: 0 maximum: 1000000	0	車両の高さ (メートル単位)。値が 0 の場合、高さの制限は考慮されません。
isVehicleCommercial	boolean	False	車両が商用目的で使用されているかどうか。一部の道路では、商用車両の運転が許可されない場合があります。
length	number (double) minimum: 0 maximum: 1000000	0	車両の長さ (メートル単位)。値 0 は、長さの制限が考慮されないことを意味します。
loadType	VehicleLoadTypeEnum[]		危険物として分類され、一部の道路から制限される可能性のある貨物の種類。使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国では otherHazmat を使用する必要があります。 vehicleLoadType は、要求で複数の値をサポートします。
maxSpeed	integer (int64) minimum: 0 maximum: 250	0	km/時間での車両の最高速度。車両プロファイルの最大速度は、高速道路で車両が許可されているかどうかを確認するために使用されます。値が 0 の場合は、車両に適した値が決定され、ルート計画中に適用されることを意味します。ルート計画中に 0 以外の値がオーバーライドされる場合があります。たとえば、現在のトラフィックフローは 60 km/時間です。車両の最高速度が 50 km/時に設定されている場合、現在の状況であるため、ルーティングエンジンは 60 km/時間を考慮します。車両の最高速度が 80 km/時間として提供されているが、現在の交通フローが 60 km/時間の場合、ルーティングエンジンは再び 60 km/時間を使用します。
weight	integer (int64) minimum: 0 maximum: 1000000	0	車両の重量 (キロ単位)。値 0 は、重みの制限が考慮されないことを意味します。
width	number (double) minimum: 0 maximum: 1000000	0	車両の幅 (メートル単位)。値が 0 の場合、幅の制限は考慮されません。

RouteOperationKindEnum

列挙

非同期操作の種類

値	説明
RouteMatrix	ルートマトリックス非同期ジョブ。

VehicleLoadTypeEnum

列挙

危険物として分類され、一部の道路から制限される可能性のある貨物の種類。使用可能な vehicleLoadType 値は、米国の Hazmat クラス 1 から 9 に加えて、他の国で使用するための一般的な分類です。 USHazmat で始まる値は米国のルーティング用ですが、他のすべての国では otherHazmat を使用する必要があります。 vehicleLoadType は、要求で複数の値をサポートします。

値	説明
USHazmatClass1	Explosives
USHazmatClass2	圧縮ガス
USHazmatClass3	可燃性液体
USHazmatClass4	可燃性固体
USHazmatClass5	Oxidizers
USHazmatClass6	Poisons
USHazmatClass7	Radioactive
USHazmatClass8	Corrosives
USHazmatClass9	その他
otherHazmatExplosive	Explosives
otherHazmatGeneral	その他
otherHazmatHarmfulToWater	水に有害

次の方法で共有

Route - Post Route Matrix

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

API の制限事項

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

AADToken

スコープ

subscription-key

SAS Token

例

Successfully retrieve a route matrix with additional parameters in the body

要求のサンプル

応答のサンプル

定義

AdrTunnelRestrictionCodeEnum

ErrorAdditionalInfo

ErrorDetail

FeaturesItemTypeEnum

FeatureTypeEnum

GeoJsonMultiPoint

InputRouteMatrixFeaturesItem

InputRouteMatrixProperties

MapsErrorDetail

MapsErrorResponse

MapsInnerError

RouteMatrixAsyncResponse

RouteMatrixAvoidEnum

RouteMatrixFeatureProperties

RouteMatrixItemResult

RouteMatrixOptimizeRouteEnum

RouteMatrixRequest

RouteMatrixResponse

RouteMatrixSummary

RouteMatrixTrafficEnum

RouteMatrixTravelModeEnum

RouteMatrixTypeEnum

RouteMatrixVehicleSpec

RouteOperationKindEnum

VehicleLoadTypeEnum

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