Search - Get Geocoding
Utilizzare per ottenere le coordinate di longitudine e latitudine di un indirizzo stradale o il nome di un luogo.
L'API Get Geocoding è una richiesta HTTP GET che restituisce le coordinate di longitudine e latitudine della posizione cercata.
In molti casi, il servizio di ricerca completo potrebbe essere troppo, ad esempio se si è interessati solo alla geocodifica tradizionale. È anche possibile accedere alla ricerca dell'indirizzo in modo esclusivo. La geocodifica viene eseguita colpendo il punto finale di geocodifica con solo l'indirizzo o l'indirizzo parziale in questione. L'indice di ricerca di geocodifica verrà sottoposto a query per tutti gli elementi al di sopra dei dati a livello stradale. Non verrà restituito alcun punto di interesse (POI). Si noti che il geocoder è molto tollerante di errori di digitazioni e indirizzi incompleti. Gestirà anche tutto, dagli indirizzi stradali esatti o dalle strade o dagli incroci, nonché le aree geografiche di livello superiore come i centri città, le contee e gli stati. La risposta restituisce anche proprietà dettagliate dell'indirizzo, ad esempio via, codice postale, comune e informazioni sul paese/area geografica.
GET {endpoint}/geocode?api-version=2026-01-01
GET {endpoint}/geocode?api-version=2026-01-01&top={top}&query={query}&addressLine={addressLine}&countryRegion={countryRegion}&bbox={bbox}&view={view}&coordinates={coordinates}&adminDistrict={adminDistrict}&adminDistrict2={adminDistrict2}&adminDistrict3={adminDistrict3}&locality={locality}&postalCode={postalCode}
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Il nome host del servizio Mappe di Azure. Usa |
|
api-version
|
query | True |
string minLength: 1 |
Versione dell'API da usare per questa operazione. |
|
address
|
query |
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 |
|
|
admin
|
query |
string |
La parte di suddivisione del paese di un indirizzo, ad esempio WA. Questo parametro non deve essere utilizzato quando il |
|
|
admin
|
query |
string |
La contea per l'indirizzo strutturato, ad esempio King. Questo parametro non deve essere utilizzato quando il |
|
|
admin
|
query |
string |
L'area denominata per l'indirizzo strutturato. Questo parametro non deve essere utilizzato quando il |
|
|
bbox
|
query |
number[] |
Area rettangolare sulla terra definita come oggetto rettangolo delimitatore. I lati del rettangolo sono definiti dai valori di longitudine e latitudine. 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. Dimensioni minime: circa 0,00001 gradi (~0,01 metri). Dimensione massima: fino all'intera estensione globale (da -180,-90 a 180,90) |
|
|
coordinates
|
query |
number[] |
Un punto sulla terra specificato come longitudine e latitudine. Quando specifichi questo parametro, la posizione dell'utente viene presa in considerazione e i risultati restituiti possono essere più rilevanti per l'utente. Esempio: coordinate &=lon,lat |
|
|
country
|
query |
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
|
query |
string |
La parte relativa alla località di un indirizzo, ad esempio Seattle. Questo parametro non deve essere utilizzato quando il |
|
|
postal
|
query |
string |
La parte relativa al codice postale di un indirizzo. Questo parametro non deve essere utilizzato quando il |
|
|
query
|
query |
string |
Stringa che contiene informazioni su una posizione, ad esempio un indirizzo o il nome di un punto di riferimento. |
|
|
top
|
query |
integer (int32) minimum: 1maximum: 20 |
Numero massimo di risposte che verranno restituite. Impostazione predefinita: 5, minimo: 1 e massimo: 20. |
|
|
view
|
query |
string |
Stringa che rappresenta un codice area/paese ISO 3166-1 Alpha-2. In questo modo verranno modificati i bordi e le etichette geopolitici contestati per allinearsi all'area utente specificata. Per impostazione predefinita, il parametro View è impostato su "Auto" anche se non è stato definito nella richiesta. Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate. |
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| Accept-Language |
string |
Lingua in cui devono essere restituiti i risultati della ricerca. Per informazioni dettagliate, vedere lingue supportate. |
|
| 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. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
La richiesta ha avuto esito positivo. Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Risposta di errore imprevista. Media Types: "application/geo+json", "application/json" 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-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 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
Search detail address 15127 NE 24th Street, Redmond, WA
Esempio di richiesta
GET https://atlas.microsoft.com/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond
Risposta di esempio
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"locality": "Redmond",
"postalCode": "98052",
"addressLine": "15127 NE 24th St"
},
"type": "Address",
"confidence": "High",
"matchCodes": [
"Good"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.1386787,
47.6302179
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"bbox": [
-122.14632282407,
47.626495282429325,
-122.13103917593001,
47.63422071757068
]
}
]
}
Search detail address 15127 NE 24th Street, Redmond, WA by addressLine
Esempio di richiesta
GET https://atlas.microsoft.com/geocode?api-version=2026-01-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US
Risposta di esempio
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"locality": "Redmond",
"postalCode": "98052",
"addressLine": "15127 NE 24th St"
},
"type": "Address",
"confidence": "Medium",
"matchCodes": [
"Good"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.1386787,
47.6302179
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"bbox": [
-122.14632282407,
47.626495282429325,
-122.13103917593001,
47.63422071757068
]
}
]
}
Search detail address 15127 NE 24th Street, Redmond, WA by query
Esempio di richiesta
GET https://atlas.microsoft.com/geocode?api-version=2026-01-01&query=15127 NE 24th Street Redmond WA
Risposta di esempio
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "WA"
},
{
"shortName": "King County"
}
],
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
"streetName": "NE 24th St",
"streetNumber": "15127",
"locality": "Redmond",
"postalCode": "98052",
"addressLine": "15127 NE 24th St"
},
"type": "Address",
"confidence": "High",
"matchCodes": [
"Good"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
},
{
"geometry": {
"type": "Point",
"coordinates": [
-122.1386787,
47.6302179
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Route"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-122.138681,
47.630358
]
},
"bbox": [
-122.14632282407,
47.626495282429325,
-122.13103917593001,
47.63422071757068
]
}
]
}
Search landmark Empire State Building by query
Esempio di richiesta
GET https://atlas.microsoft.com/geocode?api-version=2026-01-01&query=empire state building
Risposta di esempio
Content-Type: application/geo+json
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "NY"
}
],
"formattedAddress": "Empire State Building, NY",
"locality": "New York"
},
"type": "PointOfInterest",
"confidence": "High",
"matchCodes": [
"Ambiguous"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-73.98580932617188,
40.748435974121094
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-73.98580932617188,
40.748435974121094
]
},
"bbox": [
-73.98590850830078,
40.74833679199219,
-73.98571014404297,
40.74853515625
]
},
{
"type": "Feature",
"properties": {
"address": {
"countryRegion": {
"name": "United States"
},
"adminDistricts": [
{
"shortName": "NY"
},
{
"shortName": "New York County"
}
],
"formattedAddress": "Empire State Building, NY",
"locality": "Manhattan"
},
"type": "LandmarkBuilding",
"confidence": "High",
"matchCodes": [
"Ambiguous"
],
"geocodePoints": [
{
"geometry": {
"type": "Point",
"coordinates": [
-73.98500061035156,
40.74815368652344
]
},
"calculationMethod": "Rooftop",
"usageTypes": [
"Display"
]
}
]
},
"geometry": {
"type": "Point",
"coordinates": [
-73.98500061035156,
40.74815368652344
]
},
"bbox": [
-73.98710632324219,
40.747314453125,
-73.98412322998047,
40.74958038330078
]
}
]
}
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, |
|
Address |
Una suddivisione amministrativa che contiene un indirizzo. Ad esempio, uno stato, una provincia o una contea. Restituito come una voce nella matrice principale |
|
Address |
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. |
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. 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. |
|
Feature |
Il |
|
Features |
Una singola voce nell'array |
|
Features |
Il |
|
Feature |
Il |
|
Geocode |
Un punto di geocodifica per una posizione: una coordinata più metadati che descrivono come il punto è stato calcolato ( |
|
Geocoding |
Il corpo di risposta di successo restituì da |
|
Geo |
Specifica il tipo di |
|
Geo |
Tipo geometry |
| 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 |
|
Match |
Un valore di codice di corrispondenza che indica come il servizio di geocodifica ha prodotto un determinato risultato di località. Il |
|
Usage |
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
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: |
| adminDistricts |
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 |
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: |
| intersection |
I dettagli delle strade che si intersecano per l'indirizzo, popolati quando l'entità risolta è un |
|
| locality |
string |
La località in cui si trova l'indirizzo: di solito una città, un paese o un villaggio. Ad esempio: |
| neighborhood |
string |
Il quartiere nominato all'interno della località, quando viene identificato. |
| postalCode |
string |
Il codice postale dell'indirizzo, quando viene definito. Esempio: |
| streetName |
string |
La componente del nome stradale dell'indirizzo, quando l'entità risolta è un indirizzo a livello strada. Esempio: |
| streetNumber |
string |
Il numero della casa o dell'edificio sulla strada, quando l'entità risolta è un indirizzo a livello strada. Esempio: |
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.
| Nome | Tipo | Descrizione |
|---|---|---|
| name |
string |
Il nome completo del quartiere. Ad esempio, |
| shortName |
string |
La forma abbreviata o abbreviata del nome della suddivisione, quando viene definita una. Ad esempio, |
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.
| Nome | Tipo | Descrizione |
|---|---|---|
| ISO |
string |
Il codice paese ISO 3166-1 Alpha-2 per il paese o la regione. Ad esempio, |
| name |
string |
Il nome visualizzato del paese o della regione. Ad esempio: |
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. 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 |
Se l'attendibilità è impostata su 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 |
| 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 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 |
Bassa fiducia nel match. |
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.
| Valore | Descrizione |
|---|---|
| FeatureCollection |
Il tipo di |
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.
| 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 |
| geometry |
Il primario |
|
| id |
string |
Un identificatore opzionale assegnato dal servizio per la funzione, quando disponibile. |
| properties |
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 |
Il tipo di |
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.
| Nome | Tipo | Descrizione |
|---|---|---|
| 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 |
Quanto forte la posizione geocodificata corrisponde alla richiesta. Usalo |
|
| geocodePoints |
Uno o più punti di geocodice per la posizione, ciascuno segnato con il modo in cui è stato derivato ( |
|
| matchCodes |
Come il servizio di geocodifica ha prodotto questo risultato rispetto alla query: una corrispondenza diretta alla specificità richiesta ( |
|
| type |
string |
Il tipo di entità a cui la posizione geocodificata ha risolto. Uno di: , , , , , , , , |
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.
| Valore | Descrizione |
|---|---|
| Feature |
Il tipo di |
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.
| Nome | Tipo | Descrizione |
|---|---|---|
| calculationMethod |
Come è stato calcolato il punto. Ad esempio, si è agganciata sul tetto di un edificio o interpolata lungo una linea centrale della strada. Vedi |
|
| geometry |
La coordinata di questo punto geocodice è un |
|
| usageTypes |
A cosa è più adatto il punto di geocodifica — |
GeocodingResponse
Il corpo di risposta di successo restituì da Get Geocoding e Get Reverse Geocoding, e la forma di successo per batch-item portato all'interno GeocodingBatchResponse.batchItemsdi .
Codificato come un GeoJSON FeatureCollection array di cui features contiene uno Feature per ogni posizione geocodificata.
| Nome | Tipo | Descrizione |
|---|---|---|
| features |
L'array degli |
|
| 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. |
| type |
Il |
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
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 |
| 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 |
| secondaryStreet2 |
string |
La seconda strada trasversale all'incrocio, quando ce n'è presente. Popolata solo per incroci di tre o più strade. |
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.
| 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
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 |
| 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 |