Traffic - Get Traffic Flow Segment

參考

Service:: Maps

API Version:: 1.0

使用來取得指定道路區段的速度和行進時間的相關信息。

Traffic Flow Segment API 是 HTTP GET 要求，可提供最接近指定座標之道路片段速度和行進時間的相關信息。其設計目的是要與轉譯服務的 Flow 層一起運作，以支援可點選的流程數據視覺效果。 Traffic Flow Segment透過 API，用戶端可以將地圖中的任何位置與最接近道路的流量數據連線，並將其呈現給使用者。

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}

With optional parameters:

GET https://atlas.microsoft.com/traffic/flow/segment/{format}?api-version=1.0&style={style}&zoom={zoom}&query={query}&unit={unit}&thickness={thickness}&openLr={openLr}

URI 參數

名稱	位於	必要	類型	Description
format	path	True	ResponseFormat	所需的回應格式。值可以是 json 或 xml。
api-version	query	True	string	Azure 地圖服務 API 的版本號碼。
query	query	True	number[]	靠近道路區段的點座標。此參數是四個座標的清單，其中包含兩個座標組 (lat、long、lat、long) ，以及使用EPSG4326投影計算。直接呼叫此端點時，座標會以包含四個座標的單一字串傳入，並以逗號分隔。
style	query	True	TrafficFlowSegmentStyle	用來呈現磚的樣式。有效值為絕對值，其會傳回反映測量之絕對速度的色彩，相對會傳回相對於自由流程的速度相對延遲，而相對延遲只會顯示相對於自由流速度的相對速度，只顯示與自由流速度不同的相對速度
zoom	query	True	integer int32	所需磚的縮放層級。縮放值的範圍必須介於：0-22 (內含) 。如需詳細資訊，請參閱縮放層級和磚網格線。
openLr	query		boolean	布爾值，指出回應是否應該包含 OpenLR 程式代碼
thickness	query		integer int32	代表流量之線條寬度的值。這個值是乘數，接受的值範圍從 1 到 20。預設值是 10。
unit	query		SpeedUnit	KMPH 或 MPH 中的速度單位

要求標頭

名稱	必要	類型	Description
x-ms-client-id		string	指定哪一個帳戶要與 Microsoft Entra ID 安全性模型搭配使用。它代表 Azure 地圖服務帳戶的唯一標識符，而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。若要在 Azure 地圖服務中使用 Microsoft Entra ID 安全性，請參閱下列文章以取得指引。

回應

名稱	類型	Description
200 OK	TrafficFlowSegmentData	確定
Other Status Codes	ErrorResponse	發生意外錯誤。

安全性

AADToken

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

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

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖服務管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Microsoft Entra ID 組態。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式的組態型設定。

如需 Microsoft 身分識別平台的詳細資訊，請參閱 Microsoft 身分識別平台概觀。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

subscription-key

這是在 Azure 入口網站或使用PowerShell、CLI、Azure SDK 或 REST API Create Azure 地圖服務帳戶時所佈建的共用金鑰。

使用此金鑰時，任何應用程式都可以存取所有 REST API。換句話說，此金鑰可作為發行帳戶中的主要金鑰。

對於公開的應用程式，我們建議使用機密用戶端應用程式方法來存取 Azure 地圖服務 REST API，以便安全地儲存密鑰。

Type: apiKey
In: query

SAS Token

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

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

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

Type: apiKey
In: header

範例

Request traffic flow segment information

Sample Request

HTTP

GET https://atlas.microsoft.com/traffic/flow/segment/json?api-version=1.0&style=absolute&zoom=10&query=52.41072,4.84239

Sample Response

Status code:: 200

{
  "flowSegmentData": {
    "frc": "FRC3",
    "currentSpeed": 79,
    "freeFlowSpeed": 79,
    "currentTravelTime": 33,
    "freeFlowTravelTime": 33,
    "confidence": 0.5,
    "coordinates": {
      "coordinate": [
        {
          "latitude": 52.404648,
          "longitude": 4.8442388
        },
        {
          "latitude": 52.408447,
          "longitude": 4.8357286
        }
      ]
    },
    "openlr": null,
    "@version": "1.0.53-mascoma"
  }
}

定義

名稱	Description
Coordinates	包含描述線段圖形的座標。座標會根據縮放層級從道路轉移，以支援每個縮放比例中的高品質視覺效果。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
FlowSegmentData	流程區段數據屬性
LatLongPair	以緯度和經度表示的位置。
ResponseFormat	所需的回應格式。值可以是 json 或 xml。
SpeedUnit	KMPH 或 MPH 中的速度單位
TrafficFlowSegmentData	此物件會從成功的流量區段呼叫傳回
TrafficFlowSegmentStyle	用來呈現磚的樣式。有效值為絕對值，其會傳回反映測量之絕對速度的色彩，相對會傳回相對於自由流程的速度相對延遲，而相對延遲只會顯示相對於自由流速度的相對速度，只顯示與自由流速度不同的相對速度

Coordinates

包含描述線段圖形的座標。座標會根據縮放層級從道路轉移，以支援每個縮放比例中的高品質視覺效果。

名稱	類型	Description
coordinate	LatLongPair[]	座標陣組

ErrorAdditionalInfo

資源管理錯誤其他資訊。

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

ErrorDetail

錯誤詳細數據。

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

ErrorResponse

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

FlowSegmentData

流程區段數據屬性

名稱	類型	Description
@version	string	這表示產生回應的軟體版本。
confidence	number	信賴度是所提供行進時間和速度品質的量值。值為 1 表示完全信賴度，表示回應包含最高質量的數據。較低的值表示回應可能與道路的實際條件不同。大於 0.6 的任何值表示資訊是以即時探查輸入為基礎。值為 0.5 表示報告的速度是以歷程記錄資訊為基礎。介於 0.5 和 0.6 之間的值具有歷程記錄和即時速度之間的加權平均值。
coordinates	Coordinates	包含描述線段圖形的座標。座標會根據縮放層級從道路轉移，以支援每個縮放比例中的高品質視覺效果。
currentSpeed	integer	所選點目前的平均速度，以所要求的單位為單位。這會從 currentTravelTime 和所選區段的長度計算。
currentTravelTime	integer	目前的行進時間，以秒為單位，跨越此流量區段，根據指定方向中已定義位置之間的融合實時測量。
frc	string	功能性道路類別。這表示道路類型：0：水車、路道或其他主要道路。 1：主要道路，比一個氣氣還少。 2：其他主要道路。 3：次要道路。 4：本機連接道路。 5：高重要性的當地道路。 6：當地道路。
freeFlowSpeed	integer	理想情況下預期的自由流程速度，以所要求的單位表示。這與freeFlowTravelTime相關。
freeFlowTravelTime	integer	此流量區段的行進時間以秒為單位，在理想的自由流量狀況下預期。
openlr	string	區段的OpenLR程式代碼。如需使用 Open LR 程式代碼的詳細資訊，請參閱 OpenLR 。

LatLongPair

以緯度和經度表示的位置。

名稱	類型	Description
latitude	number	Latitude 屬性
longitude	number	經度屬性

ResponseFormat

所需的回應格式。值可以是 json 或 xml。

名稱	類型	Description
json	string	JavaScript 物件表示法數據交換格式
xml	string	可延伸標記語言

SpeedUnit

KMPH 或 MPH 中的速度單位

名稱	類型	Description
KMPH	string	每小時的公里數
MPH	string	每小時英哩數

TrafficFlowSegmentData

此物件會從成功的流量區段呼叫傳回

名稱	類型	Description
flowSegmentData	FlowSegmentData	流程區段數據屬性

TrafficFlowSegmentStyle

用來呈現磚的樣式。有效值為絕對值，其會傳回反映測量之絕對速度的色彩，相對會傳回相對於自由流程的速度相對延遲，而相對延遲只會顯示相對於自由流速度的相對速度，只顯示與自由流速度不同的相對速度

名稱	類型	Description
absolute	string
relative	string
relative-delay	string