Traffic - Get Traffic Flow Segment

リファレンス

Service:: Maps

API Version:: 1.0

を使用して、道路の指定されたセクションの速度と移動時間に関する情報を取得します。

Traffic Flow Segment API は、指定された座標に最も近い道路フラグメントの速度と移動時間に関する情報を提供する HTTP GET 要求です。クリック可能なフローデータの視覚化をサポートするために、 Render Service のフローレイヤーと共に動作するように設計されています。 API を Traffic Flow Segment 使用すると、クライアント側はマップ内の任意の場所を、最も近い道路のフローデータと接続し、ユーザーに提示できます。

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 パラメーター

名前	/	必須	型	説明
format	path	True	ResponseFormat	応答の目的の形式。値には json または xml を指定できます。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	number[]	道路セグメントに近い点の座標。このパラメーターは、2 つの座標ペア (lat、long、lat、long) を含む 4 つの座標のリストであり、投影EPSG4326使用して計算されます。このエンドポイントが直接呼び出されると、座標はコンマで区切られた 4 つの座標を含む 1 つの文字列として渡されます。
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 の速度の単位

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。 Azure Maps アカウントの一意の ID を表し、Azure Maps管理プレーンアカウント API から取得できます。 Azure MapsでMicrosoft Entra IDセキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

名前	型	説明
200 OK	TrafficFlowSegmentData	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

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

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

メモ

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソース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 プラットフォームの概要」を参照してください。

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

Scopes

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portalでAzure Maps アカウントをCreateするとき、または PowerShell、CLI、Azure SDK、または REST API を使用してプロビジョニングされる共有キーです。

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

公開されているアプリケーションの場合は、機密クライアントアプリケーションのアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。

Type: apiKey
In: query

SAS Token

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

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

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、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"
  }
}

定義

名前	説明
Coordinates	セグメントの形状を記述する座標が含まれます。ズームレベルに応じて座標が道路からシフトされ、すべてのスケールで高品質の視覚化がサポートされます。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FlowSegmentData	Flow Segment Data プロパティ
LatLongPair	緯度と経度として表される場所。
ResponseFormat	応答の目的の形式。値には json または xml を指定できます。
SpeedUnit	KMPH または MPH の速度の単位
TrafficFlowSegmentData	このオブジェクトは、トラフィックフローセグメントの正常な呼び出しから返されます
TrafficFlowSegmentStyle	タイルのレンダリングに使用するスタイル。有効な値は絶対速度を反映する色を返す絶対値です。相対はフリーフローに対して速度を返し、相対遅延はフリーフロー速度と異なる場合にのみ相対速度を表示します

Coordinates

セグメントの形状を記述する座標が含まれます。ズームレベルに応じて座標が道路からシフトされ、すべてのスケールで高品質の視覚化がサポートされます。

名前	型	説明
coordinate	LatLongPair[]	座標配列

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

FlowSegmentData

Flow Segment Data プロパティ

名前	型	説明
@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

緯度と経度として表される場所。

名前	型	説明
latitude	number	Latitude プロパティ
longitude	number	Longitude プロパティ

ResponseFormat

応答の目的の形式。値には json または xml を指定できます。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式
xml	string	拡張可能なマークアップ言語

SpeedUnit

KMPH または MPH の速度の単位

名前	型	説明
KMPH	string	キロメートル/時
MPH	string	1 時間あたりのマイル数

TrafficFlowSegmentData

このオブジェクトは、トラフィックフローセグメントの正常な呼び出しから返されます

名前	型	説明
flowSegmentData	FlowSegmentData	Flow Segment Data プロパティ

TrafficFlowSegmentStyle

タイルのレンダリングに使用するスタイル。有効な値は絶対速度を反映する色を返す絶対値です。相対はフリーフローに対して速度を返し、相対遅延はフリーフロー速度と異なる場合にのみ相対速度を表示します

名前	型	説明
absolute	string
relative	string
relative-delay	string