Route - Post Route Directions Batch

參考

服務:: Maps

API 版本:: 2025-01-01

使用將查詢批次傳送至單一同步要求中的路由指示 API。

Route Directions Batch API 是 HTTP POST 要求，它會在單一呼叫 路由方向 API 時，傳送最多 100 個查詢的批次。

提交同步批次要求

針對輕量型批次要求，建議使用同步 API。當服務收到要求時，它會在計算批次專案后立即回應，且稍後將不可能擷取結果。如果要求超過 60 秒，同步 API 會傳回逾時錯誤（408 回應）。批次項目的數目限制為此 API 100。

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

批次要求的 POST 本文

若要傳送方向查詢，您將使用 POST 要求，其中要求本文會以 batchItems 格式包含 json 陣列，並將 Content-Type 標頭設定為 application/json。以下是包含 2 個方向查詢的範例要求本文：

{
  "batchItems": [
    {
      "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithoutTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "optionalId": "a191de3c-1268-4986-98f0-03f0a5d9302a",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "shortest",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 2,
      "travelMode": "driving"
    }
  ]
}

batchItem 物件指示可以接受任何支援的指示，要求本文

批次至少應包含 1 查詢。

批次回應模型

批次回應包含 summary 元件，指出屬於原始批次要求一部分的 totalRequests，以及成功執行的查詢 successfulRequests。批次回應也包含 batchItems 數位列，其中包含批次要求中每個查詢的回應。 batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。每個專案都是下列其中一種類型：

DirectionsResponse - 如果查詢成功完成。
Error - 如果查詢失敗。在此案例中，回應會包含 code 和 message。

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

URI 參數

名稱	位於	必要	類型	Description
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定要與 Microsoft Entra ID 安全性模型搭配使用的帳戶。它代表 Azure 地圖服務帳戶的唯一標識碼，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。
Accept-Language		string	應該傳迴路由結果的語言。如需詳細資訊，請參閱 Azure 地圖服務中的當地語系化支援。

名稱

必要

類型

Description

x-ms-client-id

string

指定要與 Microsoft Entra ID 安全性模型搭配使用的帳戶。它代表 Azure 地圖服務帳戶的唯一標識碼，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

Accept-Language

string

應該傳迴路由結果的語言。

如需詳細資訊，請參閱 Azure 地圖服務中的當地語系化支援。

要求本文

名稱	類型	Description
batchItems	DirectionsBatchRequestItem[]	要處理的查詢清單。

回應

名稱	類型	Description
200 OK	DirectionsBatchResponse	批次要求已成功處理。回應本文包含所有批次結果。
Other Status Codes	MapsErrorResponse	發生未預期的錯誤。標題 x-ms-error-code: string

名稱

類型

Description

200 OK

DirectionsBatchResponse

批次要求已成功處理。回應本文包含所有批次結果。

Other Status Codes

MapsErrorResponse

發生未預期的錯誤。

標題

x-ms-error-code: string

安全性

AADToken

這些是 Entra OAuth 2.0 流程 Microsoft。與 Azure 角色型存取配對時，控制它可用來控制 Azure 地圖服務 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個 Azure 地圖服務 REST API 許可權所組成的自定義角色來授與存取權。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供模型化應用程式的解決方案。

備註

此安全性定義需要使用 x-ms-client-id 標頭來指出應用程式要求存取的 Azure 地圖服務資源。這可以從地圖管理 API取得。
Authorization URL 專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL，Microsoft Entra ID 設定。
Azure 角色型訪問控制是從 azure 管理平面設定，透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API。
Azure 地圖服務 Web SDK 的使用，可讓您針對多個使用案例設定應用程式。
如需Microsoft身分識別平臺的詳細資訊，請參閱 Microsoft 身分識別平臺概觀。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，透過 Azure 管理平面建立 Azure 地圖服務資源時所佈建的共用密鑰。

使用此金鑰時，任何應用程式都會獲得存取所有 REST API 的授權。換句話說，這些目前可視為發行帳戶的主要密鑰。

對於公開的應用程式，我們建議使用可安全地儲存此密鑰的 Azure 地圖服務 REST API 伺服器對伺服器存取。

類型: apiKey
位於: header

SAS Token

這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 azure 地圖服務資源列表 SAS 作業建立共用存取簽章令牌。

使用此令牌時，任何應用程式都有權使用 Azure 角色型訪問控制進行存取，並更精細地控制特定令牌的到期、速率和區域。換句話說，SAS 令牌可用來讓應用程式以比共用密鑰更安全的方式控制存取。

對於公開的應用程式，我們建議在對應帳戶資源上設定允許的來源特定清單，以限制轉譯濫用，並定期更新 SAS 令牌。

類型: apiKey
位於: header

範例

A Route Directions Batch request containing 2 queries

範例要求

HTTP

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

{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    }
  ]
}

範例回覆

狀態碼:: 200

{
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 2
  },
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
            "distanceInMeters": 1432.9,
            "durationInSeconds": 524,
            "durationTrafficInSeconds": 554
          }
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "resourceId": "v70,h1207959581,i0,a0,cen-US,dAMA8xD0s2wg1,y1,s1,m1,o1,t0,wWrdB7bfOR0C9UpYhjpVewA2~AJEAEzSxZiQBAADgAYsYlD4B0~N3RoIEF2ZQ2~~~~~~~~v12,w393KEp3NR0ASFhVxOpRewA2~AJEAEzQ5viQBAADgAaehWT4B0~RSBKZWZmZXJzb24gU3Q1~~~~~~~~v12,k0,n2",
            "distanceInMeters": 1432.9,
            "durationInSeconds": 524,
            "durationTrafficInSeconds": 554
          }
        }
      ],
      "optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
    }
  ]
}

定義

名稱	Description
Address	卡車路線上的路點和機動點的行政區和國家/地區。注意：僅支持貨車 travelMode。
AdminDistrict	地址的國家或地區中的細分名稱。此元素通常被視為第一個命令系統管理細分，但在某些情況下，它也會包含國家/地區、相依性或區域的第二、第三或第四個順序細分。
AdminDistrictTruck	地址的國家或地區中的細分名稱。此元素通常被視為第一個命令系統管理細分，但在某些情況下，它也會包含國家/地區、相依性或區域的第二、第三或第四個順序細分。
AdrTunnelRestrictionCodeEnum	ADR 通道限制程式代碼。 ADR是一項歐洲關於公路危險品國際運輸的協定。 ADR 隧道限制代碼可用來判斷車輛是否允許通過具有危險貨物運輸限制的隧道。
AvoidEnum	指定決定路由時，路由計算應接受的限制。避免在要求中支援多個值，且僅支持駕駛和貨車 TravelMode。範例：“avoid”： [“limitedAccessHighways”， “tollRoads”]
CountryRegion	表示包含相關詳細數據的國家或地區。
DirectionsBatchRequestBody	要處理之查詢/要求的方向清單。此清單最多可以包含100個查詢，且至少必須包含1個查詢。
DirectionsBatchRequestItem	Batch Query 物件
DirectionsBatchResponse	此物件會從成功的 Directions Batch 服務呼叫傳回。
DirectionsBatchResponseItem	批次回應專案
DrivingSideEnum	表示在機動點的左側與右側駕駛。 `Note`：僅支援卡車 travelMode。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
FeatureCollection	`GeoJSON` `FeatureCollection` 物件，其中包含功能清單。如需詳細資訊，請參閱 RFC 7946，第 3.3 節。
FeaturesItem	GeoJSON 功能物件，其中包含 Geometry 物件和路由的其他屬性。
FeaturesItemTypeEnum	指定 `GeoJSON` 類型。唯一支援的物件類型是Feature。如需詳細資訊，請參閱 RFC 7946。
FeatureTypeEnum	指定 `GeoJSON` 類型。唯一支援的物件類型是 `FeatureCollection`。如需詳細資訊，請參閱 RFC 7946。
GeoJsonPoint	有效的 `GeoJSON Point` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
Hint	在路由之後可能會有説明的其他資訊。除了提示文字之外，此元素還有屬性 hintType，指定提示所參考的內容，例如 “NextIntersection”。提示是選擇性專案。 `Note`：僅支持駕駛 TravelMode。
InputWaypointFeaturesItem	指定輸入 waypoint 和 viaWaypoint `GeoJSON` 功能物件和其他屬性。如需詳細資訊，請參閱 RFC 7946。
InputWaypointProperties	指定航點的屬性，這是作為參考或停止點之路線或車程的特定位置或點。
InputWaypointTypeEnum	路由上的 Waypoint 類型。它可以是路線必須通過的停止或中繼位置。
Instruction	一組方向的機動描述。
Leg	關於兩個路點之間路由區段的資訊。路由腿中包含的欄位詳細資訊：
ManeuverPointProperties	指定路線回合中每個機動點的駕駛指示和其他屬性。
ManeuverTypeEnum	這個詳細集合中所述的動作類型。 ManeuverType 會提供對應指令所指定動作部分的資訊。例如，指令的 maneuverType 可能會指定 TurnLeftThenTurnRight，而相關聯的詳細數據專案可能會提供 TurnLeft 和 TurnRight 動作的特定資訊
MapsErrorDetail	錯誤詳細數據。
MapsErrorResponse	Azure 地圖服務 API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。
MapsInnerError	物件，包含與目前對象有關錯誤更具體的資訊。
MultiLineStringGeometry	指定 `GeoJSON` MultiLineString Geometry 物件。如需詳細資訊，請參閱 RFC 7946。
OptimizedWaypoint	優化的方式點物件。
Order	瀏覽導航點和 viaWaypoints 的順序。
PointGeometry	傳遞為有效 `GeoJSON` Geometry 物件的源點，應該從中計算範圍多邊形。如需詳細資訊，請參閱 RFC 7946。 `Note`：API 會將要求的來源點貼齊至最近的道路網路，並將用於範圍計算。它會在回應中以 `center` 點的形式傳回。
RegionTravelSummary	以兩種實體類型區分的距離、時間和收費公路距離的旅行摘要：國家/地區（例如美國、加拿大）和行政部門或次區域（例如美國“州”和加拿大的“省”。
RoadTypeEnum	道路的類型。 `Note`：僅支持駕駛 TravelMode。
RouteDirectionOptimizeRouteEnum	指定要用來優化路由的參數。如果未定義，預設值為「fastestWithoutTraffic」，它會傳迴路由，以將旅行時間降到最低，而不使用目前的流量資訊。範例：“optimizeRoute”：“shortest”
RouteDirectionVehicleSpec	僅指定貨車路線的車輛屬性，例如大小、重量、最大速度、貨物類型等。這有助於避免低橋通路、道路限制、難右轉，根據車輛規格提供優化的卡車路線。 IS`Note`：僅支援卡車 travelMode。
RouteOutputOptionEnum	包含回應中所需的路由資訊。根據預設，行程會包含在回應中。支援多個值，例如 “routeOutputOptions”： [“routePath”， “regionTravelSummary”]
RoutePathPoint	是指路線特定腿內某個點的索引。
RoutePathProperties	指定描述回應中路由路徑的屬性。
RoutePathRange	是指路線或路徑的特定腿所涵蓋的範圍。
RoutePathTravelModeEnum	回應中路線路徑的移動模式。
SideOfStreetEnum	根據到達方向找到目的地的街道側。此欄位僅適用於最後一個操作Point。
Step	路線回合包含回合指示。步驟是指兩個連續動作Point 之間的路由範圍。
SubLeg	由路線腿路點和任何中繼通路點所定義之路線腿段的相關信息。例如，如果路線腿除了起點和終點外還有兩個通路點，則有三個（3）個路線子腿。
Summary	批次要求的摘要
TrafficCongestionEnum	路線沿線交通擁堵程度。 `Note`：僅支持駕駛 TravelMode
TrafficDataUsedEnum	用來產生路由的即時流量數據類型。
TravelModeEnum	所要求路線的移動模式。如果未定義，則預設值為「駕駛」，會傳回針對汽車優化的路線。 `Note`：對於卡車 travelMode，要求的貨車路線可能無法用於整個路線。當貨車路線不適用於特定區段時，該區段回應的 travelMode 元素將會是「其他」。範例：“travelMode”：“driving”
VehicleLoadTypeEnum	可能分類為危險物質的貨物類型，並受限於某些道路。可用的 vehicleLoadType 值是 US Hazmat 類別 1 到 9，加上用於其他國家/地區的泛型分類。以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 支援要求中的多個值。
ViaWaypointProperties	指定 `ViaWaypoint` 的屬性，這是必須沿著路線或行程經過或流覽的路點。
WaypointProperties	指定航點的屬性，這是作為參考或停止點之路線或車程的特定位置或點。

Address

Object

卡車路線上的路點和機動點的行政區和國家/地區。注意：僅支持貨車 travelMode。

名稱	類型	Description
adminDistricts	AdminDistrictTruck[]	地址的國家或地區中的細分名稱。此元素通常被視為第一個命令系統管理細分，但在某些情況下，它也會包含國家/地區、相依性或區域的第二、第三或第四個順序細分。
countryRegion	CountryRegion	表示包含相關詳細數據的國家或地區。

AdminDistrict

Object

地址的國家或地區中的細分名稱。此元素通常被視為第一個命令系統管理細分，但在某些情況下，它也會包含國家/地區、相依性或區域的第二、第三或第四個順序細分。

名稱	類型	Description
distanceInMeters	number	行政區域內以公尺為單位移動的總距離。
durationInSeconds	integer (int64)	預估的行進時間，以秒為單位，不包含因交通狀況而造成路線延誤。
durationTrafficInSeconds	integer (int64)	使用目前交通狀況的對應 `TravelDistance` 所花費的時間，以秒為單位。如果 `optimizeRoute` 包含流量考慮，則會提供此值。
longName	string	地址的長名稱，例如華盛頓。
tollDistanceInMeters	number	沿著包含收費公路的路線，以公尺為單位的總距離。

AdminDistrictTruck

Object

名稱	類型	Description
shortName	string	對應 adminDistrict 字段的簡短名稱，針對 adminDistrict[0]，這可能是 WA 等狀態的簡短名稱。這僅適用於美國、加拿大和墨西哥。

AdrTunnelRestrictionCodeEnum

列舉型別

ADR 通道限制程式代碼。 ADR是一項歐洲關於公路危險品國際運輸的協定。 ADR 隧道限制代碼可用來判斷車輛是否允許通過具有危險貨物運輸限制的隧道。

值	Description
B	具有代碼 B 的車輛受限於 ADR 隧道類別 B、C、D 和 E 的道路。
C	具有 C 代碼的車輛受限於 ADR 隧道類別 C、D 和 E 的道路
D	編碼為 D 的車輛受限於 ADR 隧道類別 D 和 E 的道路。
E	具有代碼 E 的車輛受限於 ADR 隧道類別 E 的道路。

AvoidEnum

列舉型別

指定決定路由時，路由計算應接受的限制。避免在要求中支援多個值，且僅支持駕駛和貨車 TravelMode。

範例：“avoid”： [“limitedAccessHighways”， “tollRoads”]

值	Description
borderCrossings	避免在路線中越過國家/地區邊界。
ferries	避免在路線中使用渡輪。
limitedAccessHighways	避免在路線中使用有限的交通高速公路。
lowEmissionZones	避免路由中的低排放區域。 `Note`：僅支援卡車 travelMode。
tollRoads	避免在路線中使用收費公路。
tunnels	避免在路由中使用通道。 `Note`：僅支援卡車 travelMode。
unpavedRoads	避免路線中未修補的道路。 `Note`：僅支援卡車 travelMode。

CountryRegion

Object

表示包含相關詳細數據的國家或地區。

名稱	類型	Description
ISO	string	國家/地區的 ISO 代表 ISO 3166-1 Alpha-2 區域/國家/國家/地區代碼
name	string	國家/地區名稱

DirectionsBatchRequestBody

Object

要處理之查詢/要求的方向清單。此清單最多可以包含100個查詢，且至少必須包含1個查詢。

名稱	類型	Description
batchItems	DirectionsBatchRequestItem[]	要處理的查詢清單。

DirectionsBatchRequestItem

Object

Batch Query 物件

名稱	類型	預設值	Description
arriveAt	string (date-time)		抵達目的地點的日期和時間，格式為 `dateTime`所定義的值。如果未指定時區位移，則會假設 UTC。 `arriveAt` 參數不能與 `departAt`搭配使用。範例：“arriveAt”： “2023-06-01T09：30：00.000-07：00”
avoid	AvoidEnum[]		指定決定路由時，路由計算應接受的限制。避免在要求中支援多個值，且僅支持駕駛和貨車 TravelMode。範例：“avoid”： [“limitedAccessHighways”， “tollRoads”]
departAt	string (date-time)		從源點出發的日期和時間，格式為 `dateTime`所定義的值。如果未指定時區位移，則會假設 UTC。如果未設定 `departAt`，則預設值為目前時間。範例： “departAt”： “2023-06-01T09：30：00.000-07：00”
features	InputWaypointFeaturesItem[]		駕駛和步行路線是由一組路點（停車）和 viaWaypoints 所定義（路線必須通過的中繼位置）。您最多可以有 25 個路點，而且每個路點集之間最多可以有 10 個 viaWaypoint。不支援卡車路線最多可支援 150 個路點和 viaWaypoints。路線必須至少有 2 個路點，而且路線的起點和終點不能透過Waypoints。 waypoint 和 viaWaypoint 位置都必須指定為有效的 GeoJSON Point 功能物件，以及指定位置順序的 pointIndex。如需 GeoJSON 格式的詳細資訊，請參閱 RFC 7946。
heading	integer (int64) minimum: 0 maximum: 359		車輛的初始方向方向方向從真正的北方開始，並繼續順時針方向。北方是0度，東是90度，南是180度，西部是270度。可能的值 0-359
maxRouteCount	integer (int64) minimum: 1 maximum: 3		要傳回的路由數目上限。適用於駕駛和卡車出行模式。對於駕駛路線，此參數除了來源和目的地之外，還支援具有最多兩個路點的路線，而且不得設定參數。默認值：「maxRouteCount」：1 最小值：「maxRouteCount」：1 最大值：「maxRouteCount」：3
optimizeRoute	RouteDirectionOptimizeRouteEnum	fastestWithoutTraffic	指定要用來優化路由的參數。如果未定義，預設值為「fastestWithoutTraffic」，它會傳迴路由，以將旅行時間降到最低，而不使用目前的流量資訊。範例：“optimizeRoute”：“shortest”
optimizeWaypointOrder	boolean	False	使用快速啟發學習演算法重新排序路由路徑點，以減少使用optimize參數指定的路由成本。來源和目的地會從優化的方式點中排除，且其位置會視為固定。可接受的值為 true 或 false。 `Note`：僅支援卡車 travelMode。
optionalId	string		在對應的 batchItem 中顯示的要求標識碼。
routeOutputOptions	RouteOutputOptionEnum[]	[ "itinerary" ]	包含回應中所需的路由資訊。根據預設，行程會包含在回應中。支援多個值，例如 “routeOutputOptions”： [“routePath”， “regionTravelSummary”]
travelMode	TravelModeEnum	driving	所要求路線的移動模式。如果未定義，則預設值為「駕駛」，會傳回針對汽車優化的路線。 `Note`：對於卡車 travelMode，要求的貨車路線可能無法用於整個路線。當貨車路線不適用於特定區段時，該區段回應的 travelMode 元素將會是「其他」。範例：“travelMode”：“driving”
type	FeatureTypeEnum		指定 `GeoJSON` 類型。唯一支援的物件類型是 `FeatureCollection`。如需詳細資訊，請參閱 RFC 7946。
vehicleSpec	RouteDirectionVehicleSpec		僅指定貨車路線的車輛屬性，例如大小、重量、最大速度、貨物類型等。這有助於避免低橋通路、道路限制、難右轉，根據車輛規格提供優化的卡車路線。 `Note`：僅支援卡車旅行模式

DirectionsBatchResponse

Object

此物件會從成功的 Directions Batch 服務呼叫傳回。

名稱	類型	Description
batchItems	DirectionsBatchResponseItem[]	包含批次結果的陣列。
summary	Summary	批次要求的摘要

DirectionsBatchResponseItem

Object

批次回應專案

名稱	類型	Description
alternativeRoutes	FeatureCollection[]	替代路由。
error	ErrorDetail	錯誤詳細數據。
features	FeaturesItem[]	`GeoJSON` 包含 Geometry 物件和其他屬性的功能物件。如需詳細資訊，請參閱 RFC 7946 第 3.2 節。
optionalId	string	在對應的 batchItem 中顯示的要求標識碼。
type	FeatureTypeEnum	指定 `GeoJSON` 類型。唯一支援的物件類型是 `FeatureCollection`。如需詳細資訊，請參閱 RFC 7946。

DrivingSideEnum

列舉型別

表示在機動點的左側與右側駕駛。 Note：僅支援卡車 travelMode。

值	Description
Left	左側駕駛。
Right	右側駕駛。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

FeatureCollection

Object

GeoJSON FeatureCollection 物件，其中包含功能清單。如需詳細資訊，請參閱 RFC 7946，第 3.3 節。

名稱	類型	Description
features	FeaturesItem[]	`GeoJSON` 包含 Geometry 物件和其他屬性的功能物件。如需詳細資訊，請參閱 RFC 7946 第 3.2 節。
type	FeatureTypeEnum	指定 `GeoJSON` 類型。唯一支援的物件類型是 `FeatureCollection`。如需詳細資訊，請參閱 RFC 7946。

FeaturesItem

Object

GeoJSON 功能物件，其中包含 Geometry 物件和路由的其他屬性。

名稱	類型	Description
bbox	number[] (double)	地球上的矩形區域，定義為周框方塊物件。矩形的兩側是由緯度和經度值所定義。如需詳細資訊，請參閱 RFC 7946 第 5 節。範例：“bbox”： [-10.0， -10.0， 10.0， 10.0]
geometry	RouteDirectionsGeometry: MultiLineStringGeometry PointGeometry	有效的 `GeoJSON` Geometry 物件。如需詳細資訊，請參閱 RFC 7946。
properties	FeatureProperties: ManeuverPointProperties RoutePathProperties ViaWaypointProperties WaypointProperties	指定路線的功能屬性，例如路線、路線腿和幾何、旅行摘要。
type	FeaturesItemTypeEnum	指定 `GeoJSON` 類型。唯一支援的物件類型是Feature。如需詳細資訊，請參閱 RFC 7946。

FeaturesItemTypeEnum

列舉型別

指定 GeoJSON 類型。唯一支援的物件類型是Feature。如需詳細資訊，請參閱 RFC 7946。

值	Description
Feature	指定feature物件類型 `GeoJSON`。

FeatureTypeEnum

列舉型別

指定 GeoJSON 類型。唯一支援的物件類型是 FeatureCollection。如需詳細資訊，請參閱 RFC 7946。

值	Description
FeatureCollection	指定 `GeoJSONFeatureCollection` 物件類型。

GeoJsonPoint

Object

有效的 GeoJSON Point 幾何類型。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`Position` 是具有兩個或多個元素的數字數位數位數位。前兩個元素是經度和緯度，確切地依該順序排列。高度/高度是選擇性的第三個專案。如需詳細資訊，請參閱 RFC 7946。
type	string: Point	指定 `GeoJSON` 類型。必須是九個有效的 GeoJSON 物件類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature 和 FeatureCollection。

Hint

Object

在路由之後可能會有説明的其他資訊。除了提示文字之外，此元素還有屬性 hintType，指定提示所參考的內容，例如 “NextIntersection”。提示是選擇性專案。 Note：僅支持駕駛 TravelMode。

名稱	類型	Description
hintType	string	提示類型。
text	string	提示文字。

InputWaypointFeaturesItem

Object

指定輸入 waypoint 和 viaWaypoint GeoJSON 功能物件和其他屬性。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
geometry	GeoJsonPoint: PointGeometry	有效的 `GeoJSON Point` 幾何類型。如需詳細資訊，請參閱 RFC 7946。
properties	InputWaypointProperties	指定航點的屬性，這是作為參考或停止點之路線或車程的特定位置或點。
type	FeaturesItemTypeEnum	指定 `GeoJSON` 類型。唯一支援的物件類型是Feature。如需詳細資訊，請參閱 RFC 7946。

InputWaypointProperties

Object

指定航點的屬性，這是作為參考或停止點之路線或車程的特定位置或點。

名稱	類型	預設值	Description
pointIndex	integer (int64)		識別及排序路由中的路點序列。預設值是特徵陣列的 `index value`。
pointType	InputWaypointTypeEnum	waypoint	路由上的 Waypoint 類型。它可以是路線必須通過的停止或中繼位置。

InputWaypointTypeEnum

列舉型別

路由上的 Waypoint 類型。它可以是路線必須通過的停止或中繼位置。

值	Description
viaWaypoint	viaWaypoint 是必須沿著路線或行程經過或流覽的特定航點。 `Note`：僅支持駕駛 TravelMode。
waypoint	導航點是路線或車程的特定位置或點，可作為參考或停止點。

Instruction

Object

一組方向的機動描述。

名稱	類型	Description
drivingSide	DrivingSideEnum	表示在機動點的左側與右側駕駛。 `Note`：僅支援卡車 travelMode。
formattedText	string	指令的格式化文字描述。
hints	Hint[]	在路由之後可能會有説明的其他資訊。除了提示文字之外，此元素還有屬性 hintType，指定提示所參考的內容，例如 “NextIntersection”。提示是選擇性元素，路由步驟可以包含一個以上的提示。 `Note`：僅支持駕駛 TravelMode
maneuverType	ManeuverTypeEnum	這個詳細集合中所述的動作類型。 ManeuverType 會提供對應指令所指定動作部分的資訊。例如，指令的 maneuverType 可能會指定 TurnLeftThenTurnRight，而相關聯的詳細數據專案可能會提供 TurnLeft 和 TurnRight 動作的特定資訊
text	string	指令的純文本描述。

Leg

Object

關於兩個路點之間路由區段的資訊。路由腿中包含的欄位詳細資訊：

名稱	類型	Description
arrivalAt	string (date-time)	考慮到交通狀況的腿估計抵達時間會格式化為 RFC 3339 第 5.6 節所定義的 dateTime 值。它會參考 `departAt` 或 `arrivalAt`的時區位移。如果沒有，則會使用UTC時間。
departureAt	string (date-time)	考慮到交通狀況的腿估計出發時間，會格式化為由 RFC 3339 第 5.6 節所定義的 dateTime 值。它會參考 `departAt` 或 `arrivalAt`的時區位移。如果沒有，則會使用UTC時間。
description	string	路由的簡短描述。
distanceInMeters	number	路線腿所覆蓋的公尺物理距離。
durationInSeconds	integer (int64)	預估的行進時間，以秒為單位，不包含因交通狀況而造成路線延誤。
durationTrafficInSeconds	integer (int64)	使用目前交通狀況的對應 `TravelDistance` 所花費的時間，以秒為單位。如果 `optimizeRoute` 包含流量考慮，則會提供此值。
regionTravelSummary	RegionTravelSummary	包括兩種實體類型的距離、時間和收費公路距離的旅行摘要：國家/地區（例如美國、加拿大）和行政部門或次區域（例如美國“州”和加拿大的“省”。
routePathRange	RoutePathRange	是指路線或路徑的特定腿所涵蓋的範圍。
subLegs	SubLeg[]	由路線腿路點和任何中繼通路點所定義之路線腿段的相關信息。例如，如果路線腿除了起點和終點外還有兩個通路點，則有三個（3）個路線子腿。

ManeuverPointProperties

Object

指定路線回合中每個機動點的駕駛指示和其他屬性。

名稱	類型	預設值	Description
address	Address		卡車路線上的路點和機動點的行政區和國家/地區。注意：僅支持貨車 travelMode。
compassDirection	string		與路線上的機動相關的旅行方向，例如南部或西南。 `Note`：僅支持駕駛 TravelMode。
distanceInMeters	number		此路線步驟所涵蓋公尺的實體距離。
durationInSeconds	integer (int64)		在對應 `TravelDistance`移動所花費的時間，以秒為單位。
exitIdentifier	string		與這個路由步驟相關聯的結束名稱或編號。
instruction	Instruction		一組方向的機動描述。
order	Order		瀏覽導航點和 viaWaypoints 的順序。
routePathPoint	RoutePathPoint		是指路線特定腿內某個點的索引。
sideOfStreet	SideOfStreetEnum		根據到達方向找到目的地的街道側。此欄位僅適用於最後一個操作Point。
signs	string[]		路線的標牌文字。可能有多個符號值。
steps	Step[]		連續兩個動作點之間的步驟。
towardsRoadName	string		路線在第一個 `ManeuverPoint`中走向的街道名稱。
travelMode	RoutePathTravelModeEnum	driving	回應中路線路徑的移動模式。
type	string: ManeuverPoint		輸出類型。

ManeuverTypeEnum

列舉型別

這個詳細集合中所述的動作類型。 ManeuverType 會提供對應指令所指定動作部分的資訊。例如，指令的 maneuverType 可能會指定 TurnLeftThenTurnRight，而相關聯的詳細數據專案可能會提供 TurnLeft 和 TurnRight 動作的特定資訊

值	Description
ArriveFinish	抵達最終目的地。
ArriveIntermediate	到達中繼的路點。
BearLeft	熊左。
BearLeftThenBearLeft	熊左，然後再次熊離開。
BearLeftThenBearRight	左熊，然後右熊。
BearLeftThenTurnLeft	熊左，然後左轉。
BearLeftThenTurnRight	左熊，然後向右轉。
BearRight	熊右。
BearRightThenBearLeft	右熊，然後左熊。
BearRightThenBearRight	熊右，然後再次承擔右。
BearRightThenTurnLeft	右熊，然後向左轉。
BearRightThenTurnRight	熊右，然後向右轉。
BearThenKeep	持有人指示，然後保留指示
BearThenMerge	持有人指令，然後是合併指令。
Continue	繼續在目前的道路上。
DepartIntermediateStop	將中間的路點放在與到達不同的方向和道路。
DepartIntermediateStopReturning	將中間的路點放在相同的方向上，並在您到達的相同道路上。
DepartStart	離開起點。
EnterRoundabout	輸入迴圈。
EnterThenExitRoundabout	輸入並結束迴圈。
ExitRoundabout	結束迴圈。
ExitRoundaboutLeft	在環形交叉路口，左方結束。
ExitRoundaboutRight	在環形交叉路口，右方結束。
Follow	跟隨。
GoAroundRoundabout	四處走動。
KeepLeft	保持左到不同的道路。
KeepOnRampLeft	保持左，繼續坡道。
KeepOnRampRight	保持右，繼續坡道。
KeepOnRampStraight	保持直，繼續坡道。
KeepRight	繼續走上另一條道路。
KeepStraight	直接走上不同的道路。
KeepToStayLeft	保持保持保持在同一條道路上。
KeepToStayRight	保持正確，保持在同一條道路上。
KeepToStayStraight	保持直接停留在同一條路上。
MergeFreeway	合併到高速公路上。
MergeHighway	合併到高速公路上。
MergeMotorway	合併到高速公路上。
MotorwayExitLeft	離開左側。
MotorwayExitRight	離開右側。
None	沒有指示。
RampThenHighwayLeft	把左坡帶到高速公路上。這是合併指令的一部分。
RampThenHighwayRight	向右坡道走上高速公路。這是合併指令的一部分。
RampThenHighwayStraight	直截了當地走上高速公路。這是合併指令的一部分。
RoadNameChange	道路名稱變更。
SwitchToMainRoad	切換到主幹道。
SwitchToParallelRoad	切換至平行道路。
Take	走路。當您進入或離開渡輪時，會使用此指示。
TakeExit	結束。
TakeFerry	乘坐渡輪。
TakeRamp	走坡道。
TakeRampLeft	向左走坡道。
TakeRampRight	向右走坡道。
TakeRampStraight	直截了當地走坡道。
TurnBack	急轉身。
TurnLeft	左轉。
TurnLeftSharp	左轉尖銳。
TurnLeftThenBearLeft	左轉，然後左轉。
TurnLeftThenBearRight	向左轉，然後右轉。
TurnLeftThenTurnLeft	向左轉，然後再次左轉。
TurnLeftThenTurnRight	向左轉，然後向右轉。
TurnRight	向右轉。
TurnRightSharp	採取尖銳的右轉。
TurnRightThenBearLeft	向右轉，然後向左轉。
TurnRightThenBearRight	向右轉，然後右轉。
TurnRightThenTurnLeft	向右轉，然後向左轉。
TurnRightThenTurnRight	向右轉，然後再次向右轉
TurnThenMerge	回合指示後面接著合併指令。
TurnToStayLeft	左轉以留在同一條路上。
TurnToStayRight	向右轉，以留在同一條路上。
UTurn	讓U轉彎向相反的方向前進。
Unknown	指令未知。
Wait	等
Walk	走

MapsErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	MapsErrorDetail[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	MapsInnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

MapsErrorResponse

Object

Azure 地圖服務 API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。

名稱	類型	Description
error	MapsErrorDetail	錯誤詳細數據。

MapsInnerError

Object

物件，包含與目前對象有關錯誤更具體的資訊。

名稱	類型	Description
code	string	錯誤碼。
innererror	MapsInnerError	物件，包含與目前對象有關錯誤更具體的資訊。

MultiLineStringGeometry

Object

指定 GeoJSON MultiLineString Geometry 物件。如需詳細資訊，請參閱 RFC 7946。

名稱	類型	Description
coordinates	number[] (double)	`GeoJson MultiLineString` 幾何座標。
type	string: MultiLineString	指定 `GeoJSON` Geometry 物件的幾何類型。如需詳細資訊，請參閱 RFC 7946。

OptimizedWaypoint

Object

優化的方式點物件。

名稱	類型	Description
inputIndex	integer (int64)	使用者提供的方式點索引。
optimizedIndex	integer (int64)	從系統優化的方式點索引。

Order

Object

瀏覽導航點和 viaWaypoints 的順序。

名稱	類型	Description
inputIndex	integer (int64)	使用者提供的 waypoint 和 viaWaypoint 輸入索引。
optimizedIndex	integer (int64)	系統優化的 Waypoint 和 viaWaypoint 索引。

PointGeometry

Object

傳遞為有效 GeoJSON Geometry 物件的源點，應該從中計算範圍多邊形。如需詳細資訊，請參閱 RFC 7946。

Note：API 會將要求的來源點貼齊至最近的道路網路，並將用於範圍計算。它會在回應中以 center 點的形式傳回。

名稱	類型	Description
coordinates	number[] (double)	`Position` 是具有兩個或多個元素的數字數位數位數位。前兩個元素是經度和緯度，確切地依該順序排列。高度/高度是選擇性的第三個專案。如需詳細資訊，請參閱 RFC 7946。
type	string: Point	指定 `GeoJSON` Geometry 物件的幾何類型。如需詳細資訊，請參閱 RFC 7946。

RegionTravelSummary

Object

以兩種實體類型區分的距離、時間和收費公路距離的旅行摘要：國家/地區（例如美國、加拿大）和行政部門或次區域（例如美國“州”和加拿大的“省”。

名稱	類型	Description
adminDistricts	AdminDistrict[]	adminDistrict 陣列。
countryRegion	CountryRegion	表示包含相關詳細數據的國家或地區。
distanceInMeters	number	Length In Meters 屬性
durationInSeconds	integer (int64)	預估的行進時間，以秒為單位，不包含因交通狀況而造成路線延誤。
durationTrafficInSeconds	integer (int64)	使用目前交通狀況的對應 `TravelDistance` 所花費的時間，以秒為單位。如果 `optimizeRoute` 包含流量考慮，則會提供此值。
tollDistanceInMeters	number	沿著包含收費公路的路線，以公尺為單位的總距離。

RoadTypeEnum

列舉型別

道路的類型。 Note：僅支持駕駛 TravelMode。

值	Description
Arterial	動脈。
Ferry	渡輪。
Highway	公路。
LimitedAccessHighway	LimitedAccessHighway。
MajorRoad	MajorRoad。
NotApplicable	NotApplicable。
Ramp	坡道。
Street	街。
WalkingPath	WalkingPath。

RouteDirectionOptimizeRouteEnum

列舉型別

指定要用來優化路由的參數。如果未定義，預設值為「fastestWithoutTraffic」，它會傳迴路由，以將旅行時間降到最低，而不使用目前的流量資訊。

範例：“optimizeRoute”：“shortest”

值	Description
fastestAvoidClosureWithoutTraffic	路線會計算為將時間降至最低，並避免道路關閉。計算中不會使用道路封閉以外的交通資訊。 `Note`：僅支持駕駛 TravelMode。
fastestWithTraffic	路由的計算方式是使用目前的流量資訊將時間降到最低。 `Note`：僅支持駕駛和卡車旅行模式。
fastestWithoutTraffic	尋找最快的路線，而不考慮交通資訊。
shortest	路由會計算為將距離降到最低。不會使用流量資訊。

RouteDirectionVehicleSpec

Object

僅指定貨車路線的車輛屬性，例如大小、重量、最大速度、貨物類型等。這有助於避免低橋通路、道路限制、難右轉，根據車輛規格提供優化的卡車路線。

ISNote：僅支援卡車 travelMode。

名稱	類型	預設值	Description
adrTunnelRestrictionCode	AdrTunnelRestrictionCodeEnum		ADR 通道限制程式代碼。 ADR是一項歐洲關於公路危險品國際運輸的協定。 ADR 隧道限制代碼可用來判斷車輛是否允許通過具有危險貨物運輸限制的隧道。
axleCount	integer (int64)		車輛上的軸數。
axleWeight	integer (int64) minimum: 0 maximum: 1000000	0	每軸車輛重量以公斤為單位。值為 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 值是 US Hazmat 類別 1 到 9，加上用於其他國家/地區的泛型分類。以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 支援要求中的多個值。
maxSpeed	integer (int64) minimum: 0 maximum: 250	0	車輛的最大速度，以公里/小時為單位。車輛配置檔中的最大速度用於檢查高速公路上是否允許車輛。值為 0 表示將在路線規劃期間決定並套用車輛的適當值。在路線規劃期間，可能會覆寫非零的值。例如，目前的流量為 60 公里/小時。如果車輛最大速度設定為每小時 50 公里，路由引擎會考慮 60 公里/小時，因為這是目前的情況。如果車輛的最大速度提供為80公里/小時，但目前的交通流量為60公里/小時，則路由引擎將再次使用60公里/小時。
weight	integer (int64) minimum: 0 maximum: 1000000	0	車輛重量以公斤為單位。值為 0 表示不會考慮權數限制。
width	number (double) minimum: 0 maximum: 1000000	0	車輛寬度以公尺為單位。值為 0 表示不會考慮寬度限制。

RouteOutputOptionEnum

列舉型別

包含回應中所需的路由資訊。根據預設，行程會包含在回應中。

支援多個值，例如 “routeOutputOptions”： [“routePath”， “regionTravelSummary”]

值	Description
itinerary	在回應中包含詳細指示。詳細指示會以「ManeuverPoints」提供，並包含回合指示等詳細數據。
regionTravelSummary	包含兩種實體類型的距離、時間和收費公路距離的旅行摘要：國家/地區（例如美國、加拿大）和行政部門或次區域（例如，美國“州”和加拿大的“省”。 `Note`：僅支持駕駛和步行旅行模式
routePath	包含 GeoJSON MultiLineString RFC 7946，第 3.1.5 節，以描述回應中的路由路徑。
routeSummary	只包含路線的行進時間和距離，且不提供其他資訊。

RoutePathPoint

Object

是指路線特定腿內某個點的索引。

名稱	類型	Description
legIndex	integer (int64)	路由腿索引是指派給路線每個 Leg 的循序編號，可協助識別和區分路線的不同區段。
pointIndex	integer (int64)	特定 Leg 內點的索引。

RoutePathProperties

Object

指定描述回應中路由路徑的屬性。

名稱	類型	Description
arrivalAt	string (date-time)	考慮到交通狀況的腿估計抵達時間，會格式化為由 `dateTime`所定義的值。它會參考 `departAt` 或 `arrivalAt`的時區位移。如果沒有，則會使用UTC時間。
departureAt	string (date-time)	考慮到交通狀況的腿估計出發時間，會格式化為由 `dateTime`所定義的值。它會參考 `departAt` 或 `arrivalAt`的時區位移。如果沒有，則會使用UTC時間。
distanceInMeters	number	整個路線所覆蓋的公尺物理距離。
durationInSeconds	integer (int64)	預估的行進時間，以秒為單位，不包含因交通狀況而造成路線延誤。
durationTrafficInSeconds	integer (int64)	使用目前交通狀況的對應 `TravelDistance` 所花費的時間，以秒為單位。如果 `optimizeRoute` 包含流量考慮，則會提供此值。
legs	Leg[]	路由腿的陣列。如需詳細資訊，請查看 Route Leg 物件描述。
optimizedWaypoints	OptimizedWaypoint[]	優化的方式點序列。它會顯示使用者針對原始和優化清單提供之導航點序列的索引。
resourceId	string	資源的唯一標識碼。
trafficCongestion	TrafficCongestionEnum	路線沿線交通擁堵程度。 `Note`：僅支持駕駛 TravelMode
trafficDataUsed	TrafficDataUsedEnum	用來產生路由的即時流量數據類型。
type	string: RoutePath	輸出類型。

RoutePathRange

Object

是指路線或路徑的特定腿所涵蓋的範圍。

名稱	類型	Description
legIndex	integer (int64)	路由腿索引是指派給路線每個 Leg 的循序編號，可協助識別和區分路線的不同區段。
range	integer[] (int64)	是指路線或路徑的特定腿所涵蓋的範圍。

RoutePathTravelModeEnum

列舉型別

回應中路線路徑的移動模式。

值	Description
driving	針對汽車優化的路線。
other	當貨車路線不適用於路線的特定區段時，RouteTravelMode 會傳回為貨車 travelMode 的「其他」。
truck	根據車輛規格針對大型卡車優化的路線。
walking	針對行人優化的路線。

SideOfStreetEnum

列舉型別

根據到達方向找到目的地的街道側。此欄位僅適用於最後一個操作Point。

值	Description
Left	左。
Right	右。
Unknown	未知。

Step

Object

路線回合包含回合指示。步驟是指兩個連續動作Point 之間的路由範圍。

名稱	類型	Description
compassDegrees	number	以度為單位的方向。 `Note`：僅支持駕駛 TravelMode。
maneuverType	ManeuverTypeEnum	這個詳細集合中所述的動作類型。 ManeuverType 會提供對應指令所指定動作部分的資訊。例如，指令的 maneuverType 可能會指定 TurnLeftThenTurnRight，而相關聯的詳細數據專案可能會提供 TurnLeft 和 TurnRight 動作的特定資訊
names	string[]	發生機動的街道、高速公路或十字路口。如果動作很複雜，則詳細數據集合中可能會有多個名稱欄位。名稱欄位可能也沒有值。如果名稱未知，或者街道、高速公路或十字路口沒有名稱，就會發生這種情況。
roadType	RoadTypeEnum	道路的類型。 `Note`：僅支持駕駛 TravelMode。
routePathRange	RoutePathRange	是指路線或路徑的特定腿所涵蓋的範圍。

SubLeg

Object

由路線腿路點和任何中繼通路點所定義之路線腿段的相關信息。例如，如果路線腿除了起點和終點外還有兩個通路點，則有三個（3）個路線子腿。

名稱	類型	Description
distanceInMeters	number	子腿覆蓋的公尺物理距離。
durationInSeconds	integer (int64)	預估的行進時間，以秒為單位，不包含因交通狀況而造成路線延誤。
durationTrafficInSeconds	integer (int64)	使用目前交通狀況的對應 `TravelDistance` 所花費的時間，以秒為單位。如果 `optimizeRoute` 包含流量考慮，則會提供此值。
routePathRange	RoutePathRange	是指路線或路徑的特定腿所涵蓋的範圍。

Summary

Object

批次要求的摘要

名稱	類型	Description
successfulRequests	integer (int32)	批次中成功的要求數目
totalRequests	integer (int32)	批次中的要求總數

TrafficCongestionEnum

列舉型別

路線沿線交通擁堵程度。 Note：僅支持駕駛 TravelMode

值	Description
Heavy	重。
Medium	中等。
Mild	輕微。
None	沒有。
Unknown	未知。

TrafficDataUsedEnum

列舉型別

用來產生路由的即時流量數據類型。

值	Description
Closure	如果適用，則使用即時關閉數據。
Flow	用來計算行進時間的即時流量速度。
FlowAndClosure	流程和關閉。
None	沒有。

TravelModeEnum

列舉型別

所要求路線的移動模式。如果未定義，則預設值為「駕駛」，會傳回針對汽車優化的路線。

Note：對於卡車 travelMode，要求的貨車路線可能無法用於整個路線。當貨車路線不適用於特定區段時，該區段回應的 travelMode 元素將會是「其他」。

範例：“travelMode”：“driving”

值	Description
driving	傳回的路線已針對汽車進行優化。
truck	傳回的路線會根據車輛規格針對大型卡車進行優化。
walking	傳回的路線已針對行人進行優化，包括人行道的使用。

VehicleLoadTypeEnum

列舉型別

可能分類為危險物質的貨物類型，並受限於某些道路。可用的 vehicleLoadType 值是 US Hazmat 類別 1 到 9，加上用於其他國家/地區的泛型分類。以 USHazmat 開頭的值適用於美國路由，而 otherHazmat 則應該用於所有其他國家/地區。 vehicleLoadType 支援要求中的多個值。

值	Description
USHazmatClass1	炸藥
USHazmatClass2	壓縮氣體
USHazmatClass3	易燃液體
USHazmatClass4	易燃固體
USHazmatClass5	Oxidizers
USHazmatClass6	毒藥
USHazmatClass7	放射性
USHazmatClass8	腐蝕
USHazmatClass9	其他
otherHazmatExplosive	炸藥
otherHazmatGeneral	其他
otherHazmatHarmfulToWater	對水有害

ViaWaypointProperties

Object

指定 ViaWaypoint 的屬性，這是必須沿著路線或行程經過或流覽的路點。

名稱	類型	Description
names	string[]	發生機動的街道、高速公路或十字路口。如果動作很複雜，則詳細數據集合中可能會有多個名稱欄位。名稱欄位可能也沒有值。如果名稱未知，或者街道、高速公路或十字路口沒有名稱，就會發生這種情況。
order	Order	瀏覽導航點和 viaWaypoints 的順序。
routePathPoint	RoutePathPoint	是指路線特定腿內某個點的索引。
type	string: ViaWaypoint	輸出類型。

WaypointProperties

Object

指定航點的屬性，這是作為參考或停止點之路線或車程的特定位置或點。

名稱	類型	預設值	Description
address	Address		卡車路線上的路點和機動點的行政區和國家/地區。注意：僅支持貨車 travelMode。
compassDirection	string		與路線上的機動相關的旅行方向，例如南部或西南。 `Note`：僅支持駕駛 TravelMode。
distanceInMeters	number		此路線步驟所涵蓋公尺的實體距離。
durationInSeconds	integer (int64)		在對應 `TravelDistance`移動所花費的時間，以秒為單位。
exitIdentifier	string		與這個路由步驟相關聯的結束名稱或編號。
instruction	Instruction		一組方向的機動描述。
order	Order		瀏覽導航點和 viaWaypoints 的順序。
routePathPoint	RoutePathPoint		是指路線特定腿內某個點的索引。
sideOfStreet	SideOfStreetEnum		根據到達方向找到目的地的街道側。此欄位僅適用於最後一個操作Point。
signs	string[]		路線的標牌文字。可能有多個符號值。
steps	Step[]		連續兩個動作點之間的步驟。
towardsRoadName	string		路線在第一個 `ManeuverPoint`中走向的街道名稱。
travelMode	RoutePathTravelModeEnum	driving	回應中路線路徑的移動模式。
type	string: Waypoint		輸出類型。

共用方式為

Route - Post Route Directions Batch

提交同步批次要求

批次要求的 POST 本文

批次回應模型

URI 參數

要求標頭

要求本文

回應

安全性

AADToken

範圍

subscription-key

SAS Token

範例

A Route Directions Batch request containing 2 queries

範例要求

範例回覆

定義

Address

AdminDistrict

AdminDistrictTruck

AdrTunnelRestrictionCodeEnum

AvoidEnum

CountryRegion

DirectionsBatchRequestBody

DirectionsBatchRequestItem

DirectionsBatchResponse

DirectionsBatchResponseItem

DrivingSideEnum

ErrorAdditionalInfo

ErrorDetail

FeatureCollection

FeaturesItem

FeaturesItemTypeEnum

FeatureTypeEnum

GeoJsonPoint

Hint

InputWaypointFeaturesItem

InputWaypointProperties

InputWaypointTypeEnum

Instruction

Leg

ManeuverPointProperties

ManeuverTypeEnum

MapsErrorDetail

MapsErrorResponse

MapsInnerError

MultiLineStringGeometry

OptimizedWaypoint

Order

PointGeometry

RegionTravelSummary

RoadTypeEnum

RouteDirectionOptimizeRouteEnum

RouteDirectionVehicleSpec

RouteOutputOptionEnum

RoutePathPoint

RoutePathProperties

RoutePathRange

RoutePathTravelModeEnum

SideOfStreetEnum

Step

SubLeg

Summary

TrafficCongestionEnum

TrafficDataUsedEnum

TravelModeEnum

VehicleLoadTypeEnum

ViaWaypointProperties

WaypointProperties