Search - Get Geocoding Batch

Servizio:: Maps

Versione API:: 2026-01-01

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à un code e un message in questo caso.

POST {endpoint}/geocode:batch?api-version=2026-01-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string (uri)	Il nome host del servizio Mappe di Azure. Usa `https://atlas.microsoft.com` per il cloud pubblico Azure. Per puntare a una specifica Mappe di Azure geografica o a una nuvola sovrana, vedi Mappe di Azure ambito geografico.
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.

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	GeocodingBatchRequestItem[]	Le query di geocodifica da elaborare in questo lotto. Ogni voce è una richiesta indipendente di geocodifica in avanti; Il servizio restituisce una voce corrispondente per `GeocodingBatchResponse.batchItems` ogni query, nello stesso ordine.

Risposte

Nome	Tipo	Descrizione
200 OK	GeocodingBatchResponse	La richiesta ha avuto esito positivo.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

200 OK

GeocodingBatchResponse

La richiesta ha avuto esito positivo.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

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. 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.

Note

Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per 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 unici 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

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning quando si Creare un account di Mappe di Azure nel portale di Azure o usando PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o l'API REST.

Con questa chiave, qualsiasi applicazione può accedere a tutte le API REST. In altre parole, questa chiave può essere usata come chiave master nell'account in cui vengono rilasciati.

Per le applicazioni esposte pubblicamente, è consigliabile usare l'approccio applicazioni client riservate per accedere alle API REST di Mappe di Azure in modo che la chiave possa 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

HTTP

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

Codice di stato:: 200

{
  "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	L'indirizzo di una posizione suggerita da geocodifica o autocompletamento, suddivisa in campi strutturati. La scarsità è normale: sono popolati solo i campi che l'entità risolta fornisce in mente. Ad esempio, `streetName` e `streetNumber` appaiono solo per indirizzi a livello strada, e `intersection` appaiono solo per i risultati degli incroci stradali.
AddressAdminDistrictsItem	Una suddivisione amministrativa che contiene un indirizzo. Ad esempio, uno stato, una provincia o una contea. Restituito come una voce nella matrice principale `Address.adminDistricts` , dove le voci sono ordinate dal più grossolano al più fine.
AddressCountryRegion	Il paese o la regione che contiene l'indirizzo, identificato dal nome visualizzato e dal codice paese ISO 3166-1 Alpha-2. Entrambi i campi possono essere omessi in una determinata risposta.
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
CalculationMethodEnum	Metodo usato per calcolare il punto di geocodifica.
ConfidenceEnum	Il livello di attendibilità che il risultato della posizione geocodificata è una corrispondenza. Usa questo valore insieme ai codici di corrispondenza per ottenere informazioni più complete sulla corrispondenza. La fiducia di una posizione geocodificata si basa su molti fattori, inclusa l'importanza relativa della posizione geocodificata e la posizione dell'utente, se specificata.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
FeatureCollectionEnum	Il `GeoJSON` tipo di oggetto utilizzato alla radice delle risposte riuscite delle operazioni di geocodifica diretta, geocodifica inversa e autocompletamento (incluse le loro varianti batch). L'unico valore è `FeatureCollection`, come definito nell'RFC 7946. `Get Polygon` è l'unica eccezione: la sua radice di risposta è un `GeoJSON Feature`, vedi `FeatureTypeEnum`.
FeaturesItem	Una singola voce nell'array `features` di un `GeocodingResponse`, conforme alla forma dell'oggetto `GeoJSON Feature` . Rappresenta una posizione geocodificata: dati strutturati su `properties`, una coordinata rappresentativa su `geometry`, e una scatola delimitatrice opzionale su `bbox`.
FeaturesItemProperties	Il `properties` payload di una caratteristica in un `GeocodingResponse`. Contiene gli indicatori di tipo di entità e di qualità di corrispondenza per la posizione geocodificata, i suoi componenti di indirizzo analizzati e uno o più punti di geocodice che collegano la posizione a coordinate specifiche.
FeatureTypeEnum	Il `GeoJSON` tipo di oggetto per `Feature` gli oggetti. Etichetta ogni voce all'interno dell'array `features` di una `FeatureCollection` risposta (geocodifica, geocodifica inversa, autocompletamento) e appare alla radice della `Get Polygon` risposta. L'unico valore è `Feature`, come definito nell'RFC 7946.
GeocodePointsItem	Un punto di geocodifica per una posizione: una coordinata più metadati che descrivono come il punto è stato calcolato (`calculationMethod`) e a cosa è più adatto (`usageTypes`). Una singola caratteristica di solito restituisce separati `Display` e `Route` punti, così che i chiamanti possano scegliere quella più adatta al compito.
GeocodingBatchRequestBody	L'organo richiedente per l'operazione `Get Geocoding Batch` . Trasporta una o più query di geocodifica individuali — comprese 1 e 100 — che il servizio elabora come singola chiamata e restituisce come array parallelo `batchItems` su `GeocodingBatchResponse`.
GeocodingBatchRequestItem	Una query di geocodifica all'interno di un `GeocodingBatchRequestBody.batchItems` array. Ogni elemento è una richiesta di geocodifica in avanti indipendente equivalente a una singola chiamata a `Get Geocoding`, espressa come campi piuttosto che come parametri di query URL. La posizione può essere fornita sia come stringa `query` libera sia come i campi strutturati sottostanti (`addressLine`, `locality`, `countryRegion`, i `adminDistrict` livelli, `postalCode`); queste due modalità di input sono mutuamente esclusive — quando `query` è impostato, i campi strutturati vengono ignorati.
GeocodingBatchResponse	Il corpo di risposta riuscito restituì da `Get Geocoding Batch`. Contiene un `summary` numero di query inviate riuscite più un `batchItems` array contenente una voce di risposta per ogni query nella richiesta, nello stesso ordine dell'array delle richieste `batchItems` .
GeocodingBatchResponseItem	Una singola voce all'interno `GeocodingBatchResponse.batchItems`di , che porta il risultato di una delle query dalla voce corrispondente `GeocodingBatchRequestBody.batchItems` . Le query riuscite emergono qui geocodificate `features` nella stessa forma di `GeocodingResponse`; query fallite emergono informazioni diagnostiche tramite `error` invece. Esattamente uno di `features` o `error` è popolata per ogni voce.
GeocodingBatchResponseSummary	Contiene i conteggi aggregati per una `Get Geocoding Batch` risposta: la dimensione del lotto inviato e quante delle sue query sono state elaborate con successo. Usato come tipo di `GeocodingBatchResponse.summary`.
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.
GeoJsonPoint	Tipo geometry `GeoJSON Point` valido. Per informazioni dettagliate, vedere RFC 7946.
Intersection	I dettagli dell'intersezione per un indirizzo si risolvono come un incrocio stradale — l'angolo dove si incontrano due o più strade con nome. Popolata solo quando l'entità risolta è un `RoadIntersection`; il genitore `Address.intersection` viene altrimenti omesso.
MatchCodesEnum	Un valore di codice di corrispondenza che indica come il servizio di geocodifica ha prodotto un determinato risultato di località. Il `matchCodes` campo su una caratteristica è un array di questi valori; combinali con `confidence` e `type` per valutare la qualità della corrispondenza.
UsageTypeEnum	L'uso previsto per un punto di geocodifica. Un punto di geocodice restituito dal servizio contiene uno o più tipi di utilizzo che indicano come un'applicazione client dovrebbe consumare il punto: ad esempio, visualizzare la posizione su una mappa rispetto al passaggio di un veicolo verso di essa.

Address

Oggetto

L'indirizzo di una posizione suggerita da geocodifica o autocompletamento, suddivisa in campi strutturati. La scarsità è normale: sono popolati solo i campi che l'entità risolta fornisce in mente. Ad esempio, streetName e streetNumber appaiono solo per indirizzi a livello strada, e intersection appaiono solo per i risultati degli incroci stradali.

Nome	Tipo	Descrizione
addressLine	string	La prima riga dell'indirizzo, tipicamente il nome e il numero della strada. Ad esempio: `"15127 NE 24th St"`.
adminDistricts	AddressAdminDistrictsItem[]	Le suddivisioni amministrative che contengono l'indirizzo, ordinate dal più grossolano al più raffinato. La prima voce è tipicamente la suddivisione di primo ordine (come uno stato degli Stati Uniti o una provincia canadese); Le voci successive coprono le suddivisioni più precise in cui il paese, la dipendenza o la regione le definisce (come una contea all'indice 1).
countryRegion	AddressCountryRegion	Il paese o la regione che contiene l'indirizzo, con il suo nome visualizzato e il codice paese ISO 3166-1 Alpha-2.
formattedAddress	string	L'indirizzo completo viene reso come una singola stringa leggibile dall'uomo, con i componenti uniti secondo le convenzioni del paese o della regione dell'indirizzo. Esempio: `"15127 NE 24th St, Redmond, WA 98052"`.
intersection	Intersection	I dettagli delle strade che si intersecano per l'indirizzo, popolati quando l'entità risolta è un `RoadIntersection` (ad esempio l'angolo di due strade nominate).
locality	string	La località in cui si trova l'indirizzo: di solito una città, un paese o un villaggio. Ad esempio: `"Redmond"`.
neighborhood	string	Il quartiere nominato all'interno della località, quando viene identificato.
postalCode	string	Il codice postale dell'indirizzo, quando viene definito. Esempio: `"98052"`.
streetName	string	La componente del nome stradale dell'indirizzo, quando l'entità risolta è un indirizzo a livello strada. Esempio: `"NE 24th St"`.
streetNumber	string	Il numero della casa o dell'edificio sulla strada, quando l'entità risolta è un indirizzo a livello strada. Esempio: `"15127"`.

AddressAdminDistrictsItem

Oggetto

Una suddivisione amministrativa che contiene un indirizzo. Ad esempio, uno stato, una provincia o una contea. Restituito come una voce nella matrice principale Address.adminDistricts , dove le voci sono ordinate dal più grossolano al più fine.

Nome	Tipo	Descrizione
name	string	Il nome completo del quartiere. Ad esempio, `"Washington"` per uno stato degli Stati Uniti o `"King County"` per una contea.
shortName	string	La forma abbreviata o abbreviata del nome della suddivisione, quando viene definita una. Ad esempio, `"WA"` per uno stato degli Stati Uniti. Le suddivisioni più fini spesso non hanno una forma breve distinta, nel qual caso `shortName` ripetizioni `name` (come `"King County"`).

AddressCountryRegion

Oggetto

Il paese o la regione che contiene l'indirizzo, identificato dal nome visualizzato e dal codice paese ISO 3166-1 Alpha-2. Entrambi i campi possono essere omessi in una determinata risposta.

Nome	Tipo	Descrizione
ISO	string	Il codice paese ISO 3166-1 Alpha-2 per il paese o la regione. Ad esempio, `"US"` per gli Stati Uniti, o `"GB"` per il Regno Unito.
name	string	Il nome visualizzato del paese o della regione. Ad esempio: `"Stati Uniti"`.

Azure.Core.Foundations.Error

Oggetto

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.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

Oggetto

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto

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	Azure.Core.Foundations.InnerError	Errore interno.

CalculationMethodEnum

Enumerazione

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

Enumerazione

Il livello di attendibilità che il risultato della posizione geocodificata è una corrispondenza. Usa questo valore insieme ai codici di corrispondenza per ottenere informazioni più complete sulla corrispondenza.

La fiducia di una posizione geocodificata si basa su molti fattori, inclusa l'importanza relativa della posizione geocodificata e la posizione dell'utente, se specificata.

Valore Descrizione

High

Valore	Descrizione
High	Se l'attendibilità è impostata su `High`, sono state trovate una o più corrispondenze forti. Più `High` corrispondenze di attendibilità vengono ordinate in ordine di classificazione in base all'importanza, se applicabile. Ad esempio, i punti di riferimento hanno importanza, ma gli indirizzi no. Se una richiesta include una posizione o una vista, la classifica può cambiare di conseguenza. Ad esempio, una query di posizione per "Paris" restituisce sia "Paris, France" che "Paris, TX" con `High` sicurezza. "Paris, France" viene sempre classificata al primo posto per importanza, a meno che la posizione dell'utente non indichi che l'utente si trova a Paris, TX, o che la vista mappa indichi che l'utente sta cercando in quell'area.
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 geocodice ha la certezza che il codice postale corrisponda ai dati, la fiducia viene impostata su `Medium` e il codice di corrispondenza è impostato per `UpHierarchy` indicare che il servizio non ha potuto corrispondere a tutte le informazioni e ha dovuto cercare verso l'alto nella gerarchia. 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 `Medium`. Ad esempio, una query di posizione per "148th Ave, Bellevue" può restituire sia "148th Ave SE" che "148th Ave NE" con `Medium` sicurezza. 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 `Medium`. Ad esempio, se viene fornito un indirizzo ma non si trova una corrispondenza per il numero della casa, il risultato del geocodice con un `RoadBlock` tipo di entità può essere restituito.
Low	Bassa fiducia nel match.

Se l'attendibilità è impostata su High, sono state trovate una o più corrispondenze forti. Più High corrispondenze di attendibilità vengono ordinate in ordine di classificazione in base all'importanza, se applicabile. Ad esempio, i punti di riferimento hanno importanza, ma gli indirizzi no.

Se una richiesta include una posizione o una vista, la classifica può cambiare di conseguenza. Ad esempio, una query di posizione per "Paris" restituisce sia "Paris, France" che "Paris, TX" con High sicurezza. "Paris, France" viene sempre classificata al primo posto per importanza, a meno che la posizione dell'utente non indichi che l'utente si trova a Paris, TX, o che la vista mappa indichi che l'utente sta cercando in quell'area.

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 geocodice ha la certezza che il codice postale corrisponda ai dati, la fiducia viene impostata su Medium e il codice di corrispondenza è impostato per UpHierarchy indicare che il servizio non ha potuto corrispondere a tutte le informazioni e ha dovuto cercare verso l'alto nella gerarchia.

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 Medium. Ad esempio, una query di posizione per "148th Ave, Bellevue" può restituire sia "148th Ave SE" che "148th Ave NE" con Medium sicurezza.

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 Medium. Ad esempio, se viene fornito un indirizzo ma non si trova una corrispondenza per il numero della casa, il risultato del geocodice con un RoadBlock tipo di entità può essere restituito.

Low

Bassa fiducia nel match.

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

FeatureCollectionEnum

Enumerazione

Il GeoJSON tipo di oggetto utilizzato alla radice delle risposte riuscite delle operazioni di geocodifica diretta, geocodifica inversa e autocompletamento (incluse le loro varianti batch). L'unico valore è FeatureCollection, come definito nell'RFC 7946. Get Polygon è l'unica eccezione: la sua radice di risposta è un GeoJSON Feature, vedi FeatureTypeEnum.

Valore	Descrizione
FeatureCollection	Il tipo di `GeoJSON FeatureCollection` oggetto. Compare come radice di ogni corpo di risposta di geocodifica, geocodifica inversa e autocompletamento riuscito. `Get Polygon` usa invece una `Feature` radice.

FeaturesItem

Oggetto

Una singola voce nell'array features di un GeocodingResponse, conforme alla forma dell'oggetto GeoJSON Feature . Rappresenta una posizione geocodificata: dati strutturati su properties, una coordinata rappresentativa su geometry, e una scatola delimitatrice opzionale su bbox.

Nome	Tipo	Descrizione
bbox	number[] (double)	Il rettangolo più piccolo allineato agli assi che contiene la geometria della struttura, nell'ordine WGS 84 di longitudine/latitudine. Codificato secondo `[westLon, southLat, eastLon, northLat]`RFC 7946, Sezione 5.
geometry	GeoJsonPoint	Il primario `GeoJSON Point` rappresenta la posizione geocodificata, con coordinate in ordine WGS 84 di longitudine/latitudine.
id	string	Un identificatore opzionale assegnato dal servizio per la funzione, quando disponibile.
properties	FeaturesItemProperties	Dati strutturati sulla posizione geocodificata, inclusi il tipo di entità, indicatori di qualità di corrispondenza, componenti di indirizzo e uno o più punti di geocodifica.
type	FeatureTypeEnum	Il tipo di `GeoJSON` oggetto. Sempre `Feature`, come definito nell'RFC 7946.

FeaturesItemProperties

Oggetto

Il properties payload di una caratteristica in un GeocodingResponse. Contiene gli indicatori di tipo di entità e di qualità di corrispondenza per la posizione geocodificata, i suoi componenti di indirizzo analizzati e uno o più punti di geocodice che collegano la posizione a coordinate specifiche.

Nome	Tipo	Descrizione
address	Address	L'indirizzo della posizione geocodificata, suddiviso in campi strutturati come località, codice postale, paese/regione e (quando disponibile) nome e numero della strada.
confidence	ConfidenceEnum	Quanto forte la posizione geocodificata corrisponde alla richiesta. Usalo `matchCodes` insieme per avere un'idea completa della qualità del match. Vedi `ConfidenceEnum` per la lista dei valori e i fattori che influenzano la valutazione.
geocodePoints	GeocodePointsItem[]	Uno o più punti di geocodice per la posizione, ciascuno segnato con il modo in cui è stato derivato (`calculationMethod`) e per cosa è più adatto (`usageTypes`). Ad esempio, `Display` per la posizione visiva su una mappa, o `Route` per l'uso come destinazione di navigazione.
matchCodes	MatchCodesEnum[]	Come il servizio di geocodifica ha prodotto questo risultato rispetto alla query: una corrispondenza diretta alla specificità richiesta (`Good`), uno di diversi candidati (`Ambiguous`), o un ritorno a un livello meno preciso della gerarchia geografica (`UpHierarchy`). Possono essere presenti più valori. Ad esempio, un `Ambiguous` abbinamento plus `UpHierarchy` indica che il servizio non poteva corrispondere alla specificità richiesta e trovava più corrispondenze a un livello più grossolano. Vedi `MatchCodesEnum` per le descrizioni per valore; combina con `confidence` per un quadro completo della qualità della corrispondenza.
type	string	Il tipo di entità a cui la posizione geocodificata ha risolto. Uno di: , , , , , , , , `AdminDivision2`, o `CountryRegion`. `Postcode1AdminDivision1PopulatedPlaceNeighborhoodRoadIntersectionRoadBlockAddress`

FeatureTypeEnum

Enumerazione

Il GeoJSON tipo di oggetto per Feature gli oggetti. Etichetta ogni voce all'interno dell'array features di una FeatureCollection risposta (geocodifica, geocodifica inversa, autocompletamento) e appare alla radice della Get Polygon risposta. L'unico valore è Feature, come definito nell'RFC 7946.

Valore	Descrizione
Feature	Il tipo di `GeoJSON Feature` oggetto. Appare su ogni Feature all'interno di una `FeatureCollection` risposta e alla radice della risposta `Get Polygon` .

GeocodePointsItem

Oggetto

Un punto di geocodifica per una posizione: una coordinata più metadati che descrivono come il punto è stato calcolato (calculationMethod) e a cosa è più adatto (usageTypes). Una singola caratteristica di solito restituisce separati Display e Route punti, così che i chiamanti possano scegliere quella più adatta al compito.

Nome	Tipo	Descrizione
calculationMethod	CalculationMethodEnum	Come è stato calcolato il punto. Ad esempio, si è agganciata sul tetto di un edificio o interpolata lungo una linea centrale della strada. Vedi `CalculationMethodEnum` per la lista dei valori.
geometry	GeoJsonPoint	La coordinata di questo punto geocodice è un `GeoJSON Point`, con valori in ordine WGS 84 di longitudine/latitudine.
usageTypes	UsageTypeEnum[]	A cosa è più adatto il punto di geocodifica — `Display` per la posizione visiva su una mappa o `Route` come destinazione di instradamento. Un punto può portare entrambi. Vedi `UsageTypeEnum` i dettagli per valore, incluso come ciascuno è posizionato per le caratteristiche con estensione non banale.

GeocodingBatchRequestBody

Oggetto

L'organo richiedente per l'operazione Get Geocoding Batch . Trasporta una o più query di geocodifica individuali — comprese 1 e 100 — che il servizio elabora come singola chiamata e restituisce come array parallelo batchItems su GeocodingBatchResponse.

Nome	Tipo	Descrizione
batchItems	GeocodingBatchRequestItem[]	Le query di geocodifica da elaborare in questo lotto. Ogni voce è una richiesta indipendente di geocodifica in avanti; Il servizio restituisce una voce corrispondente per `GeocodingBatchResponse.batchItems` ogni query, nello stesso ordine.

GeocodingBatchRequestItem

Oggetto

Una query di geocodifica all'interno di un GeocodingBatchRequestBody.batchItems array. Ogni elemento è una richiesta di geocodifica in avanti indipendente equivalente a una singola chiamata a Get Geocoding, espressa come campi piuttosto che come parametri di query URL. La posizione può essere fornita sia come stringa query libera sia come i campi strutturati sottostanti (addressLine, locality, countryRegion, i adminDistrict livelli, postalCode); queste due modalità di input sono mutuamente esclusive — quando query è impostato, i campi strutturati vengono ignorati.

Nome	Tipo	Valore predefinito	Descrizione
addressLine	string		La linea della strada dell'indirizzo, tipicamente il nome e il numero della strada, o qualsiasi altro indirizzo ufficiale a livello di strada. Ignorato quando `query` è impostato.
adminDistrict	string		La suddivisione amministrativa di primo ordine (come uno stato o una provincia) fornita come nome o codice breve. Per esempio, `"WA"` per Washington. Ignorato quando `query` è impostato.
adminDistrict2	string		La suddivisione amministrativa di secondo ordine (come una contea). Per esempio, `"King"` per la contea di King. Ignorato quando `query` è impostato.
adminDistrict3	string		La suddivisione amministrativa di terzo ordine (come un distretto, una parrocchia o un comune), dove il paese, la dipendenza o la regione lo definisce uno. Ignorato quando `query` è impostato.
bbox	number[] (double)		Una casella di delimitazione che estende la ricerca a un'area geografica rettangolare. Codificato come `[westLon, southLat, eastLon, northLat]` in WGS 84 in ordine di longitudine/latitudine, con ciascun lato che varia da circa `0.00001` gradi (~1 metro) fino all'intera estensione globale (`-180, -90` a `180, 90`).
coordinates	number[] (double)		Un punto sulla Terra, codificato come `[longitude, latitude]` nell'ordine WGS 84, veniva usato per biaisare i risultati verso la posizione dell'utente. Quando vengono forniti, i risultati più vicini a questo punto sono tipicamente più rilevanti per l'utente.
countryRegion	string		Un codice regionale/paese ISO 3166-1 Alpha-2 che estende la ricerca a un singolo paese o regione. Per esempio, `"FR"` per la Francia. Ignorato quando `query` è impostato.
locality	string		La componente località (città, paese o villaggio) dell'indirizzo. Ad esempio: `"Seattle"`. Ignorato quando `query` è impostato.
optionalId	string		Un identificatore opzionale fornito dal chiamante riecheggiava nella voce corrispondente come `GeocodingBatchResponseItem.optionalId`. Utile per correlare le risposte alle richieste tramite un identificatore stabile lato applicazione piuttosto che affidarsi solo alla posizione dell'array.
postalCode	string		La componente del codice postale dell'indirizzo. Ignorato quando `query` è impostato.
query	string		Una stringa libera che descrive la posizione da geocodificare, tipicamente un indirizzo o un nome di punto di riferimento. Quando impostato, i campi di localizzazione strutturati qui sotto (`addressLine`, `locality`, `countryRegion`, i `adminDistrict` livelli, `postalCode`) vengono ignorati.
top	integer (int32) minimum: 1 maximum: 20	5	Il numero massimo di risultati geocodificati è stato restituito per questa query. Di default è 5; Minimo 1, massimo 20.
view	string	auto	Un codice regionale/paese ISO 3166-1 Alpha-2 che identifica la regione la cui visione geopolitica dovrebbe essere applicata ai confini e alle etichette contestate nella risposta. Di default è `"auto"`, che seleziona la vista in base all'origine della richiesta. Vedi Viste supportate per i valori disponibili.

GeocodingBatchResponse

Oggetto

Il corpo di risposta riuscito restituì da Get Geocoding Batch. Contiene un summary numero di query inviate riuscite più un batchItems array contenente una voce di risposta per ogni query nella richiesta, nello stesso ordine dell'array delle richieste batchItems .

Nome	Tipo	Descrizione
batchItems	GeocodingBatchResponseItem[]	I risultati per query del lotto. Ogni voce corrisponde posizionalmente alla voce della richiesta nello stesso indice dell'array in `GeocodingBatchRequestBody.batchItems`. Le voci con `error` popolate rappresentano query fallite; le voci con `features` popolate rappresentano query che hanno avuto successo.
nextLink	string	Contiene l'URL per recuperare la pagina successiva dei risultati se la risposta è paginata. Questo è utile quando la risposta è troppo ampia per essere restituita in una singola chiamata, permettendo agli utenti di navigare tra più pagine di risultati.
summary	GeocodingBatchResponseSummary	Il totale del lotto è il conteggio complessivo, il totale delle query inviate e quante sono state completate con successo.

GeocodingBatchResponseItem

Oggetto

Una singola voce all'interno GeocodingBatchResponse.batchItemsdi , che porta il risultato di una delle query dalla voce corrispondente GeocodingBatchRequestBody.batchItems . Le query riuscite emergono qui geocodificate features nella stessa forma di GeocodingResponse; query fallite emergono informazioni diagnostiche tramite error invece. Esattamente uno di features o error è popolata per ogni voce.

Nome	Tipo	Descrizione
error	ErrorDetail	Informazioni diagnostiche per una query fallita all'interno del batch, il percorso di errore per voce che complementa il percorso di successo su `features`. Popolati solo quando l'ingresso non andava bene; vedi `ErrorDetail` per la forma per errore.
features	FeaturesItem[]	L'array di `GeoJSON Feature` oggetti geocodificati per la query di questa voce batch. Ognuna `Feature` rappresenta una singola posizione geocodificata con dettagli esposti tramite `properties` e la sua coordinata primaria tramite `geometry`. Popolati solo quando l'ingresso aveva successo.
nextLink	string	Contiene l'URL per recuperare la pagina successiva dei risultati se la risposta è paginata. Questo è utile quando la risposta è troppo ampia per essere restituita in una singola chiamata, permettendo agli utenti di navigare tra più pagine di risultati.
optionalId	string	L'identificatore fornito dal chiamante riecheggiava dal corrispondente `GeocodingBatchRequestItem.optionalId`. Popolati solo quando la richiesta ne forniva uno. Utile per la correlazione lato applicazione quando la posizione dell'array non è sufficiente.
type	FeatureCollectionEnum	Il `GeoJSON` tipo di oggetto del corpo di successo di questa voce. Sempre `FeatureCollection`, come definito nell'RFC 7946. Popolati solo quando l'ingresso aveva successo.

GeocodingBatchResponseSummary

Oggetto

Contiene i conteggi aggregati per una Get Geocoding Batch risposta: la dimensione del lotto inviato e quante delle sue query sono state elaborate con successo. Usato come tipo di GeocodingBatchResponse.summary.

Nome	Tipo	Descrizione
successfulRequests	integer (int32)	Il numero di query nel lotto che sono state elaborate con successo — quelle la cui voce di risposta in `GeocodingBatchResponse.batchItems` contiene `features` invece di `error`.
totalRequests	integer (int32)	Il numero totale di richieste inviate nel lotto. Sottrai `successfulRequests` per ottenere il numero di query fallite.

GeoJsonObjectType

Enumerazione

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	`GeoJSON Point` geometria.
MultiPoint	`GeoJSON MultiPoint` geometria.
LineString	`GeoJSON LineString` geometria.
MultiLineString	`GeoJSON MultiLineString` geometria.
Polygon	`GeoJSON Polygon` geometria.
MultiPolygon	`GeoJSON MultiPolygon` geometria.
GeometryCollection	`GeoJSON GeometryCollection` geometria.
Feature	Oggetto `GeoJSON Feature`.
FeatureCollection	Oggetto `GeoJSON FeatureCollection`.

GeoJsonPoint

Oggetto

Tipo geometry GeoJSON Point valido. Per informazioni dettagliate, vedere RFC 7946.

Nome	Tipo	Descrizione
bbox	number[] (double)	Riquadro. Proiezione usata - EPSG:3857. Per informazioni dettagliate, vedere RFC 7946.
coordinates	number[] (double)	Un `Position` è una matrice di numeri con due o più elementi. I primi due elementi sono longitudine e latitudine, esattamente in tale ordine. altitudine/elevazione è un terzo elemento facoltativo. Per informazioni dettagliate, vedere RFC 7946.
type	string: Point	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.

Intersection

Oggetto

I dettagli dell'intersezione per un indirizzo si risolvono come un incrocio stradale — l'angolo dove si incontrano due o più strade con nome. Popolata solo quando l'entità risolta è un RoadIntersection; il genitore Address.intersection viene altrimenti omesso.

Nome	Tipo	Descrizione
baseStreet	string	La strada principale dell'incrocio — tipicamente la strada a cui si riferisce il numero di indirizzo.
displayName	string	Un nome leggibile dall'uomo per l'incrocio che combina le strade trasversali, come `"5th Avenue & Main Street"`.
intersectionType	string	Una breve etichetta che descrive la forma dell'incrocio. Ad esempio, distinguere un incrocio a livello da uno a livello separato come un ponte o un cavalcavia.
secondaryStreet1	string	La prima strada incrociata che si incontra `baseStreet` all'incrocio.
secondaryStreet2	string	La seconda strada trasversale all'incrocio, quando ce n'è presente. Popolata solo per incroci di tre o più strade.

MatchCodesEnum

Enumerazione

Un valore di codice di corrispondenza che indica come il servizio di geocodifica ha prodotto un determinato risultato di località. Il matchCodes campo su una caratteristica è un array di questi valori; combinali con confidence e type per valutare la qualità della corrispondenza.

Valore	Descrizione
Good	Il servizio di geocodifica ha prodotto questo candidato senza ampliare la query: il risultato corrisponde alla query nella specificità richiesta.
Ambiguous	La location è una di una serie di possibili abbinamenti. Ad esempio, quando si interroga l'indirizzo "128 Main St.", la risposta può restituire due località per "128 North Main St." e "128 South Main St." perché non ci sono abbastanza informazioni per determinare quale opzione scegliere.
UpHierarchy	La posizione rappresenta una salita nella gerarchia geografica. Ciò si verifica quando non è stata trovata una corrispondenza per la richiesta di posizione, quindi viene restituito un risultato meno preciso.

UsageTypeEnum

Enumerazione

L'uso previsto per un punto di geocodifica. Un punto di geocodice restituito dal servizio contiene uno o più tipi di utilizzo che indicano come un'applicazione client dovrebbe consumare il punto: ad esempio, visualizzare la posizione su una mappa rispetto al passaggio di un veicolo verso di essa.

Valore	Descrizione
Display	Il punto di geocodice è adatto per mostrare la posizione su una mappa. Per una struttura con estensione non banale (come un parco o un edificio), il `Display` punto si trova tipicamente vicino al centro visivo della struttura.
Route	Il punto di geocodice è adatto come destinazione di un percorso. Per una struttura con estensione non banale (come un parco o un edificio), il `Route` punto è tipicamente posizionato a un ingresso accessibile ai veicoli piuttosto che al centro visivo.