Spatial - Post Closest Point

リファレンス

サービス:: Maps

API バージョン:: 2022-08-01

ベースポイントと特定のターゲットポイントのセットの間の最も近いポイントを取得するには、を使用します。

Post Closest Point API は、ベースポイントと特定のターゲットポイントのセットの間の最も近いポイントを返す HTTP POST 要求です。ターゲットポイントのセットは、要求後の本文でユーザーデータによって提供されます。ユーザーデータに含まれるのは、Point ジオメトリのコレクションのみです。 MultiPoint またはその他のジオメトリが指定されている場合、無視されます。このアルゴリズムでは、ルーティングやトラフィックは考慮されません。許容されるポイントの最大数は 100,000 です。返される情報には、最も近いポイントの緯度、経度、最も近いポイントからの距離 (メートル単位) が含まれます。

POST https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat={lat}&lon={lon}

省略可能なパラメーターを含む:

POST https://{geography}.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat={lat}&lon={lon}&numberOfClosestPoints={numberOfClosestPoints}

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
geography	path	True	string	Azure Maps アカウントの場所。有効な値は、us (米国東部、米国中西部、米国西部 2) と eu (北ヨーロッパ、西ヨーロッパ) です。このパラメーターは、が要求で指定されている場合 `udid` に必要です。たとえば、Azure Maps アカウントが米国東部にある場合、地理への要求のみが受け入れられます。
api-version	query	True	string	Azure Maps API のバージョン番号。
lat	query	True	number	渡される場所の緯度。例: 48.36。
lon	query	True	number	渡される場所の経度。例: -124.63。
numberOfClosestPoints	query		integer	応答から予想される最も近いポイントの数。既定値: 1、最小: 1、最大: 50

要求ヘッダー

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

要求本文

名前	必須	型	説明
features	True	GeoJsonFeature[]	有効な `GeoJSON Feature` オブジェクトの一覧を格納します。
type	True	string: FeatureCollection	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

応答

名前	型	説明
200 OK	ClosestPointResponse	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 を使用すると、複数のユースケースに対するアプリケーションの構成ベースのセットアップが可能になります。

Microsoft ID プラットフォームの詳細については、「 Microsoft ID プラットフォームの概要」を参照してください。

型: 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、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを介して Azure Maps リソースを作成するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスする権限が与えられている。つまり、これらは現在、発行先のアカウントのマスターキーとして扱うことができます。

公開されているアプリケーションの場合、このキーを安全に格納できる Azure Maps REST API のサーバー間アクセスを使用することをお勧めします。

型: apiKey
/: header

SAS Token

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

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

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

型: apiKey
/: header

例

PostClosestPoint

要求のサンプル

HTTP

POST https://us.atlas.microsoft.com/spatial/closestPoint/json?api-version=2022-08-01&lat=47.622942&lon=-122.316456

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "properties": {
        "geometryId": 1001
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -105.02860293715861,
          40.51615340677395
        ]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "geometryId": 1002
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -105.02860381672178,
          40.51599099003731
        ]
      }
    },
    {
      "type": "Feature",
      "properties": {
        "geometryId": 1003
      },
      "geometry": {
        "type": "Point",
        "coordinates": [
          -105.02812292879467,
          40.51605867808856
        ]
      }
    }
  ]
}

応答のサンプル

状態コード:: 200

{
  "summary": {
    "sourcePoint": {
      "lat": 47.622942,
      "lon": -122.316456
    },
    "udid": null,
    "information": "3 points processed in user data"
  },
  "result": [
    {
      "distanceInMeters": 1587492.66,
      "position": {
        "lat": 40.51615340677395,
        "lon": -105.02860293715861
      },
      "geometryId": "1001"
    }
  ]
}

定義

名前	説明
ClosestPoint	最も近いポイントの結果エントリオブジェクト
ClosestPointResponse	このオブジェクトは、成功した空間最近接ポイント呼び出しから返されます
ClosestPointSummary	最も近いポイントの概要オブジェクト
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GeoJsonFeature	有効な `GeoJSON Feature` オブジェクト型。詳細については、 RFC 7946 を参照してください。
GeoJsonFeatureCollection	有効な `GeoJSON FeatureCollection` オブジェクト型。詳細については、 RFC 7946 を参照してください。
GeoJsonGeometry	有効な `GeoJSON` geometry オブジェクト。この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。詳細については、 RFC 7946 を参照してください。
GeoJsonGeometryCollection	有効な `GeoJSON GeometryCollection` オブジェクト型。詳細については、 RFC 7946 を参照してください。
GeoJsonLineString	有効な `GeoJSON LineString` geometry 型。詳細については、 RFC 7946 を参照してください。
GeoJsonMultiLineString	有効な `GeoJSON MultiLineString` geometry 型。詳細については、 RFC 7946 を参照してください。
GeoJsonMultiPoint	有効な `GeoJSON MultiPoint` geometry 型。詳細については、 RFC 7946 を参照してください。
GeoJsonMultiPolygon	有効な `GeoJSON MultiPolygon` オブジェクト型。詳細については、 RFC 7946 を参照してください。
GeoJsonPoint	有効な `GeoJSON Point` geometry 型。詳細については、 RFC 7946 を参照してください。
GeoJsonPolygon	有効な `GeoJSON Polygon` geometry 型。詳細については、 RFC 7946 を参照してください。
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。

ClosestPoint

最も近いポイントの結果エントリオブジェクト

名前	型	説明
distanceInMeters	number	ソースポイントから最も近いポイントまでの距離 (メートル単位)
geometryId	string	一意の ID はジオメトリを識別します
position	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。

ClosestPointResponse

このオブジェクトは、成功した空間最近接ポイント呼び出しから返されます

名前	型	説明
result	ClosestPoint[]	最も近いポイントの結果配列
summary	ClosestPointSummary	最も近いポイントの概要オブジェクト

ClosestPointSummary

最も近いポイントの概要オブジェクト

名前	型	説明
information	string	情報の処理
sourcePoint	LatLongPairAbbreviated	短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。
udid	string	アップロードされたコンテンツの一意のデータ ID (udid)

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

GeoJsonFeature

有効な GeoJSON Feature オブジェクト型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
featureType	string	機能の種類です。この値は、現在の特徴が含まれるデータモデルによって異なります。一部のデータモデルには空の値が含まれる場合があります。
geometry	GeoJsonGeometry: GeoJsonGeometryCollection GeoJsonLineString GeoJsonMultiLineString GeoJsonMultiPoint GeoJsonMultiPolygon GeoJsonPoint GeoJsonPolygon	有効な `GeoJSON` geometry オブジェクト。この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。詳細については、 RFC 7946 を参照してください。
id	string	機能の識別子。
type	string: Feature	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonFeatureCollection

有効な GeoJSON FeatureCollection オブジェクト型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
features	GeoJsonFeature[]	有効な `GeoJSON Feature` オブジェクトの一覧を格納します。
type	string: FeatureCollection	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonGeometry

有効な GeoJSON geometry オブジェクト。この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。詳細については、 RFC 7946 を参照してください。

名前	型	説明
type	GeoJsonObjectType	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonGeometryCollection

有効な GeoJSON GeometryCollection オブジェクト型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
geometries	GeoJsonGeometry[]: GeoJsonGeometryCollection[] GeoJsonLineString[] GeoJsonMultiLineString[] GeoJsonMultiPoint[] GeoJsonMultiPolygon[] GeoJsonPoint[] GeoJsonPolygon[]	有効な `GeoJSON` geometry オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。
type	string: GeometryCollection	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonLineString

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

名前	型	説明
coordinates	number[]	ジオメトリの `GeoJson LineString` 座標。
type	string: LineString	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiLineString

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

名前	型	説明
coordinates	number[]	ジオメトリの `GeoJson MultiLineString` 座標。
type	string: MultiLineString	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiPoint

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

名前	型	説明
coordinates	number[]	ジオメトリの `GeoJson MultiPoint` 座標。
type	string: MultiPoint	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonMultiPolygon

有効な GeoJSON MultiPolygon オブジェクト型。詳細については、 RFC 7946 を参照してください。

名前	型	説明
coordinates	number[]	有効な `GeoJSON Polygon` オブジェクトの一覧を格納します。 GeoJSON の座標は x、y の順序 (経度、緯度) であることに注意してください。
type	string: MultiPolygon	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPoint

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

名前	型	説明
coordinates	number[]	は `Position` 、2 つ以上の要素を持つ数値の配列です。最初の 2 つの要素は経度と緯度で、正確にはその順序です。高度/標高は、省略可能な 3 番目の要素です。詳細については、 RFC 7946 を参照してください。
type	string: Point	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

GeoJsonPolygon

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

名前	型	説明
coordinates	number[]	ジオメトリタイプの `GeoJson Polygon` 座標。
type	string: Polygon	型を指定します `GeoJSON` 。 Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection、Feature、FeatureCollection の 9 つの有効な GeoJSON オブジェクトの種類のいずれかである必要があります。

JsonFormat

応答の目的の形式。サポートされているのは json 形式のみです。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式

LatLongPairAbbreviated

短い名前 'lat' & 'lon' を使用して緯度と経度として表される場所。

名前	型	説明
lat	number	Latitude プロパティ
lon	number	Longitude プロパティ

次の方法で共有