Search - Get Geocoding

Riferimento

Servizio:: Maps

Versione API:: 2023-06-01

Utilizzare per ottenere le coordinate di longitudine e latitudine di un indirizzo o di un nome di un luogo.

L'API Get Geocoding è una richiesta HTTP GET che restituisce le coordinate di longitudine e latitudine della posizione in cui viene eseguita la ricerca.

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 premendo l'endpoint 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 da indirizzi esatti o strade o intersezioni, nonché aree geografiche di livello superiore, ad esempio centri città, contee e stati. La risposta restituisce anche proprietà dettagliate degli indirizzi, ad esempio via, codice postale, comune e informazioni sul paese/area geografica.

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01

Con parametri facoltativi:

GET https://atlas.microsoft.com/geocode?api-version=2023-06-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
api-version	query	True	string	Numero di versione dell'API Mappe di Azure.
addressLine	query		string	La linea stradale ufficiale di un indirizzo relativo all'area, come specificato dalla località, o postalCode, proprietà. L'uso tipico di questo elemento è fornire un indirizzo stradale o un indirizzo ufficiale. Se viene specificata la query, non deve usare questo parametro.
adminDistrict	query		string	Parte del paese di suddivisione di un indirizzo, ad esempio WA. Se viene specificata la query, non deve usare questo parametro.
adminDistrict2	query		string	Contea per l'indirizzo strutturato, ad esempio King. Se viene specificata la query, non deve usare questo parametro.
adminDistrict3	query		string	Area denominata per l'indirizzo strutturato. Se viene specificata la query, non deve usare questo parametro.
bbox	query		number[]	Area rettangolare sulla terra definita come oggetto rettangolo delimitatore. I lati dei rettangoli 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
coordinates	query		number[]	Punto sulla terra specificato come longitudine e latitudine. Quando si specifica questo parametro, la posizione dell'utente viene presa in considerazione e i risultati restituiti potrebbero essere più rilevanti per l'utente. Esempio: coordinate &=lon,lat
countryRegion	query		string	Segnale per il risultato della geocodifica a un codice di area/paese ISO 3166-1 Alfa-2 specificato, ad esempio FR./ Se viene specificata la query, non deve usare questo parametro.
locality	query		string	Parte di località di un indirizzo, ad esempio Seattle. Se viene specificata la query, non deve usare questo parametro.
postalCode	query		string	Parte del codice postale di un indirizzo. Se viene specificata una query, non usare questo parametro.
query	query		string	Stringa che contiene informazioni su una posizione, ad esempio un indirizzo o un nome di punto di riferimento.
top	query		integer int32	Numero massimo di risposte che verranno restituite. Impostazione predefinita: 5, minimo: 1 e massimo: 20.
view	query		string	Stringa che rappresenta un codice di area/paese ISO 3166-1 Alfa-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, vedere Visualizzazioni supportate e visualizzare le visualizzazioni disponibili.

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 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 account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Azure AD in Mappe di Azure, vedere gli articoli seguenti per indicazioni.

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 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 account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Azure AD in Mappe di Azure, vedere gli articoli seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	GeocodingResponse	OK Media Types: "application/geo+json" Intestazioni x-ms-request-id: string
Other Status Codes	ErrorResponse	Si è verificato un errore imprevisto. Media Types: "application/geo+json"

Nome

Tipo

Descrizione

200 OK

GeocodingResponse

Media Types: "application/geo+json"

Intestazioni

x-ms-request-id: string

Other Status Codes

ErrorResponse

Si è verificato un errore imprevisto.

Media Types: "application/geo+json"

Sicurezza

AADToken

Si tratta dei flussi Microsoft Entra OAuth 2.0 . Se abbinato al controllo degli accessi in base al ruolo di Azure , 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 i 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.

Nota

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 mappe.
è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni ID Microsoft Entra.
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 di Azure Maps Web SDK 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 una risorsa di Mappe 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, queste chiavi possono essere considerate come chiavi master per l'account per cui vengono rilasciate.

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 Elenca firma di accesso condiviso nella risorsa 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 con i controlli di accesso in base al ruolo di Azure e il controllo granulare alla scadenza, alla frequenza e alle 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 dell'account map 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

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Search detail address 15127 NE 24th Street, Redmond, WA by query

Search landmark Empire State Building by query

Search detail address 15127 NE 24th Street, Redmond, WA

Esempio di richiesta

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street&adminDistrict=WA&locality=Redmond

Risposta di esempio

Codice di stato:: 200

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",
          "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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&addressLine=15127 NE 24th Street Redmond WA&countryRegion=US

Risposta di esempio

Codice di stato:: 200

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",
          "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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=15127 NE 24th Street Redmond WA

Risposta di esempio

Codice di stato:: 200

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",
          "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

HTTP

GET https://atlas.microsoft.com/geocode?api-version=2023-06-01&query=empire state building

Risposta di esempio

Codice di stato:: 200

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	Indirizzo del risultato
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.
CalculationMethodEnum	Metodo usato per calcolare il punto di geocodifica.
ConfidenceEnum	Il livello di confidenza 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.
CountryRegion
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
FeatureCollectionEnum	Il tipo di un oggetto FeatureCollection deve essere FeatureCollection.
FeaturesItem
FeatureTypeEnum	Il tipo di una funzionalità deve essere Feature.
GeocodePoints	Raccolta di punti geocodifica che differiscono in base alla modalità di calcolo e all'uso suggerito.
GeocodingResponse	Questo oggetto viene restituito da una chiamata geocodifica riuscita
GeoJsonPoint	Tipo di geometria valido `GeoJSON Point` . Per informazioni dettagliate, vedere RFC 7946 .
Intersection	Indirizzo del risultato.
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ù posizioni geocodificate per le informazioni sulla posizione e che il servizio di geocodifica non ha eseguito ricerche nella gerarchia superiore 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 geocodice doveva cercare in alto la gerarchia e trovare più corrispondenze a quel livello. Un esempio di up an `Ambiguous` e `UpHierarchy` result è quando si forniscono informazioni complete sull'indirizzo, ma il servizio di geocodifica non è in grado di individuare una corrispondenza per l'indirizzo stradale e restituisce invece le informazioni per più di un valore RoadBlock. I valori possibili sono: `Good`: il percorso ha una sola corrispondenza o tutte le corrispondenze restituite sono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze Valide. `Ambiguous`: il percorso è uno dei set di 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 nella 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 con un tipo di `UpHierarchy` entità RoadBlock.
Properties
UsageTypeEnum	L'uso migliore per il punto di geocodifica. Ogni punto di geocodifica è definito come `Route` punto, punto `Display` o entrambi. Usare `Route` i punti se si sta creando una route per la posizione. Usare `Display` i punti se viene visualizzata la posizione su una mappa. Ad esempio, se la posizione è un parco, un `Route` punto può specificare un ingresso al parco in cui è possibile entrare con un'auto e un `Display` punto può essere un punto che specifica il centro del parco.

Address

Indirizzo del risultato

Nome	Tipo	Descrizione
addressLine	string	AddressLine che include nome e numero di strada
adminDistricts	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	CountryRegion
formattedAddress	string	Proprietà Address formattata
intersection	Intersection	Indirizzo del risultato.
locality	string	proprietà locality
neighborhood	string	proprietà del quartiere
postalCode	string	Proprietà Postal Code

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	Il nome del campo adminDistrict corrispondente, Per adminDistrict[0], potrebbe trattarsi del nome completo dello stato, ad esempio Washington, Per adminDistrict[1], questo potrebbe essere il nome completo della contea
shortName	string	Nome breve per il campo adminDistrict corrispondente, Per adminDistrict[0], potrebbe trattarsi di un nome breve di stato, ad esempio WA, Per adminDistrict[1], potrebbe trattarsi del nome breve della contea

CalculationMethodEnum

Metodo usato per calcolare il punto di geocodifica.

Nome	Tipo	Descrizione
Interpolation	string	Il punto di geocodifica è stato confrontato con un punto su una strada usando l'interpolazione.
InterpolationOffset	string	Il punto di geocodifica è stato confrontato con un punto su una strada utilizzando l'interpolazione con un offset aggiuntivo per spostare il punto sul lato della strada.
Parcel	string	Il punto di geocodifica è stato associato al centro di un pacco.
Rooftop	string	Il punto di geocodifica è stato abbinato al tetto di un edificio.

ConfidenceEnum

Il livello di confidenza 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.

Nome Tipo Descrizione

High

Nome	Tipo	Descrizione
High	string	Se l'attendibilità è impostata su `High`, sono state trovate una o più corrispondenze complesse. Le corrispondenze di attendibilità multiple `High` vengono ordinate in base all'ordine di classificazione in base all'importanza, se applicabile. Ad esempio, i punti di riferimento hanno importanza, ma gli indirizzi non lo sono. Se una richiesta include una posizione o una visualizzazione, la classificazione può cambiare in modo appropriato. Ad esempio, una query di posizione per "Parigi" restituisce "Parigi, Francia" e "Parigi, TX" con `High` attendibilità. "Parigi, Francia" è sempre classificato per primo a causa dell'importanza, a meno che una posizione dell'utente non indichi che l'utente si trova in o molto vicino a Parigi, TX o la visualizzazione mappa indica che l'utente sta cercando in tale area.
Low	string
Medium	string	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ò 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 e il codice di corrispondenza è impostato `Medium` su `UpHierarchy` per specificare che non è stato in grado di trovare la corrispondenza con tutte le informazioni e che è stato necessario eseguire ricerche nella gerarchia iniziale. Se le informazioni sulla posizione nella query sono ambigue e non sono presenti 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 "148th Ave SE" e "148th Ave NE" con `Medium` fiducia. 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à sia impostata su `Medium`. Ad esempio, se viene specificato un indirizzo, ma non viene trovata una corrispondenza per il numero di casa, è possibile che venga restituito il risultato del codice geografico con un tipo di entità Roadblock.

string

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

Se una richiesta include una posizione o una visualizzazione, la classificazione può cambiare in modo appropriato. Ad esempio, una query di posizione per "Parigi" restituisce "Parigi, Francia" e "Parigi, TX" con High attendibilità. "Parigi, Francia" è sempre classificato per primo a causa dell'importanza, a meno che una posizione dell'utente non indichi che l'utente si trova in o molto vicino a Parigi, TX o la visualizzazione mappa indica che l'utente sta cercando in tale area.

Low

string

Medium

string

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ò 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 e il codice di corrispondenza è impostato Medium su UpHierarchy per specificare che non è stato in grado di trovare la corrispondenza con tutte le informazioni e che è stato necessario eseguire ricerche nella gerarchia iniziale.

Se le informazioni sulla posizione nella query sono ambigue e non sono presenti 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 "148th Ave SE" e "148th Ave NE" con Medium fiducia.

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à sia impostata su Medium. Ad esempio, se viene specificato un indirizzo, ma non viene trovata una corrispondenza per il numero di casa, è possibile che venga restituito il risultato del codice geografico con un tipo di entità Roadblock.

CountryRegion

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

ErrorResponse

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

FeatureCollectionEnum

Il tipo di un oggetto FeatureCollection deve essere FeatureCollection.

Nome	Tipo	Descrizione
FeatureCollection	string

FeaturesItem

Nome	Tipo	Descrizione
bbox	number[]	Riquadro. Proiezione usata : EPSG:3857. Per informazioni dettagliate, vedere RFC 7946 .
geometry	GeoJsonPoint	Tipo di geometria valido `GeoJSON Point` . Per informazioni dettagliate, vedere RFC 7946 .
id	string	ID per la funzionalità restituita
properties	Properties
type	FeatureTypeEnum	Il tipo di una funzionalità deve essere Feature.

FeatureTypeEnum

Il tipo di una funzionalità deve essere Feature.

Nome	Tipo	Descrizione
Feature	string

GeocodePoints

Raccolta di punti geocodifica che differiscono in base alla modalità di calcolo e all'uso suggerito.

Nome	Tipo	Descrizione
calculationMethod	CalculationMethodEnum	Metodo usato per calcolare il punto di geocodifica.
geometry	GeoJsonPoint	Tipo di geometria valido `GeoJSON Point` . Per informazioni dettagliate, vedere RFC 7946 .
usageTypes	UsageTypeEnum[]	L'uso migliore per il punto di geocodifica. Ogni punto di geocodifica è definito come `Route` punto, punto `Display` o entrambi. Usare `Route` i punti se si sta creando una route per la posizione. Usare `Display` i punti se viene visualizzata la posizione su una mappa. Ad esempio, se la posizione è un parco, un `Route` punto può specificare un ingresso al parco in cui è possibile entrare con un'auto e un `Display` punto può essere un punto che specifica il centro del parco.

GeocodingResponse

Questo oggetto viene restituito da una chiamata geocodifica riuscita

Nome	Tipo	Descrizione
features	FeaturesItem[]
nextLink	string	è il collegamento alla pagina successiva delle funzionalità restituite. Se si tratta dell'ultima pagina, nessun campo.
type	FeatureCollectionEnum	Il tipo di un oggetto FeatureCollection deve essere FeatureCollection.

GeoJsonPoint

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

Nome	Tipo	Descrizione
bbox	number[]	Riquadro. Proiezione usata : EPSG:3857. Per informazioni dettagliate, vedere RFC 7946 .
coordinates	number[]	Un `Position` è una matrice di numeri con due o più elementi. I primi due elementi sono longitudine e latitudine, esattamente in questo ordine. Altitudine/Elevazione è un terzo elemento facoltativo. Per informazioni dettagliate, vedere RFC 7946 .
type	string: Point	Specifica il tipo di oggetto `GeoJSON`. Deve essere uno dei nove tipi di oggetto GeoJSON validi: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature e FeatureCollection.

Intersection

Indirizzo del risultato.

Nome	Tipo	Descrizione
baseStreet	string	Strada primaria per la posizione.
displayName	string	Nome completo dell'intersezione.
intersectionType	string	Tipo di intersezione.
secondaryStreet1	string	La prima strada intersecante.
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ù posizioni geocodificate per le informazioni sulla posizione e che il servizio di geocodifica non ha eseguito ricerche nella gerarchia superiore 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 geocodice doveva cercare in alto la gerarchia e trovare più corrispondenze a quel livello. Un esempio di up an Ambiguous e UpHierarchy result è quando si forniscono informazioni complete sull'indirizzo, ma il servizio di geocodifica non è in grado di individuare una corrispondenza per l'indirizzo stradale e restituisce invece le informazioni per più di un valore RoadBlock.

I valori possibili sono:

Good: il percorso ha una sola corrispondenza o tutte le corrispondenze restituite sono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze Valide.

Ambiguous: il percorso è uno dei set di 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 nella 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 con un tipo di UpHierarchy entità RoadBlock.

Nome	Tipo	Descrizione
Ambiguous	string
Good	string
UpHierarchy	string

Properties

Nome	Tipo	Descrizione
address	Address	Indirizzo del risultato
confidence	ConfidenceEnum	Il livello di confidenza 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	GeocodePoints[]	Raccolta di punti geocodifica che differiscono in base alla modalità di calcolo e all'uso suggerito.
matchCodes	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ù posizioni geocodificate per le informazioni sulla posizione e che il servizio di geocodifica non ha eseguito ricerche nella gerarchia superiore 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 geocodice doveva cercare in alto la gerarchia e trovare più corrispondenze a quel livello. Un esempio di up an `Ambiguous` e `UpHierarchy` result è quando si forniscono informazioni complete sull'indirizzo, ma il servizio di geocodifica non è in grado di individuare una corrispondenza per l'indirizzo stradale e restituisce invece le informazioni per più di un valore RoadBlock. I valori possibili sono: `Good`: il percorso ha una sola corrispondenza o tutte le corrispondenze restituite sono considerate corrispondenze complesse. Ad esempio, una query per New York restituisce diverse corrispondenze Valide. `Ambiguous`: il percorso è uno dei set di 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 nella 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 con un tipo di `UpHierarchy` entità RoadBlock.
type	string	Uno dei valori possibili: Indirizzo Blocco stradale RoadIntersection Quartiere PopulatedPlace Codice postale1 AdminDivision1 AdminDivision2 CountryRegion

UsageTypeEnum

L'uso migliore per il punto di geocodifica. Ogni punto di geocodifica è definito come Route punto, punto Display o entrambi. Usare Route i punti se si sta creando una route per la posizione. Usare Display i punti se viene visualizzata la posizione su una mappa. Ad esempio, se la posizione è un parco, un Route punto può specificare un ingresso al parco in cui è possibile entrare con un'auto e un Display punto può essere un punto che specifica il centro del parco.

Nome	Tipo	Descrizione
Display	string
Route	string

Condividi tramite

Search - Get Geocoding

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Ambiti

subscription-key

SAS Token

Esempio

Search detail address 15127 NE 24th Street, Redmond, WA

Esempio di richiesta

Risposta di esempio

Search detail address 15127 NE 24th Street, Redmond, WA by addressLine

Esempio di richiesta

Risposta di esempio

Search detail address 15127 NE 24th Street, Redmond, WA by query

Esempio di richiesta

Risposta di esempio

Search landmark Empire State Building by query

Esempio di richiesta

Risposta di esempio

Definizioni

Address

AdminDistricts

CalculationMethodEnum

ConfidenceEnum

CountryRegion

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FeatureCollectionEnum

FeaturesItem

FeatureTypeEnum

GeocodePoints

GeocodingResponse

GeoJsonPoint

Intersection

MatchCodesEnum

Properties

UsageTypeEnum

Risorse aggiuntive