Search - Get Polygon
を使用して、都市や国の地域などの地理的エリア図形の多角形データを取得します。
Get Polygon
API は、市区町村や国の地域などの地理的エリア アウトラインの多角形データを提供する HTTP GET
要求です。
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates={coordinates}&view={view}&resultType={resultType}&resolution={resolution}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
coordinates
|
query | True |
number[] |
経度と緯度として指定された地球上のポイント。 例: &coordinates=lon,lat |
resolution
|
query |
解決策は、返送するポイントの量を決定します。 指定しない場合、既定値は中解像度です。 |
||
result
|
query |
境界を返す地政学的概念。 指定しない場合、既定値は結果の種類です |
||
view
|
query |
string |
ISO 3166-1 Alpha-2 リージョン/国コードを表す文字列。 これにより、指定したユーザー領域に合わせて、地政学的な紛争の境界線とラベルが変更されます。 既定では、要求で定義していない場合でも、View パラメーターは "Auto" に設定されます。 詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-id |
string |
Azure AD セキュリティ モデルと組み合わせて使用するアカウントを指定します。 これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーン アカウント API から取得できます。 Azure Maps で Azure AD セキュリティを使用するには、ガイダンスについては、次 の記事を 参照してください。 |
|
Accept-Language |
string |
検索結果を返す言語。 詳細については、「 サポートされている言語 」を参照してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK Media Types: "application/geo+json" |
|
Other Status Codes |
予期しないエラーが発生しました。 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 とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。
注意
- このセキュリティ定義 では 、 ヘッダーを使用して、
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 リソース の List SAS 操作から作成される共有アクセス署名トークンです。
このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。 言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。
公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。
型:
apiKey
/:
header
例
Get polygon for a city at coordinates -122.204141,47.612560
要求のサンプル
GET https://atlas.microsoft.com/search/polygon?api-version=2023-06-01&coordinates=-122.204141,47.61256&resultType=locality&resolution=small
応答のサンプル
Content-Type: application/geo+json
{
"type": "Feature",
"geometry": {
"type": "GeometryCollection",
"geometries": [
{
"type": "Polygon",
"coordinates": [
[
[
-122.13035,
47.53502
],
[
-122.12882,
47.53567
],
[
-122.12638000000001,
47.535140000000006
],
[
-122.12378000000001,
47.53717
],
[
-122.12068000000001,
47.537620000000004
],
[
-122.12028000000001,
47.538000000000004
],
[
-122.11682,
47.537940000000006
],
[
-122.11527000000001,
47.53609
],
[
-122.11119000000001,
47.536080000000005
],
[
-122.11103000000001,
47.539280000000005
],
[
-122.10832,
47.539530000000006
],
[
-122.10830000000001,
47.54057
],
[
-122.11006,
47.54055
],
[
-122.10999000000001,
47.542640000000006
],
[
-122.11185,
47.54298000000001
],
[
-122.11183000000001,
47.54426
],
[
-122.1114,
47.543800000000005
],
[
-122.10936000000001,
47.54379
],
[
-122.10912,
47.54462
],
[
-122.10745000000001,
47.544830000000005
],
[
-122.10808000000002,
47.545190000000005
],
[
-122.10808000000002,
47.54656000000001
],
[
-122.10665000000002,
47.546580000000006
],
[
-122.10711,
47.544700000000006
],
[
-122.10530000000001,
47.54473
],
[
-122.1054,
47.546910000000004
],
[
-122.10434000000001,
47.54693
],
[
-122.10433,
47.544830000000005
],
[
-122.10056000000002,
47.544940000000004
],
[
-122.1007,
47.548500000000004
],
[
-122.10194000000001,
47.54849
],
[
-122.10194000000001,
47.54883
],
[
-122.10194000000001,
47.549510000000005
],
[
-122.10071,
47.54883
],
[
-122.10048,
47.54849
],
[
-122.10047000000002,
47.54883
],
[
-122.10038000000002,
47.55904
],
[
-122.09796000000001,
47.55923000000001
],
[
-122.09870000000001,
47.560570000000006
],
[
-122.09818000000001,
47.56248
],
[
-122.10011000000002,
47.56839
],
[
-122.09876000000001,
47.56884
],
[
-122.09942000000001,
47.569900000000004
],
[
-122.09782000000001,
47.56983
],
[
-122.09672,
47.58019
],
[
-122.09885000000001,
47.58666
],
[
-122.09796000000001,
47.59503
],
[
-122.09664000000001,
47.602230000000006
],
[
-122.09411000000001,
47.607240000000004
],
[
-122.09104,
47.610240000000005
],
[
-122.08366000000001,
47.615660000000005
],
[
-122.08008000000001,
47.61939
],
[
-122.07904,
47.62201
],
[
-122.07959000000001,
47.627520000000004
],
[
-122.08008000000001,
47.627520000000004
],
[
-122.09181000000001,
47.627520000000004
],
[
-122.09221000000001,
47.62717000000001
],
[
-122.09256,
47.627520000000004
],
[
-122.11094000000001,
47.62765
],
[
-122.11091,
47.636720000000004
],
[
-122.11091,
47.64609
],
[
-122.11431,
47.646060000000006
],
[
-122.11437000000001,
47.64533
],
[
-122.11597,
47.64374
],
[
-122.12254000000001,
47.638510000000004
],
[
-122.12542,
47.636720000000004
],
[
-122.12809000000001,
47.635200000000005
],
[
-122.13241000000001,
47.63515
],
[
-122.13234000000001,
47.63268
],
[
-122.13407000000001,
47.63156000000001
],
[
-122.13484000000001,
47.62935
],
[
-122.13626000000001,
47.62820000000001
],
[
-122.1372,
47.627860000000005
],
[
-122.14184000000002,
47.62787
],
[
-122.14321000000001,
47.62713
],
[
-122.14312000000001,
47.636720000000004
],
[
-122.14335000000001,
47.660590000000006
],
[
-122.1641,
47.66077000000001
],
[
-122.16453000000001,
47.646370000000005
],
[
-122.16797000000001,
47.64621
],
[
-122.19629,
47.64643
],
[
-122.19629,
47.64289
],
[
-122.19846000000001,
47.642860000000006
],
[
-122.19846000000001,
47.64242
],
[
-122.19982000000002,
47.6424
],
[
-122.20169000000001,
47.644600000000004
],
[
-122.20341,
47.643190000000004
],
[
-122.20818000000001,
47.6435
],
[
-122.21014000000001,
47.643130000000006
],
[
-122.20962000000002,
47.642920000000004
],
[
-122.20974000000001,
47.636720000000004
],
[
-122.21005000000001,
47.62107
],
[
-122.22268000000001,
47.62106000000001
],
[
-122.22268000000001,
47.62066
],
[
-122.22203,
47.620470000000005
],
[
-122.22282000000001,
47.619890000000005
],
[
-122.22142000000001,
47.618570000000005
],
[
-122.22248,
47.61838
],
[
-122.22271,
47.617200000000004
],
[
-122.22136,
47.617180000000005
],
[
-122.21985000000001,
47.61643
],
[
-122.22044000000001,
47.614470000000004
],
[
-122.22033,
47.603840000000005
],
[
-122.22043000000001,
47.59682
],
[
-122.21702,
47.59038
],
[
-122.21653,
47.59042
],
[
-122.21572,
47.588240000000006
],
[
-122.21067000000001,
47.58375
],
[
-122.20153,
47.57887
],
[
-122.20227000000001,
47.57864000000001
],
[
-122.20132000000001,
47.578770000000006
],
[
-122.20034000000001,
47.57822
],
[
-122.19901000000002,
47.57592
],
[
-122.19923000000001,
47.567460000000004
],
[
-122.20034000000001,
47.55962
],
[
-122.20072,
47.55966
],
[
-122.20114000000001,
47.557520000000004
],
[
-122.20119000000001,
47.54943
],
[
-122.20160000000001,
47.549440000000004
],
[
-122.20167000000001,
47.54883
],
[
-122.20200000000001,
47.54609000000001
],
[
-122.19676000000001,
47.54621
],
[
-122.19545000000001,
47.54609000000001
],
[
-122.19545000000001,
47.545750000000005
],
[
-122.19091000000002,
47.54580000000001
],
[
-122.1907,
47.54216
],
[
-122.18581,
47.542100000000005
],
[
-122.18116,
47.541140000000006
],
[
-122.17142000000001,
47.54086
],
[
-122.16987,
47.54008
],
[
-122.16797000000001,
47.540060000000004
],
[
-122.16554000000001,
47.54005
],
[
-122.16439000000001,
47.54281
],
[
-122.16433,
47.545480000000005
],
[
-122.15356000000001,
47.54538
],
[
-122.15359000000001,
47.541760000000004
],
[
-122.14280000000001,
47.541520000000006
],
[
-122.14288,
47.539370000000005
],
[
-122.13645000000001,
47.53826
],
[
-122.13035,
47.53502
]
],
[
[
-122.19957000000001,
47.58372000000001
],
[
-122.20448,
47.583830000000006
],
[
-122.20585000000001,
47.586780000000005
],
[
-122.19654000000001,
47.586740000000006
],
[
-122.19655000000002,
47.58379
],
[
-122.19957000000001,
47.58372000000001
]
]
]
}
]
},
"properties": {
"name": "Bellevue",
"copyright": "© 2022 Microsoft and its suppliers. This API and any results cannot be used or accessed without Microsoft's express written permission.",
"copyrightURL": "https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/",
"geometriesCopyright": [
{
"sourceName": "TOM",
"copyright": "TomTom"
}
]
}
}
定義
名前 | 説明 |
---|---|
Boundary |
通常、このサービスは Polygon または MultiPolygon サブタイプを持つ GeometryCollection を返します。 |
Boundary |
境界を返す地政学的概念。 指定しない場合、既定値は結果の種類です |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geo |
有効な |
Geometry |
Boundary オブジェクトのジオメトリの著作権情報。 |
Resolution |
解決策は、返送するポイントの量を決定します。 指定しない場合、既定値は中解像度です。 |
Boundary
GeoJSON GeocodingFeature
地理的領域の境界を記述する オブジェクト。 フィーチャーのジオメトリについては、 を使用して GeoJSON GeometryCollection
説明します。
通常、このサービスは Polygon または MultiPolygon サブタイプを持つ GeometryCollection を返します。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
copyright |
string |
copyright 文字列。 |
copyrightURL |
string |
Azure Maps のデータ プロバイダーの多くとその関連する著作権情報を一覧表示する URL。 |
featureType |
string |
機能の種類です。 この値は、現在の特徴が含まれるデータ モデルによって異なります。 一部のデータ モデルには空の値が含まれる場合があります。 |
geometriesCopyright |
Boundary オブジェクトの各ジオメトリの著作権情報のコレクションを、表示される順序と同じ順序で指定します。 |
|
geometry | GeoJsonGeometry: |
有効な |
id |
string |
機能の識別子。 |
name |
string |
地理的領域に関連付けられている名前。 |
type |
string:
Feature |
型を指定します |
BoundaryResultTypeEnum
境界を返す地政学的概念。 指定しない場合、既定値は結果の種類です countryRegion
。
名前 | 型 | 説明 |
---|---|---|
adminDistrict |
string |
州や都道府県など、国/地域レベル内の最初の管理レベル。 |
adminDistrict2 |
string |
国/地域レベル内の 2 番目の管理レベル (郡など)。 |
countryRegion |
string |
国または地域。 |
locality |
string |
都市、町、村など、人間の居住地の集中エリア。 |
neighborhood |
string |
通常はよく知られているが、多くの場合、不十分な境界を持つ、設定された場所のセクション。 |
postalCode |
string |
郵便番号などの最小の郵便番号カテゴリ。 |
postalCode2 |
string |
postalCode エリアを集計して作成された postalCode の後に次に大きい郵便番号カテゴリ。 |
postalCode3 |
string |
postalCode2 エリアを集計して作成された postalCode2 の後に次に大きい郵便番号カテゴリ。 |
postalCode4 |
string |
postalCode3 領域を集計して作成された postalCode3 の次に大きい郵便番号カテゴリ。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
GeoJsonGeometry
有効な GeoJSON
geometry オブジェクト。 この型は、Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon、GeometryCollection の 7 つの有効な GeoJSON ジオメトリ型のいずれかである必要があります。 詳細については、 RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
type |
Geo |
型を指定します |
GeoJsonGeometryCollection
有効な GeoJSON GeometryCollection
オブジェクト型。 詳細については、 RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
geometries | GeoJsonGeometry[]: |
有効な |
type |
string:
Geometry |
型を指定します |
GeoJsonLineString
有効な GeoJSON LineString
geometry 型。 詳細については、 RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
coordinates |
number[] |
ジオメトリの |
type |
string:
Line |
型を指定します |
GeoJsonMultiLineString
有効な GeoJSON MultiLineString
geometry 型。 詳細については、 RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
coordinates |
number[] |
ジオメトリの |
type |
string:
Multi |
型を指定します |
GeoJsonMultiPoint
有効な GeoJSON MultiPoint
geometry 型。 詳細については、 RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
coordinates |
number[] |
ジオメトリの |
type |
string:
Multi |
型を指定します |
GeoJsonMultiPolygon
有効な GeoJSON MultiPolygon
オブジェクト型。 詳細については、 RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
coordinates |
number[] |
有効な |
type |
string:
Multi |
型を指定します |
GeoJsonPoint
有効な GeoJSON Point
geometry 型。 詳細については、 RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
coordinates |
number[] |
は |
type |
string:
Point |
型を指定します |
GeoJsonPolygon
有効な GeoJSON Polygon
geometry 型。 詳細については、 RFC 7946 を参照してください。
名前 | 型 | 説明 |
---|---|---|
bbox |
number[] |
境界ボックス。 使用されるプロジェクション - EPSG:3857。 詳細については、 RFC 7946 を参照してください。 |
coordinates |
number[] |
ジオメトリタイプの |
type |
string:
Polygon |
型を指定します |
GeometryCopyright
Boundary オブジェクトのジオメトリの著作権情報。
名前 | 型 | 説明 |
---|---|---|
copyright |
string |
データ プロバイダーの著作権文字列 |
sourceName |
string |
データ プロバイダーの名前 |
ResolutionEnum
解決策は、返送するポイントの量を決定します。 指定しない場合、既定値は中解像度です。
名前 | 型 | 説明 |
---|---|---|
huge |
string |
より多くのポイントまたは同じ量の境界ジオメトリを返します。 |
large |
string |
中間と同じ量のポイントを持つ境界ジオメトリを返します。 |
medium |
string |
より多くの点または同じ量の境界ジオメトリを小さくして返します。 |
small |
string |
ポイントの量が最も少ない境界ジオメトリを返します。 |