Search - Get Reverse Geocoding Batch
Se usa para enviar un lote de consultas a la API de geocodificación inversa en una sola solicitud.
La API de Get Reverse Geocoding Batch es una solicitud de POST HTTP que envía lotes de hasta 100 consultas a API de geocodificación inversa mediante una sola solicitud.
Enviar solicitud por lotes sincrónica
Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API.
POST https://atlas.microsoft.com/reverseGeocode:batch?api-version={api-version}
Cuerpo POST para solicitud por lotes
Para enviar las consultas de de geocodificación inversa
{
"batchItems": [
{
"coordinates": [-122.128275, 47.639429],
"resultTypes": ["Address", "PopulatedPlace"]
},
{
"coordinates": [-122.341979399674, 47.6095253501216]
}
]
}
Un objeto geocodificación inversa batchItem puede aceptar cualquiera de los parámetros de geocodificación inversa admitidos URI.
El lote debe contener al menos 1 consulta de.
Modelo de respuesta por lotes
La respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequests es decir, las consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una matriz de batchItems que contiene una respuesta para cada consulta y cada consulta de la solicitud por lotes. El batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento es de uno de los siguientes tipos:
GeocodingResponse: si la consulta se completó correctamente.Error: si se produjo un error en la consulta. La respuesta contendrá uncodey unmessageen este caso.
POST {endpoint}/reverseGeocode:batch?api-version=2026-01-01
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
api-version
|
query | True |
string minLength: 1 |
Versión de API que se usará para esta operación. |
Encabezado de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| x-ms-client-id |
string |
Especifica qué cuenta está destinada a usarse junto con el modelo de seguridad de Azure AD. Representa un ID único para la cuenta de Azure Maps y puede recuperarse desde la API de cuentas de Azure Maps Management Plane. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps. |
|
| Accept-Language |
string |
Idioma en el que se deben devolver los resultados de la búsqueda. Consulte idiomas admitidos para obtener más información. |
Cuerpo de la solicitud
| Nombre | Tipo | Description |
|---|---|---|
| batchItems |
Lista de consultas que se van a procesar. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La solicitud se ha realizado correctamente. |
|
| Other Status Codes |
Una respuesta de error inesperada. Encabezados x-ms-error-code: string |
Seguridad
AadToken
Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Cualquier usuario, grupo o principal de servicio puede recibir acceso mediante un rol incorporado o un rol personalizado compuesto por uno o más permisos para Azure Maps APIs REST.\n\nPara implementar escenarios, recomendamos consultar conceptos autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones(es) mediante objetos capaces de control de acceso en APIs y ámbitos específicos.\n\n#### Notas\n* Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso Azure Maps solicita acceso la aplicación. Esto puede obtenerse de la API de gestión Maps.\n* \nEl Authorization URL es específico para la instancia Azure nube pública. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. \n* \nEl control de acceso basado en roles Azure se configura desde el plano de gestión Azure a través de Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n* \nUso del Azure Maps Web SDK permite la configuración de una aplicación para múltiples casos de uso.\n* Para más información sobre Plataforma de identidad de Microsoft, véase Plataforma de identidad de Microsoft visión general.
Tipo:
oauth2
Flujo:
implicit
Dirección URL de autorización:
https://login.microsoftonline.com/common/oauth2/authorize
Ámbitos
| Nombre | Description |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Esta es una clave compartida que se provisiona cuando Crea una cuenta Azure Maps en el portal Azure o usando PowerShell, CLI, SDK de Azure o REST API.\n\n Con esta clave, cualquier aplicación puede acceder a toda la API REST. En otras palabras, esta clave puede usarse como una llave maestra en la cuenta en la que se emiten.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es utilizar el enfoque
Tipo:
apiKey
En:
header
SAS Token
Este token de firma de acceso compartido se crea a partir de la operación List SAS en el recurso Azure Maps a través del plano de gestión de Azure mediante Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n\n Con este token, cualquier aplicación está autorizada para acceder con Azure controles de acceso basados en roles y control detallado de la expiración, tasa y región(es) de uso para el token en particular. En otras palabras, el Token SAS puede usarse para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta Map para limitar el abuso de renderizado y renovar regularmente el Token SAS.
Tipo:
apiKey
En:
header
Ejemplos
A Reverse Geocoding Batch API call containing 2 Reverse Geocoding queries
Solicitud de ejemplo
POST {endpoint}/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"
}
]
}
Respuesta de muestra
{
"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"
}
]
}
Definiciones
| Nombre | Description |
|---|---|
| Address |
Dirección del resultado |
|
Address |
Nombre de subdivisión en el país o región de una dirección. |
|
Address |
País o región con su nombre y código ISO. |
|
Azure. |
Objeto de error. |
|
Azure. |
Respuesta que contiene los detalles del error. |
|
Azure. |
Objeto que contiene información más específica sobre el error. Según las directrices de Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Calculation |
Método que se usó para calcular el punto de código geográfico. |
|
Confidence |
Nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia. La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica. |
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Feature |
Especifica el tipo de |
|
Features |
Un objeto de características. |
|
Features |
Propiedades de la característica. |
|
Feature |
El tipo de una característica debe ser Característica. |
|
Geocode |
Un punto de geocódigo. |
|
Geocoding |
Este objeto se devuelve de una llamada correcta al servicio Geocoding Batch. |
|
Geocoding |
Un artículo de respuesta por lotes. |
|
Geocoding |
Resumen de la solicitud por lotes |
|
Geo |
Especifica el tipo de |
|
Geo |
Un tipo de geometría |
| Intersection |
Dirección del resultado. |
|
Match |
Un enum que representa el código de coincidencia. |
|
Result |
Un enum que representa el tipo de resultado. |
|
Reverse |
Lista de consultas o solicitudes de geocodificación inversa que se van a procesar. La lista puede contener un máximo de 100 consultas y debe contener al menos 1 consulta. |
|
Reverse |
Batch Query (objeto) |
|
Usage |
Un enum que representa el tipo de uso. |
Address
Dirección del resultado
| Nombre | Tipo | Description |
|---|---|---|
| addressLine |
string |
AddressLine que incluye el nombre y el número de la calle |
| adminDistricts |
Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región. |
|
| countryRegion |
País o región con su nombre y código ISO. |
|
| formattedAddress |
string |
Propiedad de dirección con formato |
| intersection |
Dirección del resultado. |
|
| locality |
string |
Propiedad de localidad |
| neighborhood |
string |
Propiedad del vecindario |
| postalCode |
string |
Propiedad de código postal |
| streetName |
string |
El nombre de la calle de formattedAddress |
| streetNumber |
string |
El número en la calle, si está disponible, de formattedAddress |
AddressAdminDistrictsItem
Nombre de subdivisión en el país o región de una dirección.
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
El nombre del campo adminDistrict correspondiente, Para adminDistrict[0], este podría ser el nombre completo del estado, como Washington, For adminDistrict[1], podría ser el nombre completo del condado. |
| shortName |
string |
El nombre corto del campo adminDistrict correspondiente, Para adminDistrict[0], podría ser un nombre corto de estado como WA, For adminDistrict[1], podría ser el nombre corto del condado. |
AddressCountryRegion
País o región con su nombre y código ISO.
| Nombre | Tipo | Description |
|---|---|---|
| ISO |
string |
ISO del país o región |
| name |
string |
nombre del país o región |
Azure.Core.Foundations.Error
Objeto de error.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Uno de un conjunto definido por el servidor de códigos de error. |
| details |
Matriz de detalles sobre errores específicos que llevaron a este error notificado. |
|
| innererror |
Objeto que contiene información más específica que el objeto actual sobre el error. |
|
| message |
string |
Representación legible del error. |
| target |
string |
Destino del error. |
Azure.Core.Foundations.ErrorResponse
Respuesta que contiene los detalles del error.
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
Azure.Core.Foundations.InnerError
Objeto que contiene información más específica sobre el error. Según las directrices de Azure API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nombre | Tipo | Description |
|---|---|---|
| code |
string |
Uno de un conjunto definido por el servidor de códigos de error. |
| innererror |
Error interno. |
CalculationMethodEnum
Método que se usó para calcular el punto de código geográfico.
| Valor | Description |
|---|---|
| Interpolation |
El punto de geocodificación se hizo coincidir con un punto de una carretera mediante interpolación. |
| InterpolationOffset |
El punto de geocodificación se hizo coincidir con un punto de una carretera mediante interpolación con un desplazamiento adicional para desplazar el punto al lado de la calle. |
| Parcel |
El punto de geocodificación se ha hecho coincidir con el centro de una parcela. |
| Rooftop |
El punto de geocodificación se hizo coincidir con la azotea de un edificio. |
ConfidenceEnum
Nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia.
La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica.
| Valor | Description |
|---|---|
| High |
Si la confianza se establece en Si una solicitud incluye una ubicación o una vista, la clasificación puede cambiar adecuadamente. Por ejemplo, una consulta de ubicación para "París" devuelve "París, Francia" y "París, TX" con |
| Medium |
En algunas situaciones, es posible que la coincidencia devuelta no esté al mismo nivel que la información proporcionada en la solicitud. Por ejemplo, una solicitud puede especificar información de dirección y es posible que el servicio de geocodificación solo pueda coincidir con un código postal. En este caso, si el servicio de geocodificación tiene la confianza de que el código postal coincide con los datos, la confianza se establece en Si la información de ubicación de la consulta es ambigua y no hay información adicional para clasificar las ubicaciones (como la ubicación del usuario o la importancia relativa de la ubicación), la confianza se establece en Si la información de ubicación de la consulta no proporciona suficiente información para geocodificar una ubicación específica, es posible que se devuelva un valor de ubicación menos preciso y la confianza se establezca en |
| Low |
Low |
ErrorAdditionalInfo
Información adicional sobre el error de administración de recursos.
| Nombre | Tipo | Description |
|---|---|---|
| info |
object |
Información adicional. |
| type |
string |
Tipo de información adicional. |
ErrorDetail
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| additionalInfo |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Los detalles del error. |
|
| message |
string |
El mensaje de error. |
| target |
string |
Destino del error. |
FeatureCollectionEnum
Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, vea RFC 7946.
| Valor | Description |
|---|---|
| FeatureCollection |
Especifica el tipo de objeto |
FeaturesItem
Un objeto de características.
FeaturesItemProperties
Propiedades de la característica.
| Nombre | Tipo | Description |
|---|---|---|
| address |
Dirección del resultado |
|
| confidence |
Nivel de confianza de que el resultado de la ubicación geocodificada es una coincidencia. Use este valor con el código de coincidencia para determinar para obtener información más completa sobre la coincidencia. La confianza de una ubicación geocodificada se basa en muchos factores, incluida la importancia relativa de la ubicación geocodificada y la ubicación del usuario, si se especifica. |
|
| geocodePoints |
Colección de puntos de código geográfico que difieren en cómo se calcularon y su uso sugerido. |
|
| matchCodes |
Uno o varios valores de código coincidentes que representan el nivel de geocodificación para cada ubicación de la respuesta. Por ejemplo, una ubicación con codificación geográfica con códigos de coincidencia de Del mismo modo, una ubicación codificada geográficamente con códigos de coincidencia de Los valores posibles son:
|
|
| type |
string |
Uno de: * Dirección * Barrio de Carretera * Intersección de Carretera * Barrio * Lugar Poblado * Código Postal 1 * División Administrativa1 * División Administrativa2 * PaísRegión |
FeatureTypeEnum
El tipo de una característica debe ser Característica.
| Valor | Description |
|---|---|
| Feature |
Especifica el tipo de objeto feature de |
GeocodePointsItem
Un punto de geocódigo.
GeocodingBatchResponse
Este objeto se devuelve de una llamada correcta al servicio Geocoding Batch.
| Nombre | Tipo | Description |
|---|---|---|
| batchItems |
Matriz que contiene los resultados del lote. |
|
| nextLink |
string |
es el vínculo a la página siguiente de las características devueltas. Si es la última página, no hay este campo. |
| summary |
Resumen de la solicitud por lotes |
GeocodingBatchResponseItem
Un artículo de respuesta por lotes.
| Nombre | Tipo | Description |
|---|---|---|
| error |
Detalle del error. |
|
| features |
Una serie de características devueltas de la consulta. |
|
| nextLink |
string |
es el vínculo a la página siguiente de las características devueltas. Si es la última página, no hay este campo. |
| optionalId |
string |
id del batchItem que sería el mismo que el id de la solicitud |
| type |
Especifica el tipo de |
GeocodingBatchResponseSummary
Resumen de la solicitud por lotes
| Nombre | Tipo | Description |
|---|---|---|
| successfulRequests |
integer (int32) |
Número de solicitudes correctas en el lote |
| totalRequests |
integer (int32) |
Número total de solicitudes en el lote |
GeoJsonObjectType
Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.
| Valor | Description |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
Objeto |
| FeatureCollection |
Objeto |
GeoJsonPoint
Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.
Intersection
Dirección del resultado.
| Nombre | Tipo | Description |
|---|---|---|
| baseStreet |
string |
Calle principal para la ubicación. |
| displayName |
string |
Nombre completo de la intersección. |
| intersectionType |
string |
Tipo de intersección. |
| secondaryStreet1 |
string |
La primera intersección de la calle. |
| secondaryStreet2 |
string |
Si existe, la segunda calle que interseca. |
MatchCodesEnum
Un enum que representa el código de coincidencia.
| Valor | Description |
|---|---|
| Good |
Bueno |
| Ambiguous |
Ambigua |
| UpHierarchy |
UpHierarchy |
ResultTypeEnum
Un enum que representa el tipo de resultado.
| Valor | Description |
|---|---|
| Address |
Dirección |
| Neighborhood |
Vecindario |
| PopulatedPlace |
PopulatedPlace |
| Postcode1 |
Código postal1 |
| AdminDivision1 |
AdminDivision1 |
| AdminDivision2 |
AdminDivision2 |
| CountryRegion |
País/Región |
ReverseGeocodingBatchRequestBody
Lista de consultas o solicitudes de geocodificación inversa que se van a procesar. La lista puede contener un máximo de 100 consultas y debe contener al menos 1 consulta.
| Nombre | Tipo | Description |
|---|---|---|
| batchItems |
Lista de consultas que se van a procesar. |
ReverseGeocodingBatchRequestItem
Batch Query (objeto)
| Nombre | Tipo | Description |
|---|---|---|
| coordinates |
number[] (double) |
Coordenadas de la ubicación en la que desea invertir el código geográfico. Ejemplo: [lon,lat] |
| optionalId |
string |
id de la solicitud que se mostraría en batchItem correspondiente |
| resultTypes |
Especifique los tipos de entidad que desee en la respuesta. Solo se devolverán los tipos que especifique. Si el punto no se puede asignar a los tipos de entidad especificados, no se devuelve información de ubicación en la respuesta. El valor predeterminado es todas las entidades posibles. Lista separada por comas de tipos de entidad seleccionados de las siguientes opciones.
Estos tipos de entidad se ordenan de la entidad más específica a la entidad menos específica. Cuando se encuentran entidades de más de un tipo de entidad, solo se devuelve la entidad más específica. Por ejemplo, si especifica Address y AdminDistrict1 como tipos de entidad y entidades se encontraron para ambos tipos, solo se devuelve la información de la entidad Address en la respuesta. |
|
| view |
string |
Cadena que especifica un código de región/país ISO 3166-1 Alpha-2. Esto modificará los bordes y etiquetas disputados geopolíticas para alinearse con la región de usuario especificada. |
UsageTypeEnum
Un enum que representa el tipo de uso.
| Valor | Description |
|---|---|
| Display |
Mostrar |
| Route |
Route |