次の方法で共有


Route - Post Route Directions

自動車、商用トラック、徒歩ルートの出発地と目的地の間の最適なルートを取得するために使用します。

Route Directions API は、自動車 (運転)、商用トラック、徒歩ルートの出発地と目的地の間の理想的なルートを返す HTTP POST 要求です。 指定された場合、ルートは一連のウェイポイントを通過します。 ウェイポイントは、ナビゲーション目的で使用される経度と緯度で定義された地理的な場所です。 ルートでは、現在のトラフィックや、要求された曜日と時間帯の一般的な道路速度などの要因が考慮されます。

この API は、距離、推定移動時間、およびルート ジオメトリの表現を返します。 使用されるパラメーターに応じて、最適化されたウェイポイントの順序やターンバイターン命令などのルーティング情報も利用できます。

ルート案内では、トラック固有のルートを計算し、複雑な操縦や困難な道路を回避するために、現地の法律、車両寸法、貨物の種類、最高速度、橋、トンネルの高さを考慮します。 車両プロファイルまたは貨物の種類に基づく特定の制限により、すべてのトラックが他の車両と同じルートを移動できるわけではありません。 たとえば、高速道路ではトラックの速度制限が個別に設定されることがよくあります。道路によっては、引火性や危険物を含むトラックが許可されていない場合や、橋の高さと重量の制限が存在する場合があります。

最大 150 のウェイポイントと、任意の 2 つのウェイポイント間の 10 の viaWaypoints がサポートされます。 ウェイポイントのセットごとに、個別のルート Leg が作成されます。 ViaWaypoints はルート パスを定義し、特定の場所を介したルートの作成に使用できますが、ルート レッグは作成されません。

国や地域ごとのルーティング利用可能性については、Azure Mapsルーティングカバレッジを参照してください。

POST https://atlas.microsoft.com/route/directions?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の認証管理Manage certificationをご覧ください。

Accept-Language

string

ルーティング結果を返す言語。

詳細については、Azure Mapsのローカリゼーションサポートをご覧ください。

要求本文

Media Types: "application/geo+json"

名前 必須 説明
features True

InputWaypointFeaturesItem[]

運転、徒歩、およびトラックのルートは、一連のウェイポイント (ストップ) と viaWaypoints (ルートが通過する必要がある中間位置) によって定義されます。 ウェイポイントは最大 150 個、各ウェイポイント セット間には最大 10 個の viaWaypoints を設定できます。

ルートには 2 つ以上のウェイポイントが必要であり、ルートの始点と終点を経由することはできません。

ウェイポイントと viaWaypoint の両方の場所は、場所の順序を指定する pointIndex と共に、有効な GeoJSON ポイント フィーチャ オブジェクトとして指定する必要があります。 GeoJSON 形式の詳細については、 RFC 7946 を参照してください。

type True

FeatureTypeEnum

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

arriveAt

string (date-time)

RFC 3339 セクション 5.6で定義された 値として書式設定された宛先ポイントへの到着日時 。 タイム ゾーン オフセットが指定されていない場合、UTC が想定されます。

arriveAt パラメーターは、departAtと組み合わせて使用することはできません。

例: "arriveAt": "2023-06-01T09:30:00.000-07:00"

avoid

AvoidEnum[]

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

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

departAt

string (date-time)

RFC 3339、セクション 5.6で定義 値として書式設定された出発地からの出発日時。 タイム ゾーン オフセットが指定されていない場合、UTC が想定されます。

departAt が設定されていない場合、既定値は現在の時刻です。

例:

"出発時": "2023-06-01T09:30:00.000-07:00"

heading

integer (int64)

minimum: 0
maximum: 359

真北から時計回りの方向に続く、車両の最初の方向方向の方位を度単位で指定します。 北は 0 度、東は 90 度、南は 180 度、西は 270 度です。

maxRouteCount

integer (int64)

minimum: 1
maximum: 6

返されるルートの最大数。 運転およびトラックの移動モードのために利用できる。

デフォルト: "maxRouteCount":1

optimizeRoute

RouteDirectionOptimizeRouteEnum

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

例: "optimizeRoute":"shortest"

optimizeWaypointOrder

boolean

高速ヒューリスティック アルゴリズムを使用してルート ウェイポイントの順序を変更し、最適化パラメーターで指定されたルート コストを削減します。 出発地と目的地は最適化されたウェイポイントから除外され、その位置は固定と見なされます。 許容される値は true または false です。

routeOutputOptions

RouteOutputOptionEnum[]

応答から必要なルート情報を含めます。 既定では、応答には旅程が含まれます。

"routeOutputOptions": ["routePath", "itinerary"] のような複数の値をサポートします。

travelMode

TravelModeEnum

要求されたルートの移動モード。 定義されていない場合、既定値は車用に最適化されたルートを返す "driving" です。

Note: トラック travelMode の場合、要求されたトラック ルートがルート全体で使用できない場合があります。 トラック ルートが特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。

例: "travelMode":"driving"

vehicleSpec

RouteDirectionVehicleSpec

トラックのルーティング専用に、サイズ、重量、最大速度、貨物の種類などの車両属性を指定します。 これは、車両仕様に基づいて最適化されたトラックルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。

Note: トラック travelMode でのみサポートされます

応答

名前 説明
200 OK

RouteDirectionsResponse

[OK]

Media Types: "application/geo+json", "application/json"

Other Status Codes

MapsErrorResponse

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

Media Types: "application/geo+json", "application/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リソースにアクセスを要求しているかを示すためにx-ms-client-idヘッダーを使用します。 これは、Maps 管理 APIから取得できます。
  • Authorization URLはAzureパブリッククラウドインスタンス専用です。 ソブリンクラウドは固有の認可URLとMicrosoft Entra IDの設定を持っています。
  • Azureロールベースのアクセス制御は、Azureポータル、PowerShell、CLI、Azure SDKs、または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 Mapsリソースを作成する際に、Azureポータル、PowerShell、CLI、Azure SDKs、REST APIを通じてAzure管理プレーンを通じてプロビジョニングされます。

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

公開されているアプリケーションについては、このキーを安全に保存できるAzure Maps REST APIのサーバー間アクセスを利用することを推奨します。

型: apiKey
/: header

SAS Token

これは共有アクセス署名トークンで、Azure MapsリソースのList SAS操作からAzureポータル、PowerShell、CLI、Azure SDKs、REST APIを通じてAzure管理プレーンを経由して作成されます。

このトークンにより、どのアプリケーションもAzureの役割ベースのアクセス制御と細かい制御で、そのトークンの有効期限、速度、使用地域へのアクセスが許可されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

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

型: apiKey
/: header

Successfully retrieve a route between an origin and a destination with additional parameters in the body

要求のサンプル

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

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.201399,
          47.608678
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 0,
        "pointType": "waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.20687,
          47.612002
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 1,
        "pointType": "viaWaypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.201669,
          47.615076
        ],
        "type": "Point"
      },
      "properties": {
        "pointIndex": 2,
        "pointType": "waypoint"
      }
    }
  ],
  "optimizeRoute": "fastestWithTraffic",
  "routeOutputOptions": [
    "routePath"
  ],
  "maxRouteCount": 3,
  "travelMode": "driving"
}

応答のサンプル

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.20147,
          47.60868
        ]
      },
      "properties": {
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 0
        },
        "order": {
          "inputIndex": 0
        },
        "type": "Waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [
          -122.2016,
          47.61508
        ]
      },
      "properties": {
        "routePathPoint": {
          "legIndex": 0,
          "pointIndex": 64
        },
        "order": {
          "inputIndex": 2
        },
        "type": "Waypoint"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "MultiLineString",
        "coordinates": [
          [
            [
              -122.20147,
              47.60868
            ],
            [
              -122.20148,
              47.60884
            ],
            [
              -122.20148,
              47.60906
            ],
            [
              -122.20148,
              47.60919
            ],
            [
              -122.20148,
              47.60953
            ],
            [
              -122.20148,
              47.60967
            ],
            [
              -122.20149,
              47.60997
            ],
            [
              -122.2015,
              47.61011
            ],
            [
              -122.2015,
              47.61019
            ],
            [
              -122.20192,
              47.61021
            ],
            [
              -122.20199,
              47.61021
            ],
            [
              -122.20252,
              47.61019
            ],
            [
              -122.20264,
              47.61018
            ],
            [
              -122.20271,
              47.61015
            ],
            [
              -122.20276,
              47.61015
            ],
            [
              -122.20281,
              47.61015
            ],
            [
              -122.20286,
              47.61015
            ],
            [
              -122.20329,
              47.61016
            ],
            [
              -122.20346,
              47.61016
            ],
            [
              -122.20414,
              47.61017
            ],
            [
              -122.20416,
              47.61057
            ],
            [
              -122.20418,
              47.61083
            ],
            [
              -122.20418,
              47.61092
            ],
            [
              -122.20419,
              47.61103
            ],
            [
              -122.20419,
              47.61121
            ],
            [
              -122.2042,
              47.61126
            ],
            [
              -122.20478,
              47.61127
            ],
            [
              -122.20555,
              47.61128
            ],
            [
              -122.20569,
              47.61128
            ],
            [
              -122.20596,
              47.61128
            ],
            [
              -122.20617,
              47.61127
            ],
            [
              -122.20624,
              47.61125
            ],
            [
              -122.2066,
              47.61126
            ],
            [
              -122.20669,
              47.61127
            ],
            [
              -122.20686,
              47.61129
            ],
            [
              -122.20687,
              47.61158
            ],
            [
              -122.20689,
              47.61187
            ],
            [
              -122.20691,
              47.61233
            ],
            [
              -122.20691,
              47.61247
            ],
            [
              -122.20694,
              47.61317
            ],
            [
              -122.20695,
              47.61342
            ],
            [
              -122.20696,
              47.61362
            ],
            [
              -122.20697,
              47.61384
            ],
            [
              -122.20683,
              47.61384
            ],
            [
              -122.20638,
              47.61384
            ],
            [
              -122.20612,
              47.61384
            ],
            [
              -122.20568,
              47.61383
            ],
            [
              -122.20559,
              47.6138
            ],
            [
              -122.20467,
              47.61379
            ],
            [
              -122.20443,
              47.61379
            ],
            [
              -122.20405,
              47.61379
            ],
            [
              -122.20325,
              47.6138
            ],
            [
              -122.203,
              47.6138
            ],
            [
              -122.20274,
              47.6138
            ],
            [
              -122.20241,
              47.61381
            ],
            [
              -122.20222,
              47.6138
            ],
            [
              -122.20202,
              47.6138
            ],
            [
              -122.20193,
              47.6138
            ],
            [
              -122.20181,
              47.61386
            ],
            [
              -122.20167,
              47.61386
            ],
            [
              -122.20155,
              47.61386
            ],
            [
              -122.20158,
              47.61464
            ],
            [
              -122.20159,
              47.61475
            ],
            [
              -122.2016,
              47.61503
            ],
            [
              -122.2016,
              47.61508
            ]
          ]
        ]
      },
      "properties": {
        "distanceInMeters": 1520,
        "durationInSeconds": 307,
        "departureAt": "2025-06-17T09:08:10+00:00",
        "arrivalAt": "2025-06-17T09:13:10+00:00",
        "durationTrafficInSeconds": 300,
        "trafficCongestion": "Medium",
        "type": "RoutePath",
        "legs": [
          {
            "distanceInMeters": 1520,
            "durationInSeconds": 307,
            "durationTrafficInSeconds": 300,
            "departureAt": "2025-06-17T09:08:10+00:00",
            "arrivalAt": "2025-06-17T09:13:10+00:00",
            "routePathRange": {
              "legIndex": 0,
              "range": [
                0,
                64
              ]
            }
          }
        ]
      },
      "bbox": [
        -122.20697,
        47.60868,
        -122.20147,
        47.61508
      ]
    }
  ],
  "alternativeRoutes": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.20147,
              47.60868
            ]
          },
          "properties": {
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 0
            },
            "order": {
              "inputIndex": 0
            },
            "type": "Waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.2016,
              47.61508
            ]
          },
          "properties": {
            "routePathPoint": {
              "legIndex": 0,
              "pointIndex": 29
            },
            "order": {
              "inputIndex": 1
            },
            "type": "Waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": [
              [
                [
                  -122.20147,
                  47.60868
                ],
                [
                  -122.20148,
                  47.60884
                ],
                [
                  -122.20148,
                  47.60906
                ],
                [
                  -122.20148,
                  47.60919
                ],
                [
                  -122.20148,
                  47.60953
                ],
                [
                  -122.20148,
                  47.60967
                ],
                [
                  -122.20149,
                  47.60997
                ],
                [
                  -122.2015,
                  47.61011
                ],
                [
                  -122.2015,
                  47.61019
                ],
                [
                  -122.20151,
                  47.61072
                ],
                [
                  -122.20152,
                  47.61092
                ],
                [
                  -122.20152,
                  47.61097
                ],
                [
                  -122.20149,
                  47.611
                ],
                [
                  -122.20147,
                  47.61104
                ],
                [
                  -122.20145,
                  47.61117
                ],
                [
                  -122.20145,
                  47.61122
                ],
                [
                  -122.20145,
                  47.61126
                ],
                [
                  -122.20146,
                  47.61149
                ],
                [
                  -122.20147,
                  47.61166
                ],
                [
                  -122.20148,
                  47.61197
                ],
                [
                  -122.20148,
                  47.61203
                ],
                [
                  -122.2015,
                  47.61268
                ],
                [
                  -122.20151,
                  47.61289
                ],
                [
                  -122.20152,
                  47.61297
                ],
                [
                  -122.20153,
                  47.61338
                ],
                [
                  -122.20155,
                  47.61386
                ],
                [
                  -122.20158,
                  47.61464
                ],
                [
                  -122.20159,
                  47.61475
                ],
                [
                  -122.2016,
                  47.61503
                ],
                [
                  -122.2016,
                  47.61508
                ]
              ]
            ]
          },
          "properties": {
            "distanceInMeters": 713,
            "durationInSeconds": 92,
            "departureAt": "2025-06-17T09:08:10+00:00",
            "arrivalAt": "2025-06-17T09:09:40+00:00",
            "durationTrafficInSeconds": 90,
            "trafficCongestion": "Medium",
            "type": "RoutePath",
            "legs": [
              {
                "distanceInMeters": 713,
                "durationInSeconds": 92,
                "durationTrafficInSeconds": 90,
                "departureAt": "2025-06-17T09:08:10+00:00",
                "arrivalAt": "2025-06-17T09:09:40+00:00",
                "routePathRange": {
                  "legIndex": 0,
                  "range": [
                    0,
                    29
                  ]
                }
              }
            ]
          },
          "bbox": [
            -122.2016,
            47.60868,
            -122.20145,
            47.61508
          ]
        }
      ]
    }
  ]
}

定義

名前 説明
Address

ルート上のウェイポイントとマニューバポイントの行政区域と国地域。

AdminDistrict

住所の国または地域の下位区分名。 この要素は通常、最初の注文管理下位区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。

AdrTunnelRestrictionCodeEnum

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

AvoidEnum

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

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

CountryRegion

関連する詳細を含む国または地域を表します。

DirectionsRequest

このオブジェクトは要求本文です。

DrivingSideEnum

操縦のポイントでの左手と右側の運転を示します。

FeatureCollection

フィーチャーの一覧を含むオブジェクトを GeoJSONFeatureCollection します。 詳細については、RFC 7946 のセクション 3.3を参照してください。

FeaturesItem

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

FeaturesItemTypeEnum

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

FeatureTypeEnum

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

GeoJsonPoint

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

InputWaypointFeaturesItem

入力ウェイポイントと viaWaypoint GeoJSON 機能オブジェクトと追加のプロパティを指定します。 詳細については、RFC 7946を参照してください。

InputWaypointProperties

参照または停止ポイントとして機能するルートまたは乗車に沿った特定の場所またはポイントであるウェイポイントのプロパティを指定します。

InputWaypointTypeEnum

ルート上のウェイポイントの種類。 ルートを通過する必要がある停止または中間の場所を指定できます。

Instruction

一連の方向での操縦の説明。

Leg

2 つのウェイポイント間のルートのセクションに関する情報。 ルート レッグに含まれるフィールドの詳細:

ManeuverPointProperties

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

ManeuverTypeEnum

この詳細なコレクションで説明されている操縦の種類。 マヌーバタイプは、対応する命令で指定された操縦の一部に関する情報を提供します。 たとえば、命令のマヌーバタイプは TurnLeftThenTurnRight を指定し、関連する詳細項目は TurnLeft と TurnRight の操縦に関する詳細を提供する場合があります。

MapsErrorDetail

エラーの詳細。

MapsErrorResponse

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

MapsInnerError

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

MultiLineStringGeometry

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

OptimizedWaypoint

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

Order

ウェイポイントを訪問するためのシーケンス。

PointGeometry

有効な GeoJSON Geometry オブジェクトとして渡される原点。このオブジェクトから範囲ポリゴンを計算する必要があります。 詳細については、RFC 7946 を参照してください。

Note: API は、要求された起点を最も近い道路ネットワークにスナップし、範囲の計算に使用します。 応答の center ポイントとして返されます。

RouteDirectionOptimizeRouteEnum

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

例: "optimizeRoute":"shortest"

RouteDirectionsResponse

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

RouteDirectionVehicleSpec

トラックのルーティング専用に、サイズ、重量、最大速度、貨物の種類などの車両属性を指定します。 これは、車両仕様に基づいて最適化されたトラックルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。

ISNote: トラック travelMode でのみサポートされます。

RouteOutputOptionEnum

応答から必要なルート情報を含めます。 既定では、応答には旅程が含まれます。

"routeOutputOptions": ["routePath", "itinerary"] のような複数の値をサポートします。

RoutePathPoint

ルートの特定の区間内のポイントのインデックスを参照します。

RoutePathProperties

応答内のルートのパスを記述するプロパティを指定します。

RoutePathRange

ルートまたはパスの特定のレッグでカバーされる範囲を参照します。

RoutePathTravelModeEnum

応答内のルート パスの移動モード。

SideOfStreetEnum

到着方向に基づいて目的地が見つかった通りの側。 このフィールドは、最後の操作ポイントにのみ適用されます。

Step

ルートレッグにはターンバイターン命令が含まれています。 ステップとは、2 つの連続する移動ポイント間のルートの範囲を指します。

TrafficCongestionEnum

ルートに沿った交通渋滞のレベル。 Note: travelMode の運転でのみサポートされます

TravelModeEnum

要求されたルートの移動モード。 定義されていない場合、既定値は車用に最適化されたルートを返す "driving" です。

Note: トラック travelMode の場合、要求されたトラック ルートがルート全体で使用できない場合があります。 トラック ルートが特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。

例: "travelMode":"driving"

VehicleLoadTypeEnum

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

WaypointProperties

参照または停止ポイントとして機能するルートまたは乗車に沿った特定の場所またはポイントであるウェイポイントのプロパティを指定します。

Address

ルート上のウェイポイントとマニューバポイントの行政区域と国地域。

名前 説明
adminDistricts

AdminDistrict[]

住所の国または地域の下位区分名。 この要素は通常、最初の注文管理下位区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。

countryRegion

CountryRegion

関連する詳細を含む国または地域を表します。

AdminDistrict

住所の国または地域の下位区分名。 この要素は通常、最初の注文管理下位区分として扱われますが、場合によっては、国、依存関係、またはリージョンの 2 番目、3 番目、または 4 番目の下位区分も含まれます。

名前 説明
shortName

string

対応する adminDistrict フィールドの短い名前(adminDistrict[0]の場合)、WA などの状態の短い名前を指定できます。 これは、米国、カナダ、メキシコでのみ使用できます。

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 の道路から制限されます。

AvoidEnum

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

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

説明
limitedAccessHighways

ルート内のアクセス制限付き高速道路の使用を回避します。

tollRoads

ルート内の有料道路の使用を回避します。

ferries

ルート内でのフェリーの使用を回避します。

tunnels

ルートでのトンネルの使用を回避します。

borderCrossings

ルート内の国境を越えないようにします。

lowEmissionZones

ルート内の低排出ゾーンを回避します。

unpavedRoads

ルート内の未舗装道路を回避します。

CountryRegion

関連する詳細を含む国または地域を表します。

名前 説明
ISO

string

国/地域の ISO は ISO 3166-1 Alpha-2 リージョン/国コードを表します

name

string

国/地域の名前

DirectionsRequest

このオブジェクトは要求本文です。

名前 規定値 説明
arriveAt

string (date-time)

RFC 3339 セクション 5.6で定義された 値として書式設定された宛先ポイントへの到着日時 。 タイム ゾーン オフセットが指定されていない場合、UTC が想定されます。

arriveAt パラメーターは、departAtと組み合わせて使用することはできません。

例: "arriveAt": "2023-06-01T09:30:00.000-07:00"

avoid

AvoidEnum[]

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

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

departAt

string (date-time)

RFC 3339、セクション 5.6で定義 値として書式設定された出発地からの出発日時。 タイム ゾーン オフセットが指定されていない場合、UTC が想定されます。

departAt が設定されていない場合、既定値は現在の時刻です。

例:

"出発時": "2023-06-01T09:30:00.000-07:00"

features

InputWaypointFeaturesItem[]

運転、徒歩、およびトラックのルートは、一連のウェイポイント (ストップ) と viaWaypoints (ルートが通過する必要がある中間位置) によって定義されます。 ウェイポイントは最大 150 個、各ウェイポイント セット間には最大 10 個の viaWaypoints を設定できます。

ルートには 2 つ以上のウェイポイントが必要であり、ルートの始点と終点を経由することはできません。

ウェイポイントと viaWaypoint の両方の場所は、場所の順序を指定する pointIndex と共に、有効な GeoJSON ポイント フィーチャ オブジェクトとして指定する必要があります。 GeoJSON 形式の詳細については、 RFC 7946 を参照してください。

heading

integer (int64)

minimum: 0
maximum: 359

真北から時計回りの方向に続く、車両の最初の方向方向の方位を度単位で指定します。 北は 0 度、東は 90 度、南は 180 度、西は 270 度です。

maxRouteCount

integer (int64)

minimum: 1
maximum: 6

返されるルートの最大数。 運転およびトラックの移動モードのために利用できる。

デフォルト: "maxRouteCount":1

optimizeRoute

RouteDirectionOptimizeRouteEnum

fastestWithoutTraffic

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

例: "optimizeRoute":"shortest"

optimizeWaypointOrder

boolean

False

高速ヒューリスティック アルゴリズムを使用してルート ウェイポイントの順序を変更し、最適化パラメーターで指定されたルート コストを削減します。 出発地と目的地は最適化されたウェイポイントから除外され、その位置は固定と見なされます。 許容される値は true または false です。

routeOutputOptions

RouteOutputOptionEnum[]

[ "itinerary" ]

応答から必要なルート情報を含めます。 既定では、応答には旅程が含まれます。

"routeOutputOptions": ["routePath", "itinerary"] のような複数の値をサポートします。

travelMode

TravelModeEnum

driving

要求されたルートの移動モード。 定義されていない場合、既定値は車用に最適化されたルートを返す "driving" です。

Note: トラック travelMode の場合、要求されたトラック ルートがルート全体で使用できない場合があります。 トラック ルートが特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。

例: "travelMode":"driving"

type

FeatureTypeEnum

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

vehicleSpec

RouteDirectionVehicleSpec

トラックのルーティング専用に、サイズ、重量、最大速度、貨物の種類などの車両属性を指定します。 これは、車両仕様に基づいて最適化されたトラックルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。

Note: トラック travelMode でのみサポートされます

DrivingSideEnum

操縦のポイントでの左手と右側の運転を示します。

説明
Left

左側の運転。

Right

右側の運転。

FeatureCollection

フィーチャーの一覧を含むオブジェクトを GeoJSONFeatureCollection します。 詳細については、RFC 7946 のセクション 3.3を参照してください。

名前 説明
features

FeaturesItem[]

Geometry オブジェクトと追加のプロパティを含むフィーチャー オブジェクトを GeoJSON します。 詳細については、RFC 7946、セクション 3.2を参照してください。

type

FeatureTypeEnum

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

FeaturesItem

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

名前 説明
bbox

number[] (double)

境界ボックス オブジェクトとして定義された、地球の四角形領域。 四角形の辺は、緯度と経度の値によって定義されます。 詳細については、RFC 7946、セクション 5を参照してください。

例: "bbox": [-10.0, -10.0, 10.0, 10.0]

geometry RouteDirectionsGeometry:

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

properties FeatureProperties:

旅程、ルートの脚とジオメトリ、旅行の概要など、ルートの特徴プロパティを指定します。

type

FeaturesItemTypeEnum

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

FeaturesItemTypeEnum

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

説明
Feature

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

FeatureTypeEnum

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

説明
FeatureCollection

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

GeoJsonPoint

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

名前 説明
coordinates

number[] (double)

Position は、2 つ以上の要素を持つ数値の配列です。 最初の 2 つの要素は、経度 、緯度正確にその順序で示されます。 高度/標高 は、オプションの 3 番目の要素です。 詳細については、RFC 7946 を参照してください。

type string:

Point

GeoJSON 型を指定します。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクト タイプのいずれかである必要があります。

InputWaypointFeaturesItem

入力ウェイポイントと viaWaypoint GeoJSON 機能オブジェクトと追加のプロパティを指定します。 詳細については、RFC 7946を参照してください。

名前 説明
geometry GeoJsonPoint:

PointGeometry

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

properties

InputWaypointProperties

参照または停止ポイントとして機能するルートまたは乗車に沿った特定の場所またはポイントであるウェイポイントのプロパティを指定します。

type

FeaturesItemTypeEnum

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

InputWaypointProperties

参照または停止ポイントとして機能するルートまたは乗車に沿った特定の場所またはポイントであるウェイポイントのプロパティを指定します。

名前 規定値 説明
pointIndex

integer (int64)

ルート内のウェイポイントのシーケンスを識別して順序付けます。 既定値は、特徴配列の index value です。

pointType

InputWaypointTypeEnum

waypoint

ルート上のウェイポイントの種類。 ルートを通過する必要がある停止または中間の場所を指定できます。

InputWaypointTypeEnum

ルート上のウェイポイントの種類。 ルートを通過する必要がある停止または中間の場所を指定できます。

説明
waypoint

ウェイポイントは、ルートまたは乗車に沿った特定の場所またはポイントで、参照または停止ポイントとして機能します。

viaWaypoint

viaWaypoint は、ルートまたは旅行に沿って通過または訪問する必要がある特定のウェイポイントです。

Instruction

一連の方向での操縦の説明。

名前 説明
drivingSide

DrivingSideEnum

操縦のポイントでの左手と右側の運転を示します。

formattedText

string

命令の書式設定されたテキストの説明。

maneuverType

ManeuverTypeEnum

この詳細なコレクションで説明されている操縦の種類。 マヌーバタイプは、対応する命令で指定された操縦の一部に関する情報を提供します。 たとえば、命令のマヌーバタイプは TurnLeftThenTurnRight を指定し、関連する詳細項目は TurnLeft と TurnRight の操縦に関する詳細を提供する場合があります。

text

string

命令のプレーン テキストの説明。

Leg

2 つのウェイポイント間のルートのセクションに関する情報。 ルート レッグに含まれるフィールドの詳細:

名前 説明
arrivalAt

string (date-time)

トラフィックの状態を考慮した区間の推定到着時間は、RFC 3339 セクション 5.6定義された dateTime 値として書式設定されます。 departAt または arrivalAtでタイムゾーンオフセットを参照します。 そうでない場合は、UTC 時刻が使用されます。

departureAt

string (date-time)

交通状況を考慮した区間の推定出発時間は、RFC 3339 セクション 5.6定義された dateTime 値として書式設定されます。 departAt または arrivalAtでタイムゾーンオフセットを参照します。 そうでない場合は、UTC 時刻が使用されます。

distanceInMeters

number

ルート レッグによってカバーされるメートル単位の物理的な距離。

durationInSeconds

integer (int64)

交通状況によるルートの遅延を含まない推定移動時間 (秒単位)。

durationTrafficInSeconds

integer (int64)

現在の交通状況に対応する TravelDistance を移動するのに要する時間 (秒単位)。 この値は、トラフィックに関する考慮事項 optimizeRoute 含まれている場合に提供されます。

routePathRange

RoutePathRange

ルートまたはパスの特定のレッグでカバーされる範囲を参照します。

ManeuverPointProperties

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

名前 規定値 説明
address

Address

ルート上のウェイポイントとマニューバポイントの行政区域と国地域。

distanceInMeters

number

このルート ステップでカバーされる物理的な距離 (メートル単位)。

durationInSeconds

integer (int64)

対応する TravelDistanceを移動するのにかかる時間 (秒単位)。

exitIdentifier

string

このルート ステップに関連付けられている出口の名前または番号。

instruction

Instruction

一連の方向での操縦の説明。

order

Order

ウェイポイントを訪問するためのシーケンス。

routePathPoint

RoutePathPoint

ルートの特定の区間内のポイントのインデックスを参照します。

sideOfStreet

SideOfStreetEnum

到着方向に基づいて目的地が見つかった通りの側。 このフィールドは、最後の操作ポイントにのみ適用されます。

signs

string[]

ルートのサイネージ テキスト。 複数の符号値が存在する場合があります。

steps

Step[]

2つの連続した操縦ポイント間のステップ。

towardsRoadName

string

ルートが最初の ManeuverPointで向かう通りの名前。

travelMode

RoutePathTravelModeEnum

driving

応答内のルート パスの移動モード。

type string:

ManeuverPoint

出力タイプ。

ManeuverTypeEnum

この詳細なコレクションで説明されている操縦の種類。 マヌーバタイプは、対応する命令で指定された操縦の一部に関する情報を提供します。 たとえば、命令のマヌーバタイプは TurnLeftThenTurnRight を指定し、関連する詳細項目は TurnLeft と TurnRight の操縦に関する詳細を提供する場合があります。

説明
ArriveFinish

最終目的地に到着します。

ArriveIntermediate

中間地点に到着します。

BearLeft

左にクマ。

BearLeftThenBearLeft

クマは左にし、その後、もう一度左に負担します。

BearLeftThenBearRight

左にくるし、右に負担します。

BearLeftThenTurnLeft

クマを左にして左に曲がります。

BearLeftThenTurnRight

左に曲がり、右に曲がります。

BearRight

右に耐えてください。

BearRightThenBearLeft

右に負け、次に左に負担します。

BearRightThenBearRight

右に負け、その後、再び右に耐える。

BearRightThenTurnLeft

右に置き、左に曲がります。

BearRightThenTurnRight

右に曲がり、右に曲がって下さい。

BearThenKeep

ベア命令とキープ命令

BearThenMerge

命令を実行してからマージ命令を実行します。

Continue

現在の道路を進みます。

DepartIntermediateStop

中間地点は、到着した方向と道路とは異なる方向に残します。

DepartIntermediateStopReturning

中間地点は、到着したのと同じ方向と同じ道路に残します。

DepartStart

開始点のままにします。

EnterRoundabout

ラウンドアバウトを入力します。

ExitRoundabout

ラウンドアバウト交差点を終了します。

EnterThenExitRoundabout

ラウンドアバウトを入力して終了します。

ExitRoundaboutRight

ラウンドアバウトで右側の出口を出る。

ExitRoundaboutLeft

ラウンドアバウトで左側の出口を出る。

Follow

Follow.

GoAroundRoundabout

ラウンドアバウトを回る。

KeepLeft

別の道路に左に保ちます。

KeepOnRampLeft

左にしてランプに進みます。

KeepOnRampRight

右に保ち、ランプに進みます。

KeepOnRampStraight

まっすぐにしてランプに進みます。

KeepRight

別の道路に直接進んでください。

KeepStraight

別の道路にまっすぐ進んでください。

KeepToStayLeft

同じ道路に滞在するために左に保ちます。

KeepToStayRight

同じ道を歩み続ける権利を保つ。

KeepToStayStraight

同じ道路に滞在するためにまっすぐに保ちます。

MergeFreeway

高速道路にマージします。

MergeHighway

高速道路にマージします。

MergeMotorway

高速道路にマージ。

MotorwayExitLeft

左出口を出る。

MotorwayExitRight

右出口に移動します。

None

指示はありません。

RampThenHighwayLeft

高速道路に左ランプを取ります. これは、結合された命令の一部です。

RampThenHighwayRight

高速道路に右ランプを取ります。 これは、結合された命令の一部です。

RampThenHighwayStraight

高速道路にランプを取るためにまっすぐに滞在します。 これは、結合された命令の一部です。

RoadNameChange

道路名が変更されます。

SwitchToParallelRoad

平行道路に切り替えます。

SwitchToMainRoad

主要道路に切り替えます。

Take

道を進みます。 この命令は、フェリーに出入りするときに使用されます。

TakeFerry

フェリーに乗ります。

TakeExit

出口に入ります。

TakeRamp

ランプを取ります。

TakeRampLeft

左にランプを取ります。

TakeRampRight

右にランプを取ります。

TakeRampStraight

ランプを取るためにまっすぐに滞在します。

TurnBack

急に戻ります。

TurnLeft

左折します。

TurnLeftSharp

鋭い左折を取ります。

TurnLeftThenBearLeft

左に曲がり、左に向きます。

TurnLeftThenBearRight

左に曲がり、右に向きます。

TurnLeftThenTurnLeft

左に曲がり、もう一度左に曲がります。

TurnLeftThenTurnRight

左に曲がり、右に曲がります。

TurnRight

右折。

TurnRightSharp

急激な右折を取ります。

TurnRightThenBearLeft

右に曲がり、左に向きます。

TurnRightThenBearRight

右に曲がり、右に向かいます。

TurnRightThenTurnLeft

右に曲がり、左に曲がります。

TurnRightThenTurnRight

右に曲がり、もう一度右に曲がります

TurnThenMerge

ターン命令の後にマージ命令が続きます。

TurnToStayLeft

左に曲がって同じ道路を走り続ける。

TurnToStayRight

右に曲がって同じ道路を走り続ける。

Unknown

命令は不明です。

UTurn

U ターンを行って反対方向に進みます。

Wait

待機

Walk

Walk

MapsErrorDetail

エラーの詳細。

名前 説明
code

string

サーバー定義の一連のエラー コードの 1 つ。

details

MapsErrorDetail[]

この報告されたエラーの原因となった特定のエラーに関する詳細の配列。

innererror

MapsInnerError

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

message

string

エラーの人間が判読できる表現。

target

string

エラーのターゲット。

MapsErrorResponse

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

名前 説明
error

MapsErrorDetail

エラーの詳細。

MapsInnerError

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

名前 説明
code

string

エラー コード。

innererror

MapsInnerError

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

MultiLineStringGeometry

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

名前 説明
coordinates

number[] (double)

GeoJson MultiLineString ジオメトリの座標。

type string:

MultiLineString

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

OptimizedWaypoint

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

名前 説明
inputIndex

integer (int64)

ユーザーによって提供されるウェイ ポイント インデックス。

optimizedIndex

integer (int64)

システムからの最適化されたウェイ ポイント インデックス。

Order

ウェイポイントを訪問するためのシーケンス。

名前 説明
inputIndex

integer (int64)

ウェイポイントのユーザー提供のインデックス

optimizedIndex

integer (int64)

システム最適化されたウェイポイント

PointGeometry

有効な GeoJSON Geometry オブジェクトとして渡される原点。このオブジェクトから範囲ポリゴンを計算する必要があります。 詳細については、RFC 7946 を参照してください。

Note: API は、要求された起点を最も近い道路ネットワークにスナップし、範囲の計算に使用します。 応答の center ポイントとして返されます。

名前 説明
coordinates

number[] (double)

Position は、2 つ以上の要素を持つ数値の配列です。 最初の 2 つの要素は、経度 、緯度正確にその順序で示されます。 高度/標高 は、オプションの 3 番目の要素です。 詳細については、RFC 7946 を参照してください。

type string:

Point

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

RouteDirectionOptimizeRouteEnum

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

例: "optimizeRoute":"shortest"

説明
short

ルートは、1 つだけを優先するのではなく、移動時間が短い時間と短い距離のバランスをとるように計算されています。 速度と効率の両方に最適化されています。 トラフィック情報は使用されません。

shortest

ルートは、距離を最小限に抑えるために計算されます。 トラフィック情報は使用されません。

fastestWithoutTraffic

トラフィック情報を考慮せずに、最速のルートを検索します。

fastestWithTraffic

ルートは、現在のトラフィック情報を使用して時間を最小限に抑えるために計算されます。 Note: 運転とトラックの travelMode でのみサポートされます。

RouteDirectionsResponse

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

名前 説明
alternativeRoutes

FeatureCollection[]

代替ルート。

features

FeaturesItem[]

Geometry オブジェクトと追加のプロパティを含むフィーチャー オブジェクトを GeoJSON します。 詳細については、RFC 7946、セクション 3.2を参照してください。

type

FeatureTypeEnum

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

RouteDirectionVehicleSpec

トラックのルーティング専用に、サイズ、重量、最大速度、貨物の種類などの車両属性を指定します。 これは、車両仕様に基づいて最適化されたトラックルートを提供するために、低い橋のクリアランス、道路の制限、困難な右折を回避するのに役立ちます。

ISNote: トラック travelMode でのみサポートされます。

名前 規定値 説明
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 の場合、幅の制限は考慮されません。

RouteOutputOptionEnum

応答から必要なルート情報を含めます。 既定では、応答には旅程が含まれます。

"routeOutputOptions": ["routePath", "itinerary"] のような複数の値をサポートします。

説明
routeSummary

ルートの移動時間と距離のみを含め、他の情報は提供しません。

routePath

応答にルートのパスを記述する geoJSON MultiLineString RFC 7946 セクション 3.1.5 を含めます。

itinerary

応答に詳細な指示を含めます。 詳細なルート案内は "ManeuverPoints" として提供され、ターンバイターン命令などの詳細が含まれています。

RoutePathPoint

ルートの特定の区間内のポイントのインデックスを参照します。

名前 説明
legIndex

integer (int64)

ルートの Leg インデックスは、ルートの異なるセグメントを識別して区別するために、ルートの各 Leg に割り当てられたシーケンシャル番号です。

pointIndex

integer (int64)

特定の Leg 内のポイントのインデックス。

RoutePathProperties

応答内のルートのパスを記述するプロパティを指定します。

名前 説明
arrivalAt

string (date-time)

トラフィックの状態を考慮したレッグの推定到着時間は、RFC 3339 セクション 5.6定義された 値として書式設定されます。 departAt または arrivalAtでタイムゾーンオフセットを参照します。 そうでない場合は、UTC 時刻が使用されます。

departureAt

string (date-time)

交通状況を考慮した区間の推定出発時間は、RFC 3339 セクション 5.6定義された 値として書式設定されます。 departAt または arrivalAtでタイムゾーンオフセットを参照します。 そうでない場合は、UTC 時刻が使用されます。

distanceInMeters

number

ルート全体でカバーされるメートル単位の物理的な距離。

durationInSeconds

integer (int64)

交通状況によるルートの遅延を含まない推定移動時間 (秒単位)。

durationTrafficInSeconds

integer (int64)

現在の交通状況に対応する TravelDistance を移動するのに要する時間 (秒単位)。 この値は、トラフィックに関する考慮事項 optimizeRoute 含まれている場合に提供されます。

legs

Leg[]

ルートレッグの配列。 詳細については、ルート Leg オブジェクトの説明を確認してください。

optimizedWaypoints

OptimizedWaypoint[]

ウェイポイントの最適化されたシーケンス。 元のリストと最適化されたリストに対してユーザーが指定したウェイポイント シーケンスからのインデックスが表示されます。

trafficCongestion

TrafficCongestionEnum

ルートに沿った交通渋滞のレベル。 Note: travelMode の運転でのみサポートされます

type string:

RoutePath

出力タイプ。

RoutePathRange

ルートまたはパスの特定のレッグでカバーされる範囲を参照します。

名前 説明
legIndex

integer (int64)

ルートの Leg インデックスは、ルートの異なるセグメントを識別して区別するために、ルートの各 Leg に割り当てられたシーケンシャル番号です。

range

integer[] (int64)

ルートまたはパスの特定のレッグでカバーされる範囲を参照します。

RoutePathTravelModeEnum

応答内のルート パスの移動モード。

説明
driving

車用に最適化されたルート。

truck

車両仕様に基づいて大型トラック用に最適化されたルート。

walking

歩行者向けに最適化されたルート。

other

ルートの特定のセクションでトラック ルートが使用できない場合、RouteTravelMode はトラック travelMode の "other" として返されます。

SideOfStreetEnum

到着方向に基づいて目的地が見つかった通りの側。 このフィールドは、最後の操作ポイントにのみ適用されます。

説明
Left

左。

Right

その通りです

Unknown

不明。

Step

ルートレッグにはターンバイターン命令が含まれています。 ステップとは、2 つの連続する移動ポイント間のルートの範囲を指します。

名前 説明
maneuverType

ManeuverTypeEnum

この詳細なコレクションで説明されている操縦の種類。 マヌーバタイプは、対応する命令で指定された操縦の一部に関する情報を提供します。 たとえば、命令のマヌーバタイプは TurnLeftThenTurnRight を指定し、関連する詳細項目は TurnLeft と TurnRight の操縦に関する詳細を提供する場合があります。

names

string[]

操縦が行われる通り、高速道路、または交差点。 操作が複雑な場合は、詳細コレクションに複数の名前フィールドが存在する可能性があります。 name フィールドには値がない場合もあります。 これは、名前が不明な場合、または道路、高速道路、交差点に名前がない場合に発生する可能性があります。

routePathRange

RoutePathRange

ルートまたはパスの特定のレッグでカバーされる範囲を参照します。

TrafficCongestionEnum

ルートに沿った交通渋滞のレベル。 Note: travelMode の運転でのみサポートされます

説明
Unknown

不明。

None

なし。

Mild

Mild.

Medium

ミディアム

Heavy

Heavy.

TravelModeEnum

要求されたルートの移動モード。 定義されていない場合、既定値は車用に最適化されたルートを返す "driving" です。

Note: トラック travelMode の場合、要求されたトラック ルートがルート全体で使用できない場合があります。 トラック ルートが特定のセクションで使用できない場合、そのセクションの応答の travelMode 要素は "other" になります。

例: "travelMode":"driving"

説明
driving

返されるルートは、自動車用に最適化されています。

truck

返されるルートは、車両仕様に基づいて大型トラック用に最適化されています。

walking

返されるルートは、歩道の使用を含め、歩行者向けに最適化されています。

VehicleLoadTypeEnum

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

説明
USHazmatClass1

爆発物

USHazmatClass2

圧縮ガス

USHazmatClass3

引火性液体

USHazmatClass4

可燃性固体

USHazmatClass5

酸化 剤

USHazmatClass6

USHazmatClass7

放射性

USHazmatClass8

腐食性物質

USHazmatClass9

Miscellaneous

otherHazmatExplosive

爆発物

otherHazmatGeneral

Miscellaneous

otherHazmatHarmfulToWater

水に有害

WaypointProperties

参照または停止ポイントとして機能するルートまたは乗車に沿った特定の場所またはポイントであるウェイポイントのプロパティを指定します。

名前 規定値 説明
address

Address

ルート上のウェイポイントとマニューバポイントの行政区域と国地域。

distanceInMeters

number

このルート ステップでカバーされる物理的な距離 (メートル単位)。

durationInSeconds

integer (int64)

対応する TravelDistanceを移動するのにかかる時間 (秒単位)。

exitIdentifier

string

このルート ステップに関連付けられている出口の名前または番号。

instruction

Instruction

一連の方向での操縦の説明。

order

Order

ウェイポイントを訪問するためのシーケンス。

routePathPoint

RoutePathPoint

ルートの特定の区間内のポイントのインデックスを参照します。

sideOfStreet

SideOfStreetEnum

到着方向に基づいて目的地が見つかった通りの側。 このフィールドは、最後の操作ポイントにのみ適用されます。

signs

string[]

ルートのサイネージ テキスト。 複数の符号値が存在する場合があります。

steps

Step[]

2つの連続した操縦ポイント間のステップ。

towardsRoadName

string

ルートが最初の ManeuverPointで向かう通りの名前。

travelMode

RoutePathTravelModeEnum

driving

応答内のルート パスの移動モード。

type string:

Waypoint

出力タイプ。