你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Search - Get Reverse Geocoding Batch
用于在单个请求中将一批查询发送到 反向地理编码 API。
API Get Reverse Geocoding Batch
是一个 HTTP POST
请求,它使用单个请求将最多 100 个查询的批发送到 反向地理编码 API。
提交同步批处理请求
建议将同步 API 用于轻型批处理请求。 当服务收到请求时,它会在计算批处理项后立即响应,并且以后无法检索结果。 如果请求花费的时间超过 60 秒,同步 API 将 (408 响应) 返回超时错误。 此 API 的批处理项数限制为 100 。
POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01
批处理请求的 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=2023-06-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
api-version
|
query | True |
string |
Azure Maps API 的版本号。 |
请求头
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
x-ms-client-id |
string |
指定要与 Azure AD 安全模型一起使用的帐户。 它表示Azure Maps帐户的唯一 ID,可以从Azure Maps管理平面帐户 API 检索。 若要在 Azure Maps中使用 Azure AD 安全性,请参阅以下文章以获取指导。 |
|
Accept-Language |
string |
应返回搜索结果的语言。 有关详细信息,请参阅 支持的语言 。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
batchItems |
要处理的查询列表。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
Other Status Codes |
发生了意外错误。 |
安全性
AADToken
这些是 OAuth 2.0 流Microsoft Entra。 与 Azure 基于角色的访问控制配对后,它可用于控制对 Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。 可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体访问权限,以Azure Maps REST API。
若要实现方案,建议查看 身份验证概念。 总之,此安全定义提供了一个解决方案,用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。
注意
- 此安全定义需要使用
x-ms-client-id
标头来指示应用程序请求访问哪个Azure Maps资源。 这可以从 地图管理 API 获取。 Authorization URL
特定于 Azure 公有云实例。 主权云具有唯一的授权 URL 和Microsoft Entra ID配置。- Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。
- 使用 Azure Maps Web SDK 可以针对多个用例基于配置设置应用程序。
- 有关Microsoft 标识平台的详细信息,请参阅Microsoft 标识平台概述。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
这是在通过 Azure 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 创建Azure Maps资源时预配的共享密钥。
使用此密钥,任何应用程序都有权访问所有 REST API。 换句话说,这些密钥当前可以视为颁发它们的帐户的主密钥。
对于公开的应用程序,我们建议使用Azure Maps REST API 的服务器到服务器访问,其中可以安全地存储此密钥。
Type:
apiKey
In:
header
SAS Token
这是一个共享访问签名令牌,通过 Azure 管理平面通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 在Azure Maps资源上列出 SAS 操作创建。
使用此令牌,任何应用程序都有权使用 Azure 基于角色的访问控制进行访问,并精细控制特定令牌的过期、速率和区域 () 。 换句话说,SAS 令牌可用于允许应用程序以比共享密钥更安全的方式控制访问。
对于公开的应用程序,我们建议在 映射帐户资源 上配置允许的来源的特定列表,以限制呈现滥用,并定期续订 SAS 令牌。
Type:
apiKey
In:
header
示例
A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries
Sample Request
POST https://atlas.microsoft.com/reverseGeocode:batch?api-version=2023-06-01
{
"batchItems": [
{
"coordinates": [
-122.128275,
47.639429
],
"resultTypes": [
"Address",
"PopulatedPlace"
],
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"coordinates": [
-122.341979399674,
47.6095253501216
],
"optionalId": "6M9W39P12SNHGAIZ4JQ7F57NWJLV2BRYEQRD7OH7"
}
]
}
Sample Response
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"type": "Address",
"confidence": "High",
"matchCodes": [
"Good"
],
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
"addressLine": "1 Microsoft Way"
},
"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": "3K5O3Y832J2YV6D7XNGUSM4ECCUGDEFN172CJQNN",
"error": {
"code": "400 Bad Request",
"message": "The provided coordinates in query are invalid, out of range, or not in the expected format"
}
}
]
}
定义
名称 | 说明 |
---|---|
Address |
结果的地址 |
Admin |
地址所在国家或地区的细分名称。 此元素通常被视为第一个顺序管理细分,但在某些情况下,它还包含国家/地区、依赖项或区域中的第二、第三或第四个顺序细分。 |
Calculation |
用于计算地理编码点的方法。 |
Confidence |
地理编码位置结果为匹配的置信度级别。 将此值与匹配代码一起使用,以确定有关匹配的更完整信息。 地理编码位置的置信度基于许多因素,包括地理编码位置和用户位置的相对重要性(如果指定)。 |
Country |
|
Error |
资源管理错误附加信息。 |
Error |
错误详细信息。 |
Error |
错误响应 |
Feature |
FeatureCollection 对象的类型必须为 FeatureCollection。 |
Features |
|
Feature |
特征的类型必须为 Feature。 |
Geocode |
地理编码点的集合,它们在计算方式及其建议用途方面有所不同。 |
Geocoding |
此对象是从成功的地理编码 Batch 服务调用返回的。 |
Geocoding |
|
Geo |
有效的 |
Intersection |
结果的地址。 |
Match |
一个或多个表示响应中每个位置的地理编码级别的匹配代码值。 例如,匹配代码为 和 同样,匹配代码为 和 可能的值为:
|
Properties | |
Result |
指定响应中所需的实体类型。 将仅返回指定的类型。 如果点无法映射到指定的实体类型,则响应中不会返回任何位置信息。 默认值是所有可能的实体。 从以下选项中选择的实体类型的逗号分隔列表。
这些实体类型从最具体的实体到最不具体的实体进行排序。 找到多个实体类型的实体时,仅返回最具体的实体。 例如,如果将 Address 和 AdminDistrict1 指定为实体类型,并且为这两种类型都找到了实体,则响应中仅返回 Address 实体信息。 |
Reverse |
要处理的反向地理编码查询/请求的列表。 该列表最多可以包含 100 个查询,并且必须至少包含 1 个查询。 |
Reverse |
Batch Query 对象 |
Summary |
批处理请求摘要 |
Usage |
地理编码点的最佳用途。
每个地理编码点都定义为一个 |
Address
结果的地址
名称 | 类型 | 说明 |
---|---|---|
addressLine |
string |
包含街道名称和编号的 AddressLine |
adminDistricts |
地址所在国家或地区的细分名称。 此元素通常被视为第一个顺序管理细分,但在某些情况下,它还包含国家/地区、依赖项或区域中的第二、第三或第四个顺序细分。 |
|
countryRegion | ||
formattedAddress |
string |
带格式的地址属性 |
intersection |
结果的地址。 |
|
locality |
string |
locality 属性 |
neighborhood |
string |
邻里属性 |
postalCode |
string |
邮政编码属性 |
AdminDistricts
地址所在国家或地区的细分名称。 此元素通常被视为第一个顺序管理细分,但在某些情况下,它还包含国家/地区、依赖项或区域中的第二、第三或第四个顺序细分。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
相应 adminDistrict 字段的名称,对于 adminDistrict[0],可以是州的全名,例如 Washington,对于 adminDistrict[1],这可能是县的全名 |
shortName |
string |
对应 adminDistrict 字段的短名称,对于 adminDistrict[0],可以是州的短名称,例如 WA,对于 adminDistrict[1],这可能是县的短名称 |
CalculationMethodEnum
用于计算地理编码点的方法。
名称 | 类型 | 说明 |
---|---|---|
Interpolation |
string |
地理编码点已使用内插与道路上的点匹配。 |
InterpolationOffset |
string |
地理编码点与道路上的点匹配,使用内插和额外的偏移量将点移动到街道的一侧。 |
Parcel |
string |
地理编码点与地块的中心匹配。 |
Rooftop |
string |
地理编码点与建筑物的屋顶匹配。 |
ConfidenceEnum
地理编码位置结果为匹配的置信度级别。 将此值与匹配代码一起使用,以确定有关匹配的更完整信息。
地理编码位置的置信度基于许多因素,包括地理编码位置和用户位置的相对重要性(如果指定)。
名称 | 类型 | 说明 |
---|---|---|
High |
string |
如果置信度设置为 如果请求包含位置或视图,则排名可能会相应地更改。 例如,对“Paris”的位置查询将置信返回“法国巴黎”和“Paris, TX”。 |
Low |
string |
|
Medium |
string |
在某些情况下,返回的匹配项可能与请求中提供的信息不同。 例如,请求可以指定地址信息,而地理编码服务可能只能匹配邮政编码。 在这种情况下,如果地理编码服务确信邮政编码与数据匹配,则置信度设置为 如果查询中的位置信息不明确,并且没有其他信息对位置 (进行排名,例如用户位置或位置) 的相对重要性,则置信度设置为 如果查询中的位置信息未提供对特定位置进行地理编码的足够信息,可能会返回不太精确的位置值,并且置信度设置为 |
CountryRegion
名称 | 类型 | 说明 |
---|---|---|
ISO |
string |
国家/地区的 ISO |
name |
string |
国家/地区的名称 |
ErrorAdditionalInfo
资源管理错误附加信息。
名称 | 类型 | 说明 |
---|---|---|
info |
object |
其他信息。 |
type |
string |
其他信息类型。 |
ErrorDetail
错误详细信息。
名称 | 类型 | 说明 |
---|---|---|
additionalInfo |
错误附加信息。 |
|
code |
string |
错误代码。 |
details |
错误详细信息。 |
|
message |
string |
错误消息。 |
target |
string |
错误目标。 |
ErrorResponse
错误响应
名称 | 类型 | 说明 |
---|---|---|
error |
错误对象。 |
FeatureCollectionEnum
FeatureCollection 对象的类型必须为 FeatureCollection。
名称 | 类型 | 说明 |
---|---|---|
FeatureCollection |
string |
FeaturesItem
名称 | 类型 | 说明 |
---|---|---|
bbox |
number[] |
边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 RFC 7946 。 |
geometry |
有效的 |
|
id |
string |
返回的功能的 ID |
properties | ||
type |
特征的类型必须为 Feature。 |
FeatureTypeEnum
特征的类型必须为 Feature。
名称 | 类型 | 说明 |
---|---|---|
Feature |
string |
GeocodePoints
地理编码点的集合,它们在计算方式及其建议用途方面有所不同。
名称 | 类型 | 说明 |
---|---|---|
calculationMethod |
用于计算地理编码点的方法。 |
|
geometry |
有效的 |
|
usageTypes |
地理编码点的最佳用途。
每个地理编码点都定义为一个 |
GeocodingBatchResponse
此对象是从成功的地理编码 Batch 服务调用返回的。
名称 | 类型 | 说明 |
---|---|---|
batchItems |
包含批处理结果的数组。 |
|
nextLink |
string |
是指向返回的功能的下一页的链接。 如果是最后一页,则不使用此字段。 |
summary |
批处理请求摘要 |
GeocodingBatchResponseItem
名称 | 类型 | 说明 |
---|---|---|
error |
错误详细信息。 |
|
features | ||
nextLink |
string |
是指向返回的功能的下一页的链接。 如果是最后一页,则不使用此字段。 |
optionalId |
string |
batchItem 的 ID,与请求中的 ID 相同 |
type |
FeatureCollection 对象的类型必须为 FeatureCollection。 |
GeoJsonPoint
有效的 GeoJSON Point
几何类型。 有关详细信息,请参阅 RFC 7946 。
名称 | 类型 | 说明 |
---|---|---|
bbox |
number[] |
边界框。 使用的投影 - EPSG:3857。 有关详细信息,请参阅 RFC 7946 。 |
coordinates |
number[] |
是 |
type |
string:
Point |
指定 |
Intersection
结果的地址。
名称 | 类型 | 说明 |
---|---|---|
baseStreet |
string |
位置的主要街道。 |
displayName |
string |
交集的完整名称。 |
intersectionType |
string |
交集的类型。 |
secondaryStreet1 |
string |
第一条相交的街道。 |
secondaryStreet2 |
string |
如果有,则为第二条交叉街道。 |
MatchCodesEnum
一个或多个表示响应中每个位置的地理编码级别的匹配代码值。
例如,匹配代码为 和 Ambiguous
的Good
地理编码位置意味着已找到多个地理编码位置来获取位置信息,并且地理编码服务没有向上搜索来查找匹配项。
同样,匹配代码为 和 UpHierarchy
的Ambiguous
地理编码位置意味着找不到与所提供的所有位置信息匹配的地理编码位置,因此地理编码服务必须向上搜索层次结构并在该级别找到多个匹配项。 up 和 UpHierarchy
结果的一个Ambiguous
示例是,当你提供完整的地址信息,但地理编码服务找不到街道地址的匹配项,而是返回多个 RoadBlock 值的信息。
可能的值为:
Good
:该位置只有一个匹配项,或者所有返回的匹配项都被视为强匹配项。 例如,纽约的查询返回多个 Good 匹配项。
Ambiguous
:位置是一组可能的匹配项之一。 例如,当您查询街道地址 128 Main St.时,响应可能会返回 128 北主街和 128 南主街的两个位置,因为没有足够的信息来确定要选择的选项。
UpHierarchy
:位置表示地理层次结构的上移。 当未找到与位置请求匹配项时,将返回不太精确的结果时,就会发生这种情况。 例如,如果找不到所请求地址的匹配项,则可能会返回具有 RoadBlock 实体类型的 匹配代码 UpHierarchy
。
名称 | 类型 | 说明 |
---|---|---|
Ambiguous |
string |
|
Good |
string |
|
UpHierarchy |
string |
Properties
名称 | 类型 | 说明 |
---|---|---|
address |
结果的地址 |
|
confidence |
地理编码位置结果匹配的置信度。 将此值与匹配代码一起使用,以确定有关匹配的更完整信息。 地理编码位置的置信度取决于许多因素,包括地理编码位置和用户位置的相对重要性(如果指定)。 |
|
geocodePoints |
地理编码点的集合,它们在计算方式及其建议用途方面有所不同。 |
|
matchCodes |
一个或多个匹配代码值,表示响应中每个位置的地理编码级别。 例如,匹配代码为 和 同样,匹配代码为 和 可能的值为:
|
|
type |
string |
下列其中一项:
|
ResultTypeEnum
指定响应中所需的实体类型。 将仅返回指定的类型。 如果点无法映射到指定的实体类型,则响应中不会返回任何位置信息。 默认值是所有可能的实体。 从以下选项中选择的实体类型的逗号分隔列表。
- 地址
- 邻近区域
- PopulatedPlace
- Postcode1
- AdminDivision1
- AdminDivision2
- CountryRegion
这些实体类型从最具体的实体到最不具体的实体进行排序。 找到多个实体类型的实体时,仅返回最具体的实体。 例如,如果将 Address 和 AdminDistrict1 指定为实体类型,并且为这两种类型都找到了实体,则响应中仅返回 Address 实体信息。
名称 | 类型 | 说明 |
---|---|---|
Address |
string |
|
AdminDivision1 |
string |
|
AdminDivision2 |
string |
|
CountryRegion |
string |
|
Neighborhood |
string |
|
PopulatedPlace |
string |
|
Postcode1 |
string |
ReverseGeocodingBatchRequestBody
要处理的反向地理编码查询/请求的列表。 该列表最多可以包含 100 个查询,并且必须至少包含 1 个查询。
名称 | 类型 | 说明 |
---|---|---|
batchItems |
要处理的查询的列表。 |
ReverseGeocodingBatchRequestItem
Batch Query 对象
名称 | 类型 | 说明 |
---|---|---|
coordinates |
number[] |
要反向进行地理编码的位置的坐标。 示例:[lon,lat] |
optionalId |
string |
将在相应 batchItem 中显示的请求的 ID |
resultTypes |
指定响应中所需的实体类型。 将仅返回指定的类型。 如果点无法映射到指定的实体类型,则响应中不会返回任何位置信息。 默认值是所有可能的实体。 从以下选项中选择的实体类型的逗号分隔列表。
这些实体类型从最具体的实体到最不具体的实体进行排序。 找到多个实体类型的实体时,仅返回最具体的实体。 例如,如果将 Address 和 AdminDistrict1 指定为实体类型,并且为这两种类型都找到了实体,则响应中仅返回 Address 实体信息。 |
|
view |
string |
一个指定 ISO 3166-1 Alpha-2 区域/国家/地区代码的字符串。 这将更改地缘政治争议边界和标签,以与指定的用户区域保持一致。 |
Summary
批处理请求摘要
名称 | 类型 | 说明 |
---|---|---|
successfulRequests |
integer |
批处理中成功的请求数 |
totalRequests |
integer |
批处理中的请求总数 |
UsageTypeEnum
地理编码点的最佳用途。
每个地理编码点都定义为一个 Route
点和/或一个 Display
点。
如果要创建指向该位置的路由,请使用 Route
点。 如果要在地图上显示位置,请使用 Display
点。 例如,如果位置是公园,则 Route
点可以指定公园的入口,你可以用汽车进入,而 Display
点可能是指定公园中心的点。
名称 | 类型 | 说明 |
---|---|---|
Display |
string |
|
Route |
string |