Route - Post Snap To Roads

Snap to Roads API は、経度と緯度の座標として表される GPS ポイント データを受け入れ、マップ上の既存の道路に沿ったポイントを生成します。 このプロセスは、"道路へのスナップ" と呼ばれ、道路ネットワークの近くのパスをトレースする一連のオブジェクトを生成します。 結果のデータには、通過したセグメントに関連する道路名とそれぞれの速度制限が含まれます。

さらに、Snap to Roads API には補間機能が用意されており、GPS ポイントを調整して、道路のジオメトリに準拠するよりスムーズなルートを作成できます。 この機能は、マッピング アプリケーションでの資産の追跡とデータ視覚化の強化に特に役立ちます。

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

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

URI パラメーター

要求ヘッダー

Media Types: "application/geo+json"

要求本文

Media Types: "application/geo+json"

応答

セキュリティ

AADToken

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

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

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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 snap to roads points with additional parameters in the body

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

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.336729,
          47.590868
        ],
        "type": "Point"
      },
      "properties": {}
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.336042,
          47.601604
        ],
        "type": "Point"
      },
      "properties": {}
    }
  ],
  "includeSpeedLimit": true,
  "travelMode": "driving"
}

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.336769,
          47.590885
        ],
        "type": "Point"
      },
      "properties": {
        "inputIndex": 0,
        "isInterpolated": false,
        "name": "State Rte-99 N",
        "speedLimitInKilometersPerHour": 80
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "coordinates": [
          -122.336008,
          47.601609
        ],
        "type": "Point"
      },
      "properties": {
        "inputIndex": 1,
        "isInterpolated": false,
        "name": "State Rte-99 N",
        "speedLimitInKilometersPerHour": 80
      }
    }
  ]
}

定義

FeaturesItemTypeEnum

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

FeatureTypeEnum

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

GeoJsonPoint

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

InputSnapToRoadsFeaturesItem

道路ポイントへの入力スナップを指定します。 フィーチャー オブジェクトと追加のプロパティを GeoJSON します。 詳細については、RFC 7946 を参照してください。

MapsErrorDetail

エラーの詳細。

MapsErrorResponse

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

MapsInnerError

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

PointGeometry

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

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

SnapToRoadFeaturesItem

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

SnapToRoadsFeatureProperties

[道路にスナップ] プロパティ

SnapToRoadsRequest

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

SnapToRoadsResponse

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

SnapToRoadsTravelModeEnum

ポイントをスナップするためのルーティング プロファイルを指定します。 指定しない場合、既定のモードは "運転" であり、ルートを運転するためにスナップされたポイントを最適化します。