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.
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 https://atlas.microsoft.com/geocode:batch?api-version=2026-01-01
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Numero di versione dell'API mappe di Azure. |
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| x-ms-client-id |
string |
Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza di Azure AD. Rappresenta un ID univoco per l'account mappe di Azure e può essere recuperato dall'API dell'account del piano di gestione di Mappe di Azure. Per altre informazioni sull'uso della sicurezza dell'ID Microsoft Entra in Mappe di Azure, vedere 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 |
Va bene |
|
| Other Status Codes |
Errore imprevisto. |
Sicurezza
AADToken
Questi sono i flussi di Microsoft Entra OAuth 2.0. Se abbinato a l'accesso in base al ruolo di Azure controllarlo, può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.
Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.
Annotazioni
- Questa definizione di sicurezza richiede l'uso dell'intestazione
x-ms-client-idper indicare a quale risorsa di Mappe di Azure l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione di mappe . - Il
Authorization URLè specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni microsoft Entra ID. - Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
- L'utilizzo della Sdk Web di Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
- Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
| Nome | Descrizione |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Si tratta di una chiave condivisa di cui viene effettuato il provisioning durante la creazione di un risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
Con questa chiave, qualsiasi applicazione è autorizzata ad accedere a tutte le API REST. In altre parole, questi possono essere attualmente considerati chiavi master per l'account per cui vengono rilasciati.
Per le applicazioni esposte pubblicamente, è consigliabile usare l'accesso da server a server delle API REST di Mappe di Azure in cui questa chiave può essere archiviata in modo sicuro.
Tipo:
apiKey
In:
header
SAS Token
Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nell'risorsa di Mappe di Azure tramite il piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
Con questo token, qualsiasi applicazione è autorizzata ad accedere ai controlli di accesso in base al ruolo di Azure e al controllo granulare per la scadenza, la frequenza e le aree d'uso per il token specifico. In altre parole, il token di firma di accesso condiviso può essere usato per consentire alle applicazioni di controllare l'accesso in modo più protetto rispetto alla chiave condivisa.
Per le applicazioni esposte pubblicamente, è consigliabile configurare un elenco specifico di origini consentite nella risorsa account mappa per limitare l'abuso di rendering e rinnovare regolarmente il token di firma di accesso condiviso.
Tipo:
apiKey
In:
header
Esempio
A Geocoding Batch API call containing 2 Geocoding queries
Esempio di richiesta
POST https://atlas.microsoft.com/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 |
|
Admin |
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. |
|
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. |
|
Country |
Paese o regione con il suo nome e codice ISO. |
|
Error |
Informazioni aggiuntive sull'errore di gestione delle risorse. |
|
Error |
Dettagli dell'errore. |
|
Error |
Risposta di errore |
|
Feature |
Specifica il tipo di |
|
Features |
|
|
Feature |
Il tipo di una funzionalità deve essere Feature. |
|
Geocode |
Raccolta di punti di geocodice che differiscono in base alla modalità di calcolo e all'uso suggerito. |
|
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 |
|
|
Geo |
Tipo geometry |
| Intersection |
Indirizzo del risultato. |
|
Match |
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:
|
| Properties | |
| Summary |
Riepilogo per la richiesta batch |
|
Usage |
Uso ottimale per il punto di geocodifica.
Ogni punto di geocodice viene definito come punto |
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 |
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.
| 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 |
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 |
CountryRegion
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 |
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. |
ErrorResponse
Risposta di errore
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Oggetto error. |
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
FeatureTypeEnum
Il tipo di una funzionalità deve essere Feature.
| Valore | Descrizione |
|---|---|
| Feature |
Specifica il tipo di oggetto Feature |
GeocodePoints
Raccolta di punti di geocodice che differiscono in base alla modalità di calcolo e all'uso suggerito.
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
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Dettagli dell'errore. |
|
| features | ||
| 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 |
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
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 Good e Ambiguous indica che sono state trovate più di una posizione geografica per le informazioni sulla posizione e che il servizio di geocodice non disponeva di una gerarchia di ricerca per trovare una corrispondenza.
Analogamente, una posizione geocodificata con codici di corrispondenza di Ambiguous e UpHierarchy implica che non è stato possibile trovare una posizione geografica corrispondente a tutte le informazioni sulla posizione fornite, quindi il servizio di geocodifica doveva cercare nella gerarchia superiore e trovare più corrispondenze a tale livello. Un esempio di Ambiguous e UpHierarchy risultato è quando si forniscono informazioni complete sull'indirizzo, ma il servizio di geocodice non riesce a individuare una corrispondenza per l'indirizzo stradale e restituisce invece informazioni per più di un valore RoadBlock.
I valori possibili sono:
Good: la posizione ha una sola corrispondenza o tutte le corrispondenze restituite vengono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze valide.
Ambiguous: la posizione è una delle possibili corrispondenze. Ad esempio, quando si esegue una query per l'indirizzo 128 Main St., la risposta può restituire due posizioni per 128 North Main St. e 128 South Main St. perché non sono disponibili informazioni sufficienti per determinare quale opzione scegliere.
UpHierarchy: la posizione rappresenta uno spostamento verso l'alto della gerarchia geografica. Ciò si verifica quando non è stata trovata una corrispondenza per la richiesta di posizione, quindi viene restituito un risultato meno preciso. Ad esempio, se non è possibile trovare una corrispondenza per l'indirizzo richiesto, potrebbe essere restituito un codice di corrispondenza di UpHierarchy con un tipo di entità RoadBlock.
| Valore | Descrizione |
|---|---|
| Good | |
| Ambiguous | |
| UpHierarchy |
Properties
| 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 dei seguenti:
|
Summary
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 |
UsageTypeEnum
Uso ottimale per il punto di geocodifica.
Ogni punto di geocodice viene definito come punto Route, un punto Display o entrambi.
Usare Route punti se si sta creando una route per la posizione. Usare Display punti se viene visualizzata la posizione in una mappa. Ad esempio, se la posizione è un parco, un punto di Route può specificare un ingresso al parco in cui è possibile entrare con un'auto e un punto Display può essere un punto che specifica il centro del parco.
| Valore | Descrizione |
|---|---|
| Display | |
| Route |