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 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
coordinates
|
query | True |
number[] |
地球上指定為經度和緯度的點。 範例:&座標=lon,lat |
resolution
|
query |
解決方案決定要傳回的點數。 如果未指定,則預設值為中解析度。 |
||
result
|
query |
要傳回界限的地理政治概念。 如果未指定,則預設值為 |
||
view
|
query |
string |
表示 ISO 3166-1 Alpha-2 區域/國家/地區代碼的字串。 這會改變地緣政治爭議框線和標籤,以符合指定的用戶區域。 根據預設,View 參數會設定為 「Auto」,即使您尚未在要求中定義此參數也一樣。 如需詳細資訊,請參閱 支援的檢視 ,並查看可用的檢視。 |
要求標頭
名稱 | 必要 | 類型 | Description |
---|---|---|---|
x-ms-client-id |
string |
指定哪一個帳戶是與 Azure AD 安全性模型搭配使用。 它代表 Azure 地圖服務帳戶的唯一標識碼,而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 若要在 Azure 地圖服務中使用 Azure AD 安全性,請參閱下列 文章 以取得指引。 |
|
Accept-Language |
string |
應該傳回搜尋結果的語言。 如需詳細資訊,請參閱 支援的語言 。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
確定 Media Types: "application/geo+json" |
|
Other Status Codes |
發生意外錯誤。 Media Types: "application/geo+json" |
安全性
AADToken
這些是 entra OAuth 2.0 Flow Microsoft 。 與 Azure 角色型存 取控制配對時,可用來控制對 Azure 地圖服務 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。 任何使用者、群組或服務主體都可以透過內建角色或由一或多個 Azure 地圖服務 REST API 許可權組成的自定義角色來授與存取權。
若要實作案例,建議您檢視 驗證概念。 總而言之,此安全性定義提供一個解決方案,可透過能夠針對特定 API 和範圍進行存取控制的物件,將應用程式模型化 () 。
注意
- 此安全性定義 需要使用
x-ms-client-id
標頭來指出應用程式要求存取權的 Azure 地圖服務資源。 這可以從 地圖服務管理 API 取得。 -
Authorization URL
專屬於 Azure 公用雲端實例。 主權雲端具有唯一的授權 URL,Microsoft Entra ID 設定。 - 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 管理平面 設定 Azure 角色型存取控制。
- Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式。
- 如需Microsoft身分識別平臺的詳細資訊,請參閱 Microsoft身分識別平臺概觀。
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API 透過 Azure 管理平面建立 Azure 地圖服務資源 時所佈建的共用密鑰。
使用此金鑰時,任何應用程式都會獲得存取所有 REST API 的授權。 換句話說,這些目前可視為發行帳戶的主要密鑰。
對於公開的應用程式,我們建議使用 Azure 地圖服務 REST API 的伺服器對伺服器存取,以便安全地儲存此密鑰。
類型:
apiKey
位於:
header
SAS Token
這是透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API,從 Azure 地圖服務資源 上的清單 SAS 作業建立共用存取簽章令牌。
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並精細控制到期、速率和區域 (特定令牌的使用) 。 換句話說,SAS 令牌可用來允許應用程式以比共用密鑰更安全的方式控制存取。
對於公開的應用程式,我們建議在 地圖帳戶資源 上設定允許的來源特定清單,以限制轉譯濫用,並定期更新 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"
}
]
}
}
定義
名稱 | Description |
---|---|
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。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊 ,請參閱 RFC 7946 。 |
copyright |
string |
著作權字串。 |
copyrightURL |
string |
列出 Azure 地圖服務的許多數據提供者及其相關著作權資訊的 URL。 |
featureType |
string |
功能的類型。 值取決於目前功能所屬的數據模型。 某些數據模型可能會有空的值。 |
geometriesCopyright |
界限物件每個幾何的著作權資訊集合,順序相同。 |
|
geometry | GeoJsonGeometry: |
有效的 |
id |
string |
功能的標識碼。 |
name |
string |
與地理區域相關聯的名稱。 |
type |
string:
Feature |
指定 |
BoundaryResultTypeEnum
要傳回界限的地理政治概念。 如果未指定,則預設值為 countryRegion
結果類型。
名稱 | 類型 | Description |
---|---|---|
adminDistrict |
string |
國家/地區層級內的第一個系統管理層級,例如州或省。 |
adminDistrict2 |
string |
國家/地區層級內的第二個系統管理層級,例如縣/地區層級。 |
countryRegion |
string |
國家或地區。 |
locality |
string |
人類結算的集中區域,例如城市、城市或城市或城市。 |
neighborhood |
string |
填入位置的區段,通常是已知的,但通常具有不明確界限。 |
postalCode |
string |
最小的郵遞區編碼類別,例如郵遞區編碼。 |
postalCode2 |
string |
藉由匯總 postalCode 區域所建立的 postalCode 之後,下一個最大的郵遞區編碼類別目錄。 |
postalCode3 |
string |
藉由匯總 postalCode2 區域所建立的 postCode2 之後,下一個最大的郵遞區編碼類別目錄。 |
postalCode4 |
string |
藉由匯總 postalCode3 區域所建立的 postalCode3 之後,下一個最大的郵遞區編碼類別目錄。 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
名稱 | 類型 | Description |
---|---|---|
info |
object |
其他資訊。 |
type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
名稱 | 類型 | Description |
---|---|---|
additionalInfo |
錯誤其他資訊。 |
|
code |
string |
錯誤碼。 |
details |
錯誤詳細資料。 |
|
message |
string |
錯誤訊息。 |
target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
名稱 | 類型 | Description |
---|---|---|
error |
error 物件。 |
GeoJsonGeometry
有效的 GeoJSON
geometry 物件。 此類型必須是七個有效的 GeoJSON 幾何類型之一 - Point、MultiPoint、LineString、MultiLineString、Polygon、MultiPolygon 和 GeometryCollection。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊 ,請參閱 RFC 7946 。 |
type |
Geo |
指定 |
GeoJsonGeometryCollection
有效的 GeoJSON GeometryCollection
物件類型。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊 ,請參閱 RFC 7946 。 |
geometries | GeoJsonGeometry[]: |
包含有效的 |
type |
string:
Geometry |
指定 |
GeoJsonLineString
有效的 GeoJSON LineString
幾何類型。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊 ,請參閱 RFC 7946 。 |
coordinates |
number[] |
幾何座標 |
type |
string:
Line |
指定 |
GeoJsonMultiLineString
有效的 GeoJSON MultiLineString
幾何類型。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊 ,請參閱 RFC 7946 。 |
coordinates |
number[] |
幾何座標 |
type |
string:
Multi |
指定 |
GeoJsonMultiPoint
有效的 GeoJSON MultiPoint
幾何類型。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊 ,請參閱 RFC 7946 。 |
coordinates |
number[] |
幾何座標 |
type |
string:
Multi |
指定 |
GeoJsonMultiPolygon
有效的 GeoJSON MultiPolygon
物件類型。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊 ,請參閱 RFC 7946 。 |
coordinates |
number[] |
包含有效 |
type |
string:
Multi |
指定 |
GeoJsonPoint
有效的 GeoJSON Point
幾何類型。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊 ,請參閱 RFC 7946 。 |
coordinates |
number[] |
|
type |
string:
Point |
指定 |
GeoJsonPolygon
有效的 GeoJSON Polygon
幾何類型。 如需詳細資訊 ,請參閱 RFC 7946 。
名稱 | 類型 | Description |
---|---|---|
bbox |
number[] |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊 ,請參閱 RFC 7946 。 |
coordinates |
number[] |
|
type |
string:
Polygon |
指定 |
GeometryCopyright
Boundary 對象的幾何著作權資訊。
名稱 | 類型 | Description |
---|---|---|
copyright |
string |
數據提供者的著作權字串 |
sourceName |
string |
數據提供者的名稱 |
ResolutionEnum
解決方案決定要傳回的點數。 如果未指定,則預設值為中解析度。
名稱 | 類型 | Description |
---|---|---|
huge |
string |
傳回具有更多或相同點量的大小界限幾何。 |
large |
string |
傳回具有更多或相同點數量與中點的界限幾何。 |
medium |
string |
傳回具有更多或相同點數的界限幾何,其數量與小。 |
small |
string |
傳回具有最小點量的界限幾何。 |