次の方法で共有

Traffic - Get Traffic Incident Viewport

  • リファレンス
サービス:
Maps
API バージョン:
1.0

ビューポートの法的および技術情報を取得するには、 を使用します。

Traffic Incident Viewport API は、要求で説明されているビューポートの法的および技術情報を返す HTTP GET 要求です。 これは、ビューポートが変更されるたびにクライアント アプリケーションによって呼び出される必要があります (たとえば、ズーム、パン、場所への移動、ルートの表示など)。 要求には、情報が必要なビューポートの境界ボックスとズーム レベルが含まれている必要があります。 戻り値には、マップ バージョン情報と、現在のトラフィック モデル ID と著作権 ID が含まれます。 ビューポートの説明によって返されるトラフィック モデル ID は、他の API が、さらに処理するために最後のトラフィック情報を取得するために使用されます。

GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}
省略可能なパラメーターを含む: 
GET https://atlas.microsoft.com/traffic/incident/viewport/{format}?api-version=1.0&boundingbox={boundingbox}&boundingzoom={boundingzoom}&overviewbox={overviewbox}&overviewzoom={overviewzoom}&copyright={copyright}

URI パラメーター

名前 / 必須 型 説明
format
 path True

ResponseFormat

応答の目的の形式。 値には json または xml のいずれかを指定できます。
api-version
 query True

string

Azure Maps API のバージョン番号。
boundingbox
 query True

number[]

プロジェクション内のマップ ビューポートの境界ボックス EPSG900913 。 boundingboxは、角を表す 2 つの値ペア (左下隅の場合は最初のペア、右上の場合は 2 番目のペア) で表されます。 このエンドポイントを直接呼び出す場合は、すべての値をコンマ ( minY、minX、maxY、maxX など) で区切る必要があります。 渡すことができる境界ボックスの最大サイズは、要求されたズーム レベルによって異なります。 指定したズーム レベルでレンダリングする場合、幅と高さは 4092 ピクセルを超えることはできません。

注:180°の子午線を横切る境界ボックスには特別な処理が必要です。 このようなボックスの場合、東部 の maxX 値は負の値になるため、180° の子午線の西の minX 値より小さくなります。 それに対処するには、要求で渡される前に、値 40075016.6855874 を true maxX 値に追加する必要があります。
boundingzoom
 query True

integer

int32

マップ ビューポートのズーム レベル。 ビューを拡大表示できるかどうかを判断するために使用します。
overviewbox
 query True

number[]

プロジェクションの概要マップの境界ボックス EPSG900913 。

概要ボックス/ミニ マップにメイン マップとは異なる著作権データがある場合に使用されます。 ミニ マップがない場合は、 と同じ座標 boundingBox が使用されます。 このエンドポイントが直接呼び出されると、座標はコンマで区切られた 4 つの座標を含む 1 つの文字列として渡されます。
overviewzoom
 query True

integer

int32

概要マップのズーム レベル。 ミニ マップがない場合は、boundingZoom と同じズーム レベルを使用します。
copyright
 query

boolean

返す著作権情報を決定します。 true の場合、著作権テキストが返されます。false の場合は、著作権インデックスのみが返されます。

要求ヘッダー

名前 必須 型 説明
x-ms-client-id

string

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

応答

名前 型 説明
200 OK

TrafficIncidentViewport

OK
Other Status Codes

ErrorResponse

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

セキュリティ

AADToken

これらは Microsoft Entra OAuth 2.0 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上の Azure Maps リソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 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 を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。

型: 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 で Azure Maps アカウントを作成 するとき、または PowerShell、CLI、Azure SDK、または REST API を使用するときにプロビジョニングされる共有キーです。

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

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

型: apiKey
/: query

SAS Token

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

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

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

型: apiKey
/: header

例

Request traffic incident information for the selected viewport

要求のサンプル

GET https://atlas.microsoft.com/traffic/incident/viewport/json?api-version=1.0&boundingbox=-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107&boundingzoom=2&overviewbox=-939584.4813018347,-23954526.723651607,14675583.153020501,25043442.89582291&overviewzoom=2&copyright=True

応答のサンプル

状態コード:
200 
{
  "viewpResp": {
    "trafficState": {
      "@trafficAge": 18895,
      "@trafficModelId": "1504808593298"
    },
    "copyrightIds": "© 2017 GeoSmart^© 2017 TomTom^© 2017 Whereis",
    "@version": "1.0.51-mascoma",
    "@maps": "europe,taiwan,latam,northamerica,israel,middleeast,iraq,guam,australia,newzealand,india,africa,world,southeastasia"
  }
}

定義

名前 説明
ErrorAdditionalInfo

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

エラーの詳細。
ErrorResponse

エラー応答
ResponseFormat

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

このオブジェクトは、成功した Traffic Incident Viewport 呼び出しから返されます
TrafficState

トラフィック状態情報
ViewpResp

ビューポート応答オブジェクト

ErrorAdditionalInfo

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

名前 型 説明
info

object

追加情報。
type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細です。
message

string

エラー メッセージ。
target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 型 説明
error

ErrorDetail

error オブジェクト。

ResponseFormat

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

名前 型 説明
json

string

JavaScript オブジェクト表記データ交換形式
xml

string

拡張マークアップ言語

TrafficIncidentViewport

このオブジェクトは、成功した Traffic Incident Viewport 呼び出しから返されます

名前 型 説明
viewpResp

ViewpResp

ビューポート応答オブジェクト

TrafficState

トラフィック状態情報

名前 型 説明
@trafficAge

integer

トラフィック モデル ID の作成からの経過時間 (秒単位)。
@trafficModelId

string

Traffic Model ID と呼ばれる一意の ID は、Traffic Incident サービスへの呼び出しで使用されます。 これにより、特定のトラフィックの更新から情報を取得できます。 トラフィック モデル ID は 1 分ごとに更新され、タイムアウトするまでの 2 分間有効です。

ViewpResp

ビューポート応答オブジェクト

名前 型 説明
@maps

string

ビューポートで使用されるマップ データのデータ プロバイダーの内部名を示します。 サポート クエリで使用する場合。
@version

string

情報の生成に使用されるソフトウェア バージョンを示します。 サポート クエリで使用する場合。
copyrightIds

string

copyright パラメーターの値が true の場合、これには、ビューポート内のタイルと共に表示する必要がある著作権情報のフルテキストが含まれます
trafficState

TrafficState

トラフィック状態情報