Search - Get Geocoding Batch
Consente di inviare un batch di query all'API di geocodifica in un'unica richiesta.
L'API Get Geocoding Batch è una richiesta HTTP POST che invia batch di un massimo di 100 query all'API di geocodifica in un'unica richiesta.
Inviare una richiesta batch sincrona
L'API sincrona è consigliata per le richieste batch leggere. Quando il servizio riceve una richiesta, risponderà non appena vengono calcolati gli elementi batch e non sarà possibile recuperare i risultati in un secondo momento. L'API sincrona restituirà un errore di timeout (una risposta 408) se la richiesta richiede più di 60 secondi. Il numero di elementi batch è limitato a 100 per questa API.
POST https://atlas.microsoft.com/geocode:batch?api-version={api-version}
Corpo POST per la richiesta batch
Per inviare le query di geocodifica si utilizzerà una POST richiesta in cui il corpo della richiesta conterrà l'array batchItems in json formato e l'intestazione Content-Type sarà impostata su application/json. Di seguito è riportato un corpo della richiesta di esempio contenente 2 query di geocodifica :
{
"batchItems": [
{
"addressLine": "One, Microsoft Way, Redmond, WA 98052",
"top": 2
},
{
"addressLine": "Pike Pl",
"adminDistrict": "WA",
"locality": "Seattle",
"top": 3
}
]
}
Un oggetto batchItem di geocodifica può accettare qualsiasi parametro URI di geocodifica supportato.
Il batch deve contenere almeno 1 query.
Modello di risposta batch
La risposta batch contiene un componente summary che indica il totalRequests che faceva parte della richiesta batch originale e successfulRequests ad esempio le query eseguite correttamente. La risposta batch include anche una matrice di batchItems che contiene una risposta per ogni query e ogni query nella richiesta batch. Il batchItems conterrà i risultati nello stesso ordine in cui le query originali sono state inviate nella richiesta batch. Ogni elemento è di uno dei tipi seguenti:
GeocodingResponse: se la query è stata completata correttamente.Error: se la query non è riuscita. La risposta conterrà uncodee unmessagein questo caso.
POST {endpoint}/geocode:batch?api-version=2026-01-01
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
|
|
api-version
|
query | True |
string minLength: 1 |
Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| x-ms-client-id |
string |
Specifica quale account è destinato all'uso in combinazione con il modello di sicurezza di Azure AD. Rappresenta un ID unico per l'account Mappe di Azure e può essere recuperato dall'API Account del piano di gestione Mappe di Azure. Per maggiori informazioni sull'uso della sicurezza Microsoft Entra ID in Mappe di Azure, vedi Gestire l'autenticazione in Mappe di Azure. |
|
| Accept-Language |
string |
Lingua in cui devono essere restituiti i risultati della ricerca. Per informazioni dettagliate, vedere lingue supportate. |
Corpo della richiesta
| Nome | Tipo | Descrizione |
|---|---|---|
| batchItems |
Elenco di query da elaborare. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
La richiesta ha avuto esito positivo. |
|
| Other Status Codes |
Risposta di errore imprevista. Intestazioni x-ms-error-code: string |
Sicurezza
AadToken
Questi sono i flussi Microsoft Entra OAuth 2.0. Quando abbinata al controllo Azure basato su ruolo può essere utilizzata per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso basati su ruoli di Azure sono utilizzati per designare l'accesso a uno o più account o sottorisorse risorse di Mappe di Azure. Qualsiasi utente, gruppo o principale di servizio può ricevere l'accesso tramite un ruolo integrato o un ruolo personalizzato composto da uno o più permessi per Mappe di Azure API REST.\n\nPer implementare scenari, consigliamo di consultare i concetti di autenticazione . In sintesi, questa definizione di sicurezza fornisce una soluzione per modellare l'applicazione tramite oggetti in grado di controllo degli accessi su API e ambiti specifici.\n\n#### Note\n* Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale Mappe di Azure risorsa l'applicazione richiede accesso. Questo può essere acquisito dall'API di gestione Maps.\n* \nIl Authorization URL è specifico per l'istanza Azure cloud pubblico. I cloud sovrani hanno URL di autorizzazione unici e configurazioni Microsoft Entra ID. \n* \nIl controllo accessibile basato sul ruolo Azure viene configurato dal piano di gestione Azure tramite Azure portale, PowerShell, CLI, Azure SDK o API REST.\n* \nUtilizzo del Mappe di Azure Web SDK consente la configurazione di un'applicazione basata sulla configurazione per molteplici casi d'uso.\n* Per maggiori informazioni su Microsoft Identity Platform, vedi Microsoft Identity Platform panoramica.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
| Nome | Descrizione |
|---|---|
| https://atlas.microsoft.com/.default |
subscription-key
Questa è una chiave condivisa che viene fornita quando Crea un account Mappe di Azure nel portale Azure o utilizzando PowerShell, CLI, Azure SDK o API REST.\n\n Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere utilizzata come chiave master nell'account in cui vengono rilasciate.\n\n Per applicazioni pubblicamente esposte, la nostra raccomandazione è di utilizzare l'approccio
Tipo:
apiKey
In:
header
SAS Token
Questo token di firma di accesso condiviso viene creato dall'operazione List SAS sulla risorsa Mappe di Azure tramite il piano di gestione Azure tramite portale Azure, PowerShell, CLI, Azure SDK o API REST.\n\n Con questo token, qualsiasi applicazione è autorizzata ad accedere con Azure Controlli di accesso basati su ruoli e controllo sottile sulla scadenza, la velocità e la regione/i di utilizzo per il token specifico. In altre parole, il Token SAS può essere utilizzato per permettere alle applicazioni di controllare l'accesso in modo più sicuro rispetto alla chiave condivisa.\n\n Per applicazioni pubblicamente esposte, la nostra raccomandazione è di configurare una lista specifica di origini consentite sulla risorsa dell'account Map per limitare l'abuso di rendering e rinnovare regolarmente il token SAS.
Tipo:
apiKey
In:
header
Esempio
A Geocoding Batch API call containing 2 Geocoding queries
Esempio di richiesta
POST {endpoint}/geocode:batch?api-version=2026-01-01
{
"batchItems": [
{
"addressLine": "15127 NE 24th Street, Redmond, WA 98052",
"top": 2,
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
},
{
"query": "Pike Pl",
"locality": "Seattle",
"top": 3
}
]
}
Risposta di esempio
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B",
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"type": "Address",
"confidence": "High",
"matchCodes": [
"Good"
],
"address": {
"locality": "Redmond",
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"countryRegion": {
"ISO": "US",
"name": "United States"
},
"postalCode": "98052",
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"addressLine": "15127 NE 24th St"
},
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.138669,
47.630359
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display",
"Route"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.1387383,
47.630563
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.138669,
47.630359
]
},
"bbox": [
-122.14631082421619,
47.62649628242932,
-122.1310271757838,
47.634221717570675
]
}
]
},
{
"error": {
"code": "Conflicting Parameters",
"message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'locality' was passed"
}
}
]
}
Definizioni
| Nome | Descrizione |
|---|---|
| Address |
Indirizzo del risultato |
|
Address |
Nome della suddivisione nel paese o nell'area geografica per un indirizzo. |
|
Address |
Paese o regione con il suo nome e codice ISO. |
|
Azure. |
Oggetto error. |
|
Azure. |
Risposta contenente i dettagli dell'errore. |
|
Azure. |
Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors. |
|
Calculation |
Metodo usato per calcolare il punto di geocodifica. |
|
Confidence |
Il livello di attendibilità che il risultato della posizione geocodificata è una corrispondenza. Usare questo valore con il codice di corrispondenza per determinare per informazioni più complete sulla corrispondenza. L'attendibilità di una posizione geocodificata si basa su molti fattori, tra cui l'importanza relativa della posizione geocodificata e la posizione dell'utente, se specificato. |
|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
|
Error |
Dettagli dell'errore. |
|
Feature |
Specifica il tipo di |
|
Features |
Un oggetto caratteristica. |
|
Features |
Proprietà della caratteristica. |
|
Feature |
Il tipo di una funzionalità deve essere Feature. |
|
Geocode |
Un punto di geocodifica. |
|
Geocoding |
L'elenco delle query/richieste di geocodifica degli indirizzi da elaborare. L'elenco può contenere un massimo di 100 query e deve contenere almeno 1 query. |
|
Geocoding |
Oggetto Query batch |
|
Geocoding |
Questo oggetto viene restituito da una chiamata al servizio batch di geocodifica riuscita. |
|
Geocoding |
Un articolo a risposta a batch. |
|
Geocoding |
Riepilogo per la richiesta batch |
|
Geo |
Specifica il tipo di |
|
Geo |
Tipo geometry |
| Intersection |
Indirizzo del risultato. |
|
Match |
Un enum che rappresenta il codice di corrispondenza. |
|
Usage |
Un enum che rappresenta il tipo di uso. |
Address
Indirizzo del risultato
| Nome | Tipo | Descrizione |
|---|---|---|
| addressLine |
string |
AddressLine che include il nome della via e il numero civico |
| adminDistricts |
Nome della suddivisione nel paese o nell'area geografica per un indirizzo. Questo elemento viene in genere considerato come suddivisione amministrativa del primo ordine, ma in alcuni casi contiene anche la seconda, terza o quarta suddivisione dell'ordine in un paese, una dipendenza o un'area geografica. |
|
| countryRegion |
Paese o regione con il suo nome e codice ISO. |
|
| formattedAddress |
string |
Proprietà dell'indirizzo formattato |
| intersection |
Indirizzo del risultato. |
|
| locality |
string |
Proprietà della località |
| neighborhood |
string |
Proprietà del quartiere |
| postalCode |
string |
Proprietà del codice postale |
| streetName |
string |
Il nome della via da formattedAddress |
| streetNumber |
string |
Il numero nella via, se disponibile, da formattedAddress |
AddressAdminDistrictsItem
Nome della suddivisione nel paese o nell'area geografica per un indirizzo.
| Nome | Tipo | Descrizione |
|---|---|---|
| name |
string |
Nome per il campo adminDistrict corrispondente, Per adminDistrict[0], questo potrebbe essere il nome completo dello stato, ad esempio Washington, Per adminDistrict[1], potrebbe trattarsi del nome completo della contea |
| shortName |
string |
Nome breve per il campo adminDistrict corrispondente, Per adminDistrict[0], questo potrebbe essere il nome breve dello stato, ad esempio WA, Per adminDistrict[1], questo potrebbe essere il nome breve della contea |
AddressCountryRegion
Paese o regione con il suo nome e codice ISO.
| Nome | Tipo | Descrizione |
|---|---|---|
| ISO |
string |
ISO del paese/area geografica |
| name |
string |
nome del paese/area geografica |
Azure.Core.Foundations.Error
Oggetto error.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Uno di un set definito dal server di codici di errore. |
| details |
Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato. |
|
| innererror |
Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore. |
|
| message |
string |
Rappresentazione leggibile dell'errore. |
| target |
string |
Destinazione dell'errore. |
Azure.Core.Foundations.ErrorResponse
Risposta contenente i dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Oggetto error. |
Azure.Core.Foundations.InnerError
Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Uno di un set definito dal server di codici di errore. |
| innererror |
Errore interno. |
CalculationMethodEnum
Metodo usato per calcolare il punto di geocodifica.
| Valore | Descrizione |
|---|---|
| Interpolation |
Il punto di geocodifica è stato abbinato a un punto su una strada utilizzando l'interpolazione. |
| InterpolationOffset |
Il punto di geocodifica è stato abbinato a un punto di una strada utilizzando l'interpolazione con uno scostamento aggiuntivo per spostare il punto sul lato della strada. |
| Parcel |
Il punto di geocodifica è stato abbinato al centro di una particella. |
| Rooftop |
Il punto di geocodifica è stato abbinato al tetto di un edificio. |
ConfidenceEnum
Il livello di attendibilità che il risultato della posizione geocodificata è una corrispondenza. Usare questo valore con il codice di corrispondenza per determinare per informazioni più complete sulla corrispondenza.
L'attendibilità di una posizione geocodificata si basa su molti fattori, tra cui l'importanza relativa della posizione geocodificata e la posizione dell'utente, se specificato.
| Valore | Descrizione |
|---|---|
| High |
Se l'attendibilità è impostata su Se una richiesta include una posizione o una vista, la classificazione potrebbe cambiare in modo appropriato. Ad esempio, una query di posizione per "Parigi" restituisce "Parigi, Francia" e "Parigi, TX" entrambi con |
| Medium |
In alcune situazioni, la corrispondenza restituita potrebbe non essere allo stesso livello delle informazioni fornite nella richiesta. Ad esempio, una richiesta può specificare le informazioni sull'indirizzo e il servizio di geocodifica può essere in grado di corrispondere solo a un codice postale. In questo caso, se il servizio di geocodifica ha la certezza che il codice postale corrisponda ai dati, l'attendibilità viene impostata su Se le informazioni sulla posizione nella query sono ambigue e non sono disponibili informazioni aggiuntive per classificare le posizioni, ad esempio la posizione dell'utente o l'importanza relativa della posizione, l'attendibilità viene impostata su Se le informazioni sulla posizione nella query non forniscono informazioni sufficienti per la geocodifica di una posizione specifica, è possibile che venga restituito un valore di posizione meno preciso e che l'attendibilità venga impostata su |
| Low |
Low |
ErrorAdditionalInfo
Informazioni aggiuntive sull'errore di gestione delle risorse.
| Nome | Tipo | Descrizione |
|---|---|---|
| info |
object |
Informazioni aggiuntive. |
| type |
string |
Tipo di informazioni aggiuntive. |
ErrorDetail
Dettagli dell'errore.
| Nome | Tipo | Descrizione |
|---|---|---|
| additionalInfo |
Informazioni aggiuntive sull'errore. |
|
| code |
string |
Codice di errore. |
| details |
Dettagli dell'errore. |
|
| message |
string |
Messaggio di errore. |
| target |
string |
Destinazione dell'errore. |
FeatureCollectionEnum
Specifica il tipo di GeoJSON. L'unico tipo di oggetto supportato è FeatureCollection. Per altre informazioni, vedere RFC 7946.
| Valore | Descrizione |
|---|---|
| FeatureCollection |
Specifica il tipo di oggetto |
FeaturesItem
Un oggetto caratteristica.
FeaturesItemProperties
Proprietà della caratteristica.
| Nome | Tipo | Descrizione |
|---|---|---|
| address |
Indirizzo del risultato |
|
| confidence |
Il livello di attendibilità che il risultato della posizione geocodificata è una corrispondenza. Usare questo valore con il codice di corrispondenza per determinare per informazioni più complete sulla corrispondenza. L'attendibilità di una posizione geocodificata si basa su molti fattori, tra cui l'importanza relativa della posizione geocodificata e la posizione dell'utente, se specificato. |
|
| geocodePoints |
Raccolta di punti di geocodice che differiscono in base alla modalità di calcolo e all'uso suggerito. |
|
| matchCodes |
Uno o più valori di codice corrispondenti che rappresentano il livello di geocodifica per ogni posizione nella risposta. Ad esempio, una posizione geocodificata con codici di corrispondenza di Analogamente, una posizione geocodificata con codici di corrispondenza di I valori possibili sono:
|
|
| type |
string |
Uno di: * Indirizzo * Blocco stradale * Intersezione stradale * Quartiere * Luogo abitato * Codice postale1 * DivisioneAmministrativa1 * DivisioneAmministrativa2 * RegionePaese |
FeatureTypeEnum
Il tipo di una funzionalità deve essere Feature.
| Valore | Descrizione |
|---|---|
| Feature |
Specifica il tipo di oggetto Feature |
GeocodePointsItem
Un punto di geocodifica.
GeocodingBatchRequestBody
L'elenco delle query/richieste di geocodifica degli indirizzi da elaborare. L'elenco può contenere un massimo di 100 query e deve contenere almeno 1 query.
| Nome | Tipo | Descrizione |
|---|---|---|
| batchItems |
Elenco di query da elaborare. |
GeocodingBatchRequestItem
Oggetto Query batch
| Nome | Tipo | Valore predefinito | Descrizione |
|---|---|---|---|
| addressLine |
string |
La linea stradale ufficiale di un indirizzo relativo all'area, come specificato dalle proprietà località, o codice postale. L'uso tipico di questo elemento sarebbe quello di fornire un indirizzo stradale o qualsiasi indirizzo ufficiale. Questo parametro non deve essere utilizzato quando il |
|
| adminDistrict |
string |
La parte di suddivisione del paese di un indirizzo, ad esempio WA. Questo parametro non deve essere utilizzato quando il |
|
| adminDistrict2 |
string |
La contea per l'indirizzo strutturato, ad esempio King. Questo parametro non deve essere utilizzato quando il |
|
| adminDistrict3 |
string |
L'area denominata per l'indirizzo strutturato. Questo parametro non deve essere utilizzato quando il |
|
| bbox |
number[] (double) |
Area rettangolare sulla terra definita come oggetto rettangolo delimitatore. I lati dei rettangoli sono definiti dai valori di longitudine e latitudine. Per ulteriori informazioni, vedere Località e tipi di area. Quando si specifica questo parametro, l'area geografica viene presa in considerazione quando si calcolano i risultati di una query sulla posizione. Esempio: [lon1, lat1, lon2, lat2] |
|
| coordinates |
number[] (double) |
Un punto sulla terra specificato come longitudine e latitudine. Quando si specifica questo parametro, viene presa in considerazione la posizione dell'utente e i risultati restituiti possono essere più pertinenti per l'utente. Esempio: [lon, lat] |
|
| countryRegion |
string |
Segnale per il risultato della geocodifica a un codice regionale/paese ISO 3166-1 Alpha-2 specificato, ad es. FR. Questo parametro non deve essere utilizzato quando il |
|
| locality |
string |
La parte relativa alla località di un indirizzo, ad esempio Seattle. Questo parametro non deve essere utilizzato quando il |
|
| optionalId |
string |
id della richiesta che verrebbe visualizzato nel batchItem corrispondente |
|
| postalCode |
string |
La parte relativa al codice postale di un indirizzo. Questo parametro non deve essere utilizzato quando il |
|
| query |
string |
Stringa che contiene informazioni su una posizione, ad esempio un indirizzo o il nome di un punto di riferimento. |
|
| top |
integer (int32) minimum: 1maximum: 20 |
5 |
Numero massimo di risposte che verranno restituite. Impostazione predefinita: 5, minimo: 1 e massimo: 20. |
| view |
string |
auto |
Stringa che specifica un codice di regione/paese ISO 3166-1 Alpha-2. In questo modo verranno modificati i bordi e le etichette geopolitici contestati per allinearsi all'area utente specificata. |
GeocodingBatchResponse
Questo oggetto viene restituito da una chiamata al servizio batch di geocodifica riuscita.
| Nome | Tipo | Descrizione |
|---|---|---|
| batchItems |
Matrice contenente i risultati del batch. |
|
| nextLink |
string |
è il collegamento alla pagina successiva delle funzionalità restituite. Se si tratta dell'ultima pagina, nessun campo. |
| summary |
Riepilogo per la richiesta batch |
GeocodingBatchResponseItem
Un articolo a risposta a batch.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Dettagli dell'errore. |
|
| features |
Una serie di funzionalità restituite dalla query. |
|
| nextLink |
string |
è il collegamento alla pagina successiva delle funzionalità restituite. Se si tratta dell'ultima pagina, nessun campo. |
| optionalId |
string |
id del batchItem che sarebbe lo stesso dell'id nella richiesta |
| type |
Specifica il tipo di |
GeocodingBatchResponseSummary
Riepilogo per la richiesta batch
| Nome | Tipo | Descrizione |
|---|---|---|
| successfulRequests |
integer (int32) |
Numero di richieste riuscite nel batch |
| totalRequests |
integer (int32) |
Numero totale di richieste nel batch |
GeoJsonObjectType
Specifica il tipo di GeoJSON. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.
| Valore | Descrizione |
|---|---|
| Point |
|
| MultiPoint |
|
| LineString |
|
| MultiLineString |
|
| Polygon |
|
| MultiPolygon |
|
| GeometryCollection |
|
| Feature |
Oggetto |
| FeatureCollection |
Oggetto |
GeoJsonPoint
Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.
Intersection
Indirizzo del risultato.
| Nome | Tipo | Descrizione |
|---|---|---|
| baseStreet |
string |
Strada principale per la posizione. |
| displayName |
string |
Nome completo dell'intersezione. |
| intersectionType |
string |
Tipo di intersezione. |
| secondaryStreet1 |
string |
La prima strada che si interseca. |
| secondaryStreet2 |
string |
In caso affermativo, la seconda strada intersecante. |
MatchCodesEnum
Un enum che rappresenta il codice di corrispondenza.
| Valore | Descrizione |
|---|---|
| Good |
Bene |
| Ambiguous |
Ambiguous |
| UpHierarchy |
UpHierarchy |
UsageTypeEnum
Un enum che rappresenta il tipo di uso.
| Valore | Descrizione |
|---|---|
| Display |
Display |
| Route |
Itinerario |