Search - Get Reverse Geocoding Batch
用於在單個請求中向 反向地理編碼 API 發送一批查詢。
Get Reverse Geocoding Batch API 是 HTTP POST 要求,會使用單一要求,將最多 100 個 查詢批次傳送至 反向地理編碼 API。
提交同步批次要求
針對輕量型批次要求,建議使用同步 API。 當服務收到要求時,它會在計算批次專案后立即回應,且稍後將不可能擷取結果。 如果要求超過 60 秒,同步 API 會傳回逾時錯誤 (408 回應)。 批次項目的數目限制為此 API 100。
批次要求的 POST 本文
若要傳送 反向地理編碼 查詢,您將使用 POST 要求,其中要求本文會以 batchItems 格式包含 json 陣列,並將 Content-Type 標頭設定為 application/json。 以下是包含 2 反向地理編碼 查詢的範例要求本文:
{
"batchItems": [
{
"coordinates": [-122.128275, 47.639429],
"resultTypes": ["Address", "PopulatedPlace"]
},
{
"coordinates": [-122.341979399674, 47.6095253501216]
}
]
}
反向地理編碼 batchItem 物件可以接受任何支援的 反向地理編碼URI 參數。
批次至少應包含 1 查詢
批次回應模型
批次回應包含 summary 元件,指出屬於原始批次要求一部分的 totalRequests,以及成功執行的查詢 successfulRequests。 批次回應也包含 batchItems 數位列,其中包含批次要求中每個查詢的回應。
batchItems 會以與批次要求中傳送原始查詢完全相同的順序來包含結果。 每個專案都是下列其中一種類型:
GeocodingResponse- 如果查詢成功完成。Error- 如果查詢失敗。 在此案例中,回應會包含code和message。
POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2026-01-01
URI 參數
| 名稱 | 位於 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Azure 地圖服務 API 的版本號碼。 |
要求標頭
| 名稱 | 必要 | 類型 | Description |
|---|---|---|---|
| x-ms-client-id |
string |
指定要與 Azure AD 安全性模型搭配使用哪一個帳戶。 它代表 Azure 地圖服務帳戶的唯一標識碼,而且可以從 Azure 地圖服務管理平面帳戶 API 擷取。 如需在 Azure 地圖服務中使用 Microsoft Entra ID 安全性的詳細資訊,請參閱 在 Azure 地圖服務中管理驗證。 |
|
| Accept-Language |
string |
應該傳回搜尋結果的語言。 如需詳細資訊,請參閱 支援的語言。 |
要求本文
| 名稱 | 類型 | Description |
|---|---|---|
| batchItems |
要處理的查詢清單。 |
回應
| 名稱 | 類型 | Description |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
發生未預期的錯誤。 |
安全性
AADToken
這些是 Entra OAuth 2.0 流程
若要實作案例,建議您檢視
備註
- 此安全性定義 需要 使用
x-ms-client-id標頭來指出應用程式要求存取的 Azure 地圖服務資源。 這可以從 地圖管理 API取得。 -
Authorization URL專屬於 Azure 公用雲端實例。 主權雲端具有唯一的授權 URL,Microsoft Entra ID 設定。 - Azure 角色型訪問控制是從 azure 管理平面 設定, 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API。
- 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 地圖服務資源
使用此令牌時,任何應用程式都有權使用 Azure 角色型訪問控制進行存取,並更精細地控制特定令牌的到期、速率和區域。 換句話說,SAS 令牌可用來讓應用程式以比共用密鑰更安全的方式控制存取。
對於公開的應用程式,我們建議在 對應帳戶資源上設定允許的來源特定清單, 以限制轉譯濫用,並定期更新 SAS 令牌。
類型:
apiKey
位於:
header
範例
A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries
範例要求
POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2026-01-01
{
"batchItems": [
{
"coordinates": [
-122.138681,
47.630358
],
"resultTypes": [
"Address",
"PopulatedPlace"
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"coordinates": [
47.630358,
-122.138681
],
"optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
}
]
}
範例回覆
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"type": "Address",
"confidence": "Medium",
"matchCodes": [
"Good"
],
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"name": "Washington",
"shortName": "WA"
},
{
"name": "King County",
"shortName": "King Co."
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"formattedAddress": "2267 152nd Ave NE, Redmond, Washington 98052, United States",
"streetName": "152nd Ave NE",
"streetNumber": "2267",
"addressLine": "2267 152nd Ave NE"
},
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.128275,
47.639429
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display",
"Route"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.127028,
47.638545
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.128275,
47.639429
]
},
"bbox": [
-122.1359181505759,
47.63556628242932,
-122.1206318494241,
47.643291717570676
]
}
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"error": {
"code": "Bad Request",
"message": "The provided coordinates (-122.138681,47.630358) in coordinates field are invalid or out of range"
},
"optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
}
]
}
定義
| 名稱 | Description |
|---|---|
| Address |
結果的位址 |
|
Admin |
地址的國家或地區中的細分名稱。 此元素通常被視為第一個命令系統管理細分,但在某些情況下,它也會包含國家/地區、相依性或區域的第二、第三或第四個順序細分。 |
|
Calculation |
用來計算地理編碼點的方法。 |
|
Confidence |
地理編碼位置結果的信賴等級相符。 搭配比對程式代碼使用此值,以判斷比對的更完整資訊。 地理編碼位置的信心是以許多因素為基礎,包括地理編碼位置和使用者位置的相對重要性。如果指定的話。 |
|
Country |
國家或地區及其名稱和 ISO 代碼。 |
|
Error |
資源管理錯誤其他資訊。 |
|
Error |
錯誤詳細數據。 |
|
Error |
錯誤回應 |
|
Feature |
指定 |
|
Features |
|
|
Feature |
功能的類型必須是Feature。 |
|
Geocode |
地理編碼點的集合,其計算方式和建議的使用方式不同。 |
|
Geocoding |
此物件會從成功的地理編碼批次服務呼叫傳回。 |
|
Geocoding |
|
|
Geo |
有效的 |
| Intersection |
結果的位址。 |
|
Match |
一或多個比對程式代碼值,代表回應中每個位置的地理編碼層級。 例如,具有 同樣地,具有 可能的值為:
|
| Properties | |
|
Result |
指定回應中您想要的實體類型。 只會傳回您指定的類型。 如果點無法對應至您指定的實體類型,則回應中不會傳回任何位置資訊。 預設值是所有可能的實體。 從下列選項選取的實體類型逗號分隔清單。
這些實體類型會從最特定的實體排序到最不特定的實體。 找到多個實體類型的實體時,只會傳回最特定的實體。 例如,如果您將 Address 和 AdminDistrict1 指定為這兩種類型的實體類型和實體,則回應中只會傳回 Address 實體資訊。 |
|
Reverse |
要處理的反向地理編碼查詢/要求清單。 此清單最多可以包含100個查詢,且至少必須包含1個查詢。 |
|
Reverse |
Batch Query 物件 |
| Summary |
批次要求的摘要 |
|
Usage |
地理編碼點的最佳使用。
每個地理編碼點都會定義為 |
Address
結果的位址
| 名稱 | 類型 | Description |
|---|---|---|
| addressLine |
string |
包含街道名稱和號碼的 AddressLine |
| adminDistricts |
地址的國家或地區中的細分名稱。 此元素通常被視為第一個命令系統管理細分,但在某些情況下,它也會包含國家/地區、相依性或區域的第二、第三或第四個順序細分。 |
|
| countryRegion |
國家或地區及其名稱和 ISO 代碼。 |
|
| formattedAddress |
string |
格式化地址屬性 |
| intersection |
結果的位址。 |
|
| locality |
string |
Locality 屬性 |
| neighborhood |
string |
鄰里物業 |
| postalCode |
string |
郵遞區號屬性 |
| streetName |
string |
formattedAddress 中的街道名稱 |
| streetNumber |
string |
街道上的號碼(如果可用),來自 formattedAddress |
AdminDistricts
地址的國家或地區中的細分名稱。 此元素通常被視為第一個命令系統管理細分,但在某些情況下,它也會包含國家/地區、相依性或區域的第二、第三或第四個順序細分。
| 名稱 | 類型 | Description |
|---|---|---|
| name |
string |
對應 adminDistrict 字段的名稱,若為 adminDistrict[0],這可能是州名的完整名稱,例如 Washington、For adminDistrict[1],這可能是該縣的完整名稱 |
| shortName |
string |
對應 adminDistrict 字段的簡短名稱,針對 adminDistrict[0],這可能是州名稱的簡短名稱,例如 WA,對於 adminDistrict[1],這可能是縣的簡短名稱 |
CalculationMethodEnum
用來計算地理編碼點的方法。
| 值 | Description |
|---|---|
| Interpolation |
使用插值將地理編碼點與道路上的點進行匹配。 |
| InterpolationOffset |
地理編碼點使用插值與道路上的點進行匹配,並使用額外的偏移量將點移動到街道一側。 |
| Parcel |
地理編碼點已與宗地中心匹配。 |
| Rooftop |
地理編碼點與建築物的屋頂匹配。 |
ConfidenceEnum
地理編碼位置結果的信賴等級相符。 搭配比對程式代碼使用此值,以判斷比對的更完整資訊。
地理編碼位置的信心是以許多因素為基礎,包括地理編碼位置和使用者位置的相對重要性。如果指定的話。
| 值 | Description |
|---|---|
| High |
如果置信度設置為 如果請求包含位置或視圖,則排名可能會相應更改。 例如,對“Paris”的位置查詢會可靠地 |
| Medium |
在某些情況下,返回的匹配項可能與請求中提供的資訊不在同一級別。 例如,請求可以指定地址資訊,而地理編碼服務可能只能匹配郵遞郵遞編碼。 在這種情況下,如果地理編碼服務具有郵遞區編碼與數據匹配的置信度,則置信度設置為, 如果查詢中的位置資訊不明確,並且沒有其他資訊來對位置進行排名(例如使用者位置或位置的相對重要性),則置信度設定為 如果查詢中的位置資訊未提供足夠的資訊來對特定位置進行地理編碼,則可能會傳回不太精確的位置值,並將置信度設定為 |
| Low |
CountryRegion
國家或地區及其名稱和 ISO 代碼。
| 名稱 | 類型 | Description |
|---|---|---|
| ISO |
string |
國家/地區的 ISO |
| name |
string |
國家/地區名稱 |
ErrorAdditionalInfo
資源管理錯誤其他資訊。
| 名稱 | 類型 | Description |
|---|---|---|
| info |
object |
其他資訊。 |
| type |
string |
其他信息類型。 |
ErrorDetail
錯誤詳細數據。
| 名稱 | 類型 | Description |
|---|---|---|
| additionalInfo |
錯誤其他資訊。 |
|
| code |
string |
錯誤碼。 |
| details |
錯誤詳細資料。 |
|
| message |
string |
錯誤訊息。 |
| target |
string |
錯誤目標。 |
ErrorResponse
錯誤回應
| 名稱 | 類型 | Description |
|---|---|---|
| error |
error 物件。 |
FeatureCollectionEnum
指定 GeoJSON 類型。 唯一支援的物件類型是 FeatureCollection。 如需詳細資訊,請參閱 RFC 7946。
| 值 | Description |
|---|---|
| FeatureCollection |
指定 |
FeaturesItem
| 名稱 | 類型 | Description |
|---|---|---|
| bbox |
number[] (double) |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊,請參閱 RFC 7946。 |
| geometry |
有效的 |
|
| id |
string |
傳回之功能的標識碼 |
| properties | ||
| type |
功能的類型必須是Feature。 |
FeatureTypeEnum
功能的類型必須是Feature。
| 值 | Description |
|---|---|
| Feature |
指定feature物件類型 |
GeocodePoints
地理編碼點的集合,其計算方式和建議的使用方式不同。
| 名稱 | 類型 | Description |
|---|---|---|
| calculationMethod |
用來計算地理編碼點的方法。 |
|
| geometry |
有效的 |
|
| usageTypes |
地理編碼點的最佳使用。
每個地理編碼點都會定義為 |
GeocodingBatchResponse
此物件會從成功的地理編碼批次服務呼叫傳回。
| 名稱 | 類型 | Description |
|---|---|---|
| batchItems |
包含批次結果的陣列。 |
|
| nextLink |
string |
是傳回之功能下一頁的連結。 如果它是最後一頁,則沒有此欄位。 |
| summary |
批次要求的摘要 |
GeocodingBatchResponseItem
| 名稱 | 類型 | Description |
|---|---|---|
| error |
錯誤詳細數據。 |
|
| features | ||
| nextLink |
string |
是傳回之功能下一頁的連結。 如果它是最後一頁,則沒有此欄位。 |
| optionalId |
string |
batchItem 的 id,與請求中的 ID 相同 |
| type |
指定 |
GeoJsonPoint
有效的 GeoJSON Point 幾何類型。 如需詳細資訊,請參閱 RFC 7946。
| 名稱 | 類型 | Description |
|---|---|---|
| bbox |
number[] (double) |
周框方塊。 使用的投影 - EPSG:3857。 如需詳細資訊,請參閱 RFC 7946。 |
| coordinates |
number[] (double) |
|
| type |
string:
Point |
指定 |
Intersection
結果的位址。
| 名稱 | 類型 | Description |
|---|---|---|
| baseStreet |
string |
位置的主要街道。 |
| displayName |
string |
交集的完整名稱。 |
| intersectionType |
string |
交集的類型。 |
| secondaryStreet1 |
string |
第一條交集街道。 |
| secondaryStreet2 |
string |
如果有的話,第二個交集街道。 |
MatchCodesEnum
一或多個比對程式代碼值,代表回應中每個位置的地理編碼層級。
例如,具有 Good 和 Ambiguous 相符代碼的地理編碼位置表示找到多個地理位置資訊,而且地理編碼服務沒有搜尋上階層來尋找相符專案。
同樣地,具有 Ambiguous 和 UpHierarchy 相符碼的地理編碼位置表示找不到符合所有提供的位置資訊,因此地理編碼服務必須搜尋上階層,並在該層級找到多個相符專案。
Ambiguous 和 UpHierarchy 結果的範例是當您提供完整的地址資訊,但地理編碼服務找不到街址的相符專案,而是傳回多個 RoadBlock 值的資訊。
可能的值為:
Good:位置只有一個相符專案,或所有傳回的相符專案都會被視為強相符專案。 例如,紐約的查詢會傳回數個 Good 相符專案。
Ambiguous:位置是一組可能的相符專案。 例如,當您查詢街址 128 Main St.時,回應可能會傳回 128 北主街和 128 南主街的兩個位置,因為沒有足夠的資訊來判斷要選擇的選項。
UpHierarchy:位置代表向上移動地理階層。 當找不到位置要求的相符專案時,就會發生這種情況,因此會傳回較不精確的結果。 例如,如果找不到要求的位址相符專案,則可能會傳回具有 RoadBlock 實體類型的相符程式代碼 UpHierarchy。
| 值 | Description |
|---|---|
| Good | |
| Ambiguous | |
| UpHierarchy |
Properties
| 名稱 | 類型 | Description |
|---|---|---|
| address |
結果的位址 |
|
| confidence |
地理編碼位置結果的信賴等級相符。 搭配比對程式代碼使用此值,以判斷比對的更完整資訊。 地理編碼位置的信心是以許多因素為基礎,包括地理編碼位置和使用者位置的相對重要性。如果指定的話。 |
|
| geocodePoints |
地理編碼點的集合,其計算方式和建議的使用方式不同。 |
|
| matchCodes |
一或多個比對程式代碼值,代表回應中每個位置的地理編碼層級。 例如,具有 同樣地,具有 可能的值為:
|
|
| type |
string |
擇一:
|
ResultTypeEnum
指定回應中您想要的實體類型。 只會傳回您指定的類型。 如果點無法對應至您指定的實體類型,則回應中不會傳回任何位置資訊。 預設值是所有可能的實體。 從下列選項選取的實體類型逗號分隔清單。
- 位址
- 鄰里
- PopulatedPlace
- 郵遞區區編碼1
- AdminDivision1
- AdminDivision2
- 國家/地區
這些實體類型會從最特定的實體排序到最不特定的實體。 找到多個實體類型的實體時,只會傳回最特定的實體。 例如,如果您將 Address 和 AdminDistrict1 指定為這兩種類型的實體類型和實體,則回應中只會傳回 Address 實體資訊。
| 值 | Description |
|---|---|
| Address | |
| Neighborhood | |
| PopulatedPlace | |
| Postcode1 | |
| AdminDivision1 | |
| AdminDivision2 | |
| CountryRegion |
ReverseGeocodingBatchRequestBody
要處理的反向地理編碼查詢/要求清單。 此清單最多可以包含100個查詢,且至少必須包含1個查詢。
| 名稱 | 類型 | Description |
|---|---|---|
| batchItems |
要處理的查詢清單。 |
ReverseGeocodingBatchRequestItem
Batch Query 物件
| 名稱 | 類型 | Description |
|---|---|---|
| coordinates |
number[] (double) |
您要反向地理編碼之位置的座標。 範例:[lon,lat] |
| optionalId |
string |
將顯示在對應batchItem中的請求的id |
| resultTypes |
指定回應中您想要的實體類型。 只會傳回您指定的類型。 如果點無法對應至您指定的實體類型,則回應中不會傳回任何位置資訊。 預設值是所有可能的實體。 從下列選項選取的實體類型逗號分隔清單。
這些實體類型會從最特定的實體排序到最不特定的實體。 找到多個實體類型的實體時,只會傳回最特定的實體。 例如,如果您將 Address 和 AdminDistrict1 指定為這兩種類型的實體類型和實體,則回應中只會傳回 Address 實體資訊。 |
|
| view |
string |
指定 ISO 3166-1 Alpha-2 地區/國家/地區代碼的字串。 這將改變地緣政治爭議邊界和標籤,以配合指定的用戶區域。 |
Summary
批次要求的摘要
| 名稱 | 類型 | Description |
|---|---|---|
| successfulRequests |
integer (int32) |
批次中成功的要求數目 |
| totalRequests |
integer (int32) |
批次中的要求總數 |
UsageTypeEnum
地理編碼點的最佳使用。
每個地理編碼點都會定義為 Route 點、Display 點或兩者。
如果您要建立通往位置的路由,請使用 Route 點。 如果您要在地圖上顯示位置,請使用 Display 點。 例如,如果位置是公園,Route 點可能會指定可以用汽車進入的公園入口,而 Display 點可能是指定公園中心點。
| 值 | Description |
|---|---|
| Display | |
| Route |