Route - Post Route Range Batch

リファレンス

サービス:: Maps

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

ルート範囲バッチ API は、ルート範囲 API への 1 回の呼び出しとして、最大 100 クエリのバッチを送信します。この API を使用すると、1 つの要求で複数のクエリを効率的に処理できるため、個々の呼び出しの必要性が軽減されます。

同期バッチ要求の送信

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

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

バッチ要求の POST 本文

ルート範囲 クエリを送信するには、POST 要求を使用します。要求本文には batchItems 配列が json 形式で格納され、Content-Type ヘッダーは application/jsonに設定されます。 2 つの route_range クエリを含む要求本文の例を次に示します。

{
  "batchItems": [
    {
      "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.86605,
          50.9745
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    },
    {
      "optionalId": "300af787-589b-4088-accd-56828542e293",
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.201669,
          47.615076
        ]
      },
      "properties": {
        "timeBudgetInSec": 2000
      }
    }
  ]
}

batchItem オブジェクトルート範囲は、要求本文道路にスナップするサポートされているのいずれかを受け入

バッチには、少なくとも 1 つのクエリ含める必要があります。

バッチ応答モデル

バッチ応答には、元のバッチ要求の一部であった summary と、正常に実行されたクエリ totalRequests を示す successfulRequests コンポーネントが含まれています。バッチ応答には、バッチ要求内の各クエリに対する応答を含む batchItems 配列も含まれます。 batchItems には、元のクエリがバッチ要求で送信されたのとまったく同じ順序で結果が含まれます。各項目は、次のいずれかの種類です。

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

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

URI パラメーター

名前	/	必須	型	説明
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	RouteRangeBatchRequestItem[]	処理するクエリの一覧。

応答

名前	型	説明
200 OK	RouteRangeBatchResponse	バッチ要求が正常に処理されました。応答本文には、すべてのバッチ結果が含まれています。
Other Status Codes	MapsErrorResponse	予期しないエラーが発生しました。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

RouteRangeBatchResponse

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

Other Status Codes

MapsErrorResponse

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

ヘッダー

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

例

A Route Range Batch request containing 1 query

要求のサンプル

HTTP

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

{
  "batchItems": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.86605,
          50.9745
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          52.7109930507,
          -0.591556667114
        ]
      },
      "properties": {
        "timeBudgetInSec": 6000
      }
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "summary": {
    "successfulRequests": 1,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              5.86605,
              50.9745
            ]
          },
          "properties": {
            "type": "center"
          }
        },
        {
          "type": "Feature",
          "bbox": [
            3.62838,
            49.83259,
            7.9826,
            52.25674
          ],
          "geometry": {
            "type": "Polygon",
            "coordinates": [
              [
                [
                  5.73602,
                  52.03704
                ],
                [
                  5.59435,
                  52.09456
                ],
                [
                  5.42279,
                  52.16815
                ],
                [
                  5.21276,
                  52.25047
                ],
                [
                  5.15355,
                  52.21374
                ],
                [
                  4.96687,
                  52.25674
                ],
                [
                  4.739,
                  52.07834
                ],
                [
                  4.72513,
                  52.05647
                ],
                [
                  4.53237,
                  51.94553
                ],
                [
                  4.31165,
                  51.70119
                ],
                [
                  4.28917,
                  51.5837
                ],
                [
                  3.82685,
                  51.48463
                ],
                [
                  3.62838,
                  51.21096
                ],
                [
                  3.89244,
                  50.6814
                ],
                [
                  3.93493,
                  50.66791
                ],
                [
                  3.98156,
                  50.49042
                ],
                [
                  4.47995,
                  50.30944
                ],
                [
                  4.60502,
                  50.24448
                ],
                [
                  4.89999,
                  50.24467
                ],
                [
                  5.04206,
                  50.08735
                ],
                [
                  5.23042,
                  49.99214
                ],
                [
                  5.40994,
                  49.88478
                ],
                [
                  5.46178,
                  49.85797
                ],
                [
                  5.7196,
                  49.86279
                ],
                [
                  5.74151,
                  49.83259
                ],
                [
                  5.9387,
                  50.22239
                ],
                [
                  6.08535,
                  50.0011
                ],
                [
                  6.12089,
                  50.04616
                ],
                [
                  6.28373,
                  50.09472
                ],
                [
                  6.51654,
                  49.95863
                ],
                [
                  6.61034,
                  50.00485
                ],
                [
                  6.70295,
                  50.00587
                ],
                [
                  6.65865,
                  50.2947
                ],
                [
                  6.79276,
                  50.36903
                ],
                [
                  7.32163,
                  50.31614
                ],
                [
                  7.58782,
                  50.36737
                ],
                [
                  7.7626,
                  50.46919
                ],
                [
                  7.9826,
                  50.96246
                ],
                [
                  7.55924,
                  51.07086
                ],
                [
                  7.58138,
                  51.36614
                ],
                [
                  7.67861,
                  51.52015
                ],
                [
                  7.35175,
                  51.65781
                ],
                [
                  7.21664,
                  51.81916
                ],
                [
                  7.0467,
                  51.9587
                ],
                [
                  6.67267,
                  51.82713
                ],
                [
                  6.48424,
                  51.81133
                ],
                [
                  6.27316,
                  51.9368
                ],
                [
                  6.14452,
                  52.01701
                ],
                [
                  6.09312,
                  52.20847
                ],
                [
                  6.01297,
                  52.23705
                ],
                [
                  5.86605,
                  50.9745
                ],
                [
                  5.73602,
                  52.03704
                ]
              ]
            ]
          },
          "properties": {
            "type": "boundary"
          }
        }
      ]
    },
    {
      "error": {
        "code": "BadRequest",
        "message": "No routable road could be found near one or more specified points."
      }
    }
  ]
}

定義

名前	説明
AdrTunnelRestrictionCodeEnum	ADR トンネル制限コード。 ADRは、道路による危険物の国際輸送に関する欧州協定です。 ADR トンネル制限コードは、車両が危険物の輸送を制限してトンネルを通過できるかどうかを判断するために使用されます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
FeaturesItemTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は Feature のみです。詳細については、RFC 7946を参照してください。
FeatureTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は `FeatureCollection`のみです。詳細については、RFC 7946を参照してください。
InputRouteRangeProperties	等時線ポリゴンの計算に使用するパラメーターを指定します。
MapsErrorDetail	エラーの詳細。
MapsErrorResponse	失敗した操作のエラーの詳細を返す Azure Maps API の一般的なエラー応答。
MapsInnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
RouteRangeAvoidEnum	到達可能な場所を決定するときにルート計算で考慮される制限を指定します。回避では、要求で複数の値がサポートされます。例: "avoid": ["limitedAccessHighways", "tollRoads"]
RouteRangeBatchRequestBody	処理するルート範囲クエリ/要求の一覧。リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。
RouteRangeBatchRequestItem	Batch Query オブジェクト
RouteRangeBatchResponse	このオブジェクトは、ルート範囲バッチサービス呼び出しが成功した場合に返されます。
RouteRangeBatchResponseItem	バッチ応答項目
RouteRangeFeatureProperties	ルート範囲のプロパティ。
RouteRangeFeaturesItem	Geometry オブジェクトとルートの追加プロパティを含む GeoJSON フィーチャオブジェクト。
RouteRangeOptimizeRouteEnum	ルートの最適化に使用するパラメーターを指定します。定義されていない場合、既定値は "fastestWithoutTraffic" であり、現在の交通情報を使用せずに移動時間を最小限に抑えるためにルートを返します。例: "optimizeRoute":"shortest"
RouteRangePointGeometry	`GeoJSON` Point Geometry オブジェクトを指定します。詳細については、RFC 7946 を参照してください。
RouteRangePolygonGeometry	`GeoJSON` Polygon Geometry オブジェクトを指定します。詳細については、RFC 7946 を参照してください。
RouteRangeTravelModeEnum	範囲ポリゴンを計算するときに考慮する移動プロファイルを指定します。指定しない場合、既定値は "driving" です。例: "travelMode":"driving"
RouteRangeTypeEnum	応答で返されるフィーチャオブジェクトのフィーチャタイプ。
RouteRangeVehicleSpec	到達可能な場所を計算するときに考慮する車両の高さ、重量、最大速度、貨物の種類などの車両属性を指定します。これは、車両仕様に基づいて最適化されたトラックルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。 vehicle 属性は vehicleSpec プロパティ内で指定されます。
Summary	バッチ要求の概要
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` オブジェクトの種類を指定します。

InputRouteRangeProperties

Object

等時線ポリゴンの計算に使用するパラメーターを指定します。

名前	型	規定値	説明
avoid	RouteRangeAvoidEnum[]		到達可能な場所を決定するときにルート計算で考慮される制限を指定します。回避では、要求で複数の値がサポートされます。例: "avoid": ["limitedAccessHighways", "tollRoads"]
departAt	string (date-time)		RFC 3339 セクション 5.6で定義された dateTime 値として書式設定された出発地点からの出発日時。タイムゾーンオフセットが指定されていない場合、UTC が想定されます。 `departAt` が設定されていない場合、既定値は現在の時刻です。例： "departAt": "2023-06-01T09:30:00.000-07:00"
distanceBudgetInMeters	number (float) minimum: 0 maximum: 500000		距離の予算は、原点のウェイポイントから移動できる最大範囲をメートル単位で指定します。 `timeBudgetInSec` が指定されている場合は設定できません。サポートされる最大距離は 500,000 メートルです。例: "distanceBudgetInMeters":5000
isSimplifiedPolygon	boolean	True	これを使用して、簡略化された多角形が必要かどうかを指定し、図形全体を維持しながら頂点の数を減らします。現在、 `isSimplifiedPolygon` では `true`のみがサポートされています。高解像度ポリゴンのサポートは近日中に提供される予定です。詳細および高解像度ポリゴンを試すには、ルートサービスパブリックプレビューの「ルート範囲の後」を参照してください。
optimizeRoute	RouteRangeOptimizeRouteEnum	fastestWithoutTraffic	ルートの最適化に使用するパラメーターを指定します。定義されていない場合、既定値は "fastestWithoutTraffic" であり、現在の交通情報を使用せずに移動時間を最小限に抑えるためにルートを返します。例: "optimizeRoute":"shortest"
timeBudgetInSec	number (float) minimum: 0 maximum: 21600		時間の予算では、移動に使用できる最大時間 (秒) を指定し、出発地のウェイポイントからこの時間制約内に移動できる距離を定義します。 `distanceBudgetInMeters` が指定されている場合は設定できません。サポートされる最大時間は 21,600 秒です。例: "timeBudgetInSec":3600
travelMode	RouteRangeTravelModeEnum	driving	範囲ポリゴンを計算するときに考慮する移動プロファイルを指定します。指定しない場合、既定値は "driving" です。例: "travelMode":"driving"
vehicleSpec	RouteRangeVehicleSpec		到達可能な場所を計算するときに考慮する車両の高さ、重量、最大速度、貨物の種類などの車両属性を指定します。これは、車両仕様に基づいて最適化されたトラックルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。 vehicle 属性は vehicleSpec プロパティ内で指定されます。

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	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

RouteRangeAvoidEnum

列挙

到達可能な場所を決定するときにルート計算で考慮される制限を指定します。回避では、要求で複数の値がサポートされます。

例: "avoid": ["limitedAccessHighways", "tollRoads"]

値	説明
borderCrossings	ルート内の国境を越えないようにします。
carTrains	車の列車を避けます。
carpools	carpool の使用を必要とするルートを回避します。
ferries	ルート内でのフェリーの使用を回避します。
limitedAccessHighways	ルート内のアクセス制限付き高速道路の使用を回避します。
lowEmissionZones	ルート内の低排出ゾーンを回避します。
tollRoads	ルート内の有料道路の使用を回避します。
tunnels	ルートでのトンネルの使用を回避します。
unpavedRoads	ルート内の未舗装道路を回避します。

RouteRangeBatchRequestBody

Object

処理するルート範囲クエリ/要求の一覧。リストには最大 100 個のクエリを含めることができます。少なくとも 1 つのクエリを含む必要があります。

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

RouteRangeBatchRequestItem

Object

Batch Query オブジェクト

名前	型	説明
geometry	RouteRangePointGeometry	`GeoJSON` Point Geometry オブジェクトを指定します。詳細については、RFC 7946 を参照してください。
optionalId	string	対応する batchItem に表示される要求の ID。
properties	InputRouteRangeProperties	等時線ポリゴンの計算に使用するパラメーターを指定します。
type	FeaturesItemTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は Feature のみです。詳細については、RFC 7946を参照してください。

RouteRangeBatchResponse

Object

このオブジェクトは、ルート範囲バッチサービス呼び出しが成功した場合に返されます。

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

RouteRangeBatchResponseItem

Object

バッチ応答項目

名前	型	説明
error	ErrorDetail	エラーの詳細。
features	RouteRangeFeaturesItem[]	Geometry オブジェクトと追加のプロパティを含むフィーチャーオブジェクトを `GeoJSON` します。詳細については、RFC 7946 セクション 3.2 を参照してください。
optionalId	string	対応する batchItem に表示される要求の ID。
type	FeatureTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は `FeatureCollection`のみです。詳細については、RFC 7946を参照してください。

RouteRangeFeatureProperties

Object

ルート範囲のプロパティ。

名前	型	説明
type	RouteRangeTypeEnum	応答で返されるフィーチャオブジェクトのフィーチャタイプ。

RouteRangeFeaturesItem

Object

Geometry オブジェクトとルートの追加プロパティを含む GeoJSON フィーチャオブジェクト。

名前	型	説明
bbox	number[] (double)	境界ボックスオブジェクトとして定義された、地球の四角形領域。四角形の辺は、緯度と経度の値によって定義されます。詳細については、RFC 7946、セクション 5を参照してください。例: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry	RouteRangeGeometry: RouteRangePointGeometry RouteRangePolygonGeometry	有効な `GeoJSON` Geometry オブジェクトです。詳細については、RFC 7946 を参照してください。
properties	RouteRangeFeatureProperties	ルート範囲のプロパティ。
type	FeaturesItemTypeEnum	`GeoJSON` 型を指定します。サポートされているオブジェクトの種類は Feature のみです。詳細については、RFC 7946を参照してください。

RouteRangeOptimizeRouteEnum

列挙

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

例: "optimizeRoute":"shortest"

値	説明
fastestWithTraffic	ルートは、現在のトラフィック情報を使用して時間を最小限に抑えるために計算されます。 `Note`: 運転とトラックの travelMode でのみサポートされます。
fastestWithoutTraffic	トラフィック情報を考慮せずに、最速のルートを検索します。
shortest	ルートは、距離を最小限に抑えるために計算されます。トラフィック情報は使用されません。

RouteRangePointGeometry

Object

GeoJSON Point Geometry オブジェクトを指定します。詳細については、RFC 7946 を参照してください。

名前	型	説明
coordinates	number[] (double)	`Position` は、2 つ以上の要素を持つ数値の配列です。最初の 2 つの要素は、経度、緯度正確にその順序で示されます。高度/標高は、オプションの 3 番目の要素です。詳細については、RFC 7946 を参照してください。
type	string: Point	`GeoJSON` Geometry オブジェクトのジオメトリの種類を指定します。詳細については、RFC 7946 を参照してください。

RouteRangePolygonGeometry

Object

GeoJSON Polygon Geometry オブジェクトを指定します。詳細については、RFC 7946 を参照してください。

名前	型	説明
coordinates	number[] (double)	`GeoJson Polygon` geometry タイプの座標。
type	string: Polygon	`GeoJSON` Geometry オブジェクトのジオメトリの種類を指定します。詳細については、RFC 7946 を参照してください。

RouteRangeTravelModeEnum

列挙

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

例: "travelMode":"driving"

値	説明
driving	車に適したルーティングプロファイルは、範囲ポリゴンの計算に使用されます。
truck	トラックなどの商用車両に適したルーティングプロファイルは、範囲ポリゴン計算に使用されます。

RouteRangeTypeEnum

列挙

応答で返されるフィーチャオブジェクトのフィーチャタイプ。

値	説明
boundary	境界フィーチャタイプは範囲ポリゴンを表します。
center	中心点フィーチャタイプは、範囲ポリゴン計算に使用される点を表します。

RouteRangeVehicleSpec

Object

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

名前	型	規定値	説明
adrTunnelRestrictionCode	AdrTunnelRestrictionCodeEnum		ADR トンネル制限コード。 ADRは、道路による危険物の国際輸送に関する欧州協定です。 ADR トンネル制限コードは、車両が危険物の輸送を制限してトンネルを通過できるかどうかを判断するために使用されます。
axleCount	integer (int64)		車両の車軸の数。
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 の場合、幅の制限は考慮されません。

Summary

Object

バッチ要求の概要

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

VehicleLoadTypeEnum

列挙

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

値	説明
USHazmatClass1	爆発物
USHazmatClass2	圧縮ガス
USHazmatClass3	引火性液体
USHazmatClass4	可燃性固体
USHazmatClass5	酸化剤
USHazmatClass6	毒
USHazmatClass7	放射性
USHazmatClass8	腐食性物質
USHazmatClass9	その他
otherHazmatExplosive	爆発物
otherHazmatGeneral	その他
otherHazmatHarmfulToWater	水に有害

次の方法で共有

Route - Post Route Range Batch

同期バッチ要求の送信

バッチ要求の POST 本文

バッチ応答モデル

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

AADToken

スコープ

subscription-key

SAS Token

例

A Route Range Batch request containing 1 query

要求のサンプル

応答のサンプル

定義

AdrTunnelRestrictionCodeEnum

ErrorAdditionalInfo

ErrorDetail

FeaturesItemTypeEnum

FeatureTypeEnum

InputRouteRangeProperties

MapsErrorDetail

MapsErrorResponse

MapsInnerError

RouteRangeAvoidEnum

RouteRangeBatchRequestBody

RouteRangeBatchRequestItem

RouteRangeBatchResponse

RouteRangeBatchResponseItem

RouteRangeFeatureProperties

RouteRangeFeaturesItem

RouteRangeOptimizeRouteEnum

RouteRangePointGeometry

RouteRangePolygonGeometry

RouteRangeTravelModeEnum

RouteRangeTypeEnum

RouteRangeVehicleSpec

Summary

VehicleLoadTypeEnum