Search - Get Search Address

Riferimento

Servizio:: Maps

Versione API:: 1.0

Usare per ottenere le coordinate di latitudine e longitudine di un indirizzo stradale in un formato di input non strutturato o di query.

L'API Get Search Address è una richiesta HTTP GET restituisce le coordinate di latitudine e longitudine quando vengono passate in un indirizzo o un nome di una posizione come criteri di 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 del codice geografico 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 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 come centri città, contee, stati e così via.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}

Con parametri facoltativi:

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}&typeahead={typeahead}&limit={limit}&ofs={ofs}&countrySet={countrySet}&lat={lat}&lon={lon}&radius={radius}&topLeft={topLeft}&btmRight={btmRight}&language={language}&extendedPostalCodesFor={extendedPostalCodesFor}&entityType={entityType}&view={view}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
format	path	True	ResponseFormat	Formato desiderato della risposta. Il valore può essere json o xml.
api-version	query	True	string	Numero di versione dell'API mappe di Azure.
query	query	True	string	L'indirizzo da cercare (ad esempio, "1 Microsoft way, Redmond, WA") deve essere codificato correttamente con URL.
btmRight	query		string	Posizione inferiore destra del rettangolo di selezione. Ad esempio 37.553,-122.453
countrySet	query		string[]	Stringa delimitata da virgole di codici paese/area geografica, ad esempio FR,ES. In questo modo la ricerca verrà limitata ai paesi/aree geografiche specificati
entityType	query		GeographicEntityType	Specifica il livello di filtro eseguito sulle aree geografiche. Restringe la ricerca dei tipi di entità geography specificati, ad esempio restituisce solo il comune. La risposta risultante conterrà l'ID geography e il tipo di entità corrispondente. Se si specificano più di un'entità come elenco delimitato da virgole, l'endpoint restituirà l'entità più piccola disponibile. L'ID geometry restituito può essere usato per ottenere la geometria di tale area geografica tramite 'API Get Search Polygon. Quando entityType è impostato, i parametri seguenti vengono ignorati: intestazione numero returnRoadUse returnSpeedLimit RoadUse returnMatchType
extendedPostalCodesFor	query		SearchIndexes[]	Indici per i quali i codici postali estesi devono essere inclusi nei risultati. Gli indici disponibili sono: Addr = Intervalli di indirizzi Geo = Aree geografiche PAD = Indirizzi punto punto di interesse = Punti di interesse Str = Strade XStr = Cross Street (intersezioni) Il valore deve essere un elenco delimitato da virgole di tipi di indice (in qualsiasi ordine) o Nessuna per nessun indice. Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici tranne Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, quindi devono essere richiesti in modo esplicito quando necessario. Esempi di utilizzo: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area.
language	query		string	Lingua in cui devono essere restituiti i risultati della ricerca. Deve essere uno dei tag di lingua IETF supportati, senza distinzione tra maiuscole e minuscole. Quando i dati nella lingua specificata non sono disponibili per un campo specifico, viene usata la lingua predefinita. Per informazioni dettagliate, vedere lingue supportate.
lat	query		number (double)	Latitudine in cui i risultati devono essere distorti. Ad esempio 37.337
limit	query		integer minimum: 1 maximum: 100	Numero massimo di risposte che verranno restituite. Impostazione predefinita: 10, minimo: 1 e massimo: 100
lon	query		number (double)	Longitudine in cui i risultati devono essere distorti. Ad esempio -121.89
ofs	query		integer minimum: 0 maximum: 1900	Offset iniziale dei risultati restituiti all'interno del set di risultati completo. Impostazione predefinita: 0
radius	query		integer	Raggio in metri da cui limitare i risultati all'area definita
topLeft	query		string	Posizione superiore sinistra del rettangolo di selezione. Ad esempio 37.553,-122.453
typeahead	query		boolean	Booleano. Se il flag typeahead è impostato, la query verrà interpretata come input parziale e la ricerca passerà alla modalità predittiva
view	query		LocalizedMapView	Il parametro View (detto anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per aree geopolitiche contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà utilizzata l'applicazione.Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e altri contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN. Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
x-ms-client-id		string	Specifica quale account è destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account mappe di Azure e può essere recuperato dall'API dell'account del piano di gestione di Mappe di Azure. Per usare la sicurezza di Microsoft Entra ID in Mappe di Azure, vedere gli articoli di seguenti per indicazioni.

Risposte

Nome	Tipo	Descrizione
200 OK	SearchAddressResult	Va bene
Other Status Codes	ErrorResponse	Errore imprevisto.

Sicurezza

AADToken

Questi sono i flussi di Microsoft Entra OAuth 2.0. Se abbinato a l'accesso in base al ruolo di Azure controllarlo, può essere usato per controllare l'accesso alle API REST di Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più account di risorse di Mappe di Azure o a risorse secondarie. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per le API REST di Mappe di Azure.

Per implementare scenari, è consigliabile visualizzare concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

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 Maps.
Il Authorization URL è specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni microsoft Entra ID.
Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite il portale di Azure, PowerShell, l'interfaccia della riga di comando, gli SDK di Azure o le API REST.
L'utilizzo della Sdk Web di Mappe di Azure consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.
Per altre informazioni su Microsoft Identity Platform, vedere panoramica di Microsoft Identity Platform.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Si tratta di una chiave condivisa di cui viene effettuato il provisioning 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: query

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 98052

Esempio di richiesta

HTTP

GET https://atlas.microsoft.com/search/address/json?api-version=1.0&query=15127 NE 24th Street, Redmond, WA 98052

Risposta di esempio

Codice di stato:: 200

{
  "summary": {
    "query": "15127 NE 24th Street, Redmond, WA 98052",
    "queryType": "NON_NEAR",
    "queryTime": 58,
    "numResults": 1,
    "offset": 0,
    "totalResults": 1,
    "fuzzyLevel": 1
  },
  "results": [
    {
      "type": "Point Address",
      "id": "US/PAD/p0/19173426",
      "score": 14.51,
      "address": {
        "streetNumber": "15127",
        "streetName": "NE 24th St",
        "municipalitySubdivision": "Redmond",
        "municipality": "Redmond, Adelaide, Ames Lake, Avondale, Earlmount",
        "countrySecondarySubdivision": "King",
        "countryTertiarySubdivision": "Seattle East",
        "countrySubdivisionCode": "WA",
        "postalCode": "98052",
        "extendedPostalCode": "980525544",
        "countryCode": "US",
        "country": "United States Of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "15127 NE 24th St, Redmond, WA 980525544",
        "countrySubdivisionName": "Washington"
      },
      "position": {
        "lat": 47.6308,
        "lon": -122.1385
      },
      "viewport": {
        "topLeftPoint": {
          "lat": 47.6317,
          "lon": -122.13983
        },
        "btmRightPoint": {
          "lat": 47.6299,
          "lon": -122.13717
        }
      },
      "entryPoints": [
        {
          "type": "main",
          "position": {
            "lat": 47.6315,
            "lon": -122.13852
          }
        }
      ]
    }
  ]
}

Definizioni

Nome	Descrizione
Address	Indirizzo del risultato
AddressRanges	Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Sono incluse le coordinate per le posizioni iniziale e finale dell'intervallo di indirizzi.
BoundingBox	Riquadro di visualizzazione che copre il risultato rappresentato dalle coordinate superiore sinistra e inferiore destra del riquadro di visualizzazione.
BoundingBoxCompassNotation	Rettangolo di selezione della posizione.
Brand	Il marchio associato al punto di interesse
Classification	Classificazione per il punto di interesse restituito
ClassificationName	Nome della classificazione
DataSources	Sezione facoltativa. ID di riferimento da usare con l'API Get Search Polygon.
Entity	Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione.
EntryPoint	Punto di ingresso per il punto di interesse restituito.
EntryPointType	Tipo di punto di ingresso. Il valore può essere principale o secondaria.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
GeographicEntityType	Tipo di entità Geography. Presente solo quando entityType è stato richiesto ed è disponibile.
Geometry	Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography.
LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
LocalizedMapView	Il parametro View (detto anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per aree geopolitiche contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà utilizzata l'applicazione.Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e altri contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN. Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate.
MatchType	Tipi di corrispondenza per un'operazione di ricerca di indirizzi inversa.
OperatingHours	Ore di apertura per un punto di interesse (punti di interesse).
OperatingHoursTime	Rappresenta una data e un'ora
OperatingHoursTimeRange	Aprire l'intervallo di tempo per un giorno
PointOfInterest	Dettagli del punto di interesse restituito, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni.
PointOfInterestCategorySet	Categoria punti di interesse
QueryType	Tipo di query restituito: NEARBY o NON_NEAR.
ResponseFormat	Formato desiderato della risposta. Il valore può essere json o xml.
SearchAddressResult	Questo oggetto viene restituito dalle chiamate di ricerca riuscite.
SearchAddressResultItem	Oggetto Result per una risposta dell'API di ricerca.
SearchAddressResultType	Uno dei seguenti: POI (Punto di interesse) Via Geografia Punto di interesse Intervallo di indirizzi Incrocio
SearchIndexes	Indici per i quali i codici postali estesi devono essere inclusi nei risultati. Gli indici disponibili sono: Addr = Intervalli di indirizzi Geo = Aree geografiche PAD = Indirizzi punto punto di interesse = Punti di interesse Str = Strade XStr = Cross Street (intersezioni) Il valore deve essere un elenco delimitato da virgole di tipi di indice (in qualsiasi ordine) o Nessuna per nessun indice. Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici tranne Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, quindi devono essere richiesti in modo esplicito quando necessario. Esempi di utilizzo: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area.
SearchSummary	Oggetto riepilogo per una risposta dell'API di ricerca.

Address

Object

Indirizzo del risultato

Nome	Tipo	Descrizione
boundingBox	BoundingBoxCompassNotation	Rettangolo di selezione della posizione.
buildingNumber	string	Numero dell'edificio sulla strada. DEPRECATO, usare invece streetNumber.
country	string	nome paese/area geografica
countryCode	string	Paese (Nota: si tratta di un codice di due lettere, non di un nome paese/area geografica.
countryCodeISO3	string	Codice paese ISO alfa-3
countrySecondarySubdivision	string	Contea
countrySubdivision	string	Stato o Provincia
countrySubdivisionCode	string	`countrySubdivisionCode` preceduti da `countryCode` ( countryCode-countrySubdivisionCode ) e il trattino costituisce il codice ISO 3166-2. Esempi: TX per Texas, SCT per Scozia e ON per Ontario.
countrySubdivisionName	string	Nome completo di un primo livello di gerarchia amministrativa paese/area geografica. Questo campo viene visualizzato solo nel caso in cui countrySubdivision venga presentato in formato abbreviato. Supportato solo per Stati Uniti, Canada e Regno Unito.
countryTertiarySubdivision	string	Area denominata
crossStreet	string	Il nome della strada da attraversare.
extendedPostalCode	string	Codice postale esteso (la disponibilità dipende dall'area).
freeformAddress	string	Riga di indirizzo formattata in base alle regole di formattazione del paese o dell'area geografica di un risultato oppure, nel caso di un paese o area geografica, il nome completo del paese o dell'area geografica.
localName	string	Componente dell'indirizzo che rappresenta il nome di un'area geografica o di una località che raggruppa più oggetti indirizzabili a scopo di indirizzamento, senza essere un'unità amministrativa. Questo campo viene usato per compilare la proprietà `freeformAddress`. `localName` rappresenta il comune postale. A seconda della località, `localName` è il nome comunemente noto di una città o di una città. Per il nome comunemente noto di una città o di una città, usare `localName` anziché `municipality`.
municipality	string	Città/Città Nota: `municipality` rappresenta il comune residenziale. A seconda della località, il valore `municipality` può differire dal nome comunemente noto di una città o di una città. Per il nome comunemente noto della città o della città, è consigliabile usare il valore `localName` anziché il valore `municipality`.
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Un quartiere è un'area geograficamente localizzata all'interno di una città o di una città con caratteristiche distintive e interazioni sociali tra gli abitanti.
postalCode	string	Codice postale/Cap
routeNumbers	string[]	I codici usati per identificare in modo univoco la strada
street	string	Nome della strada. DEPRECATO, usare invece streetName.
streetName	string	Nome della strada.
streetNameAndNumber	string	Nome e numero della strada.
streetNumber	string	Numero dell'edificio sulla strada.

AddressRanges

Object

Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Sono incluse le coordinate per le posizioni iniziale e finale dell'intervallo di indirizzi.

Nome	Tipo	Descrizione
from	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
rangeLeft	string	Intervallo di indirizzi sul lato sinistro della strada.
rangeRight	string	Intervallo di indirizzi sul lato destro della strada.
to	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.

BoundingBox

Object

Riquadro di visualizzazione che copre il risultato rappresentato dalle coordinate superiore sinistra e inferiore destra del riquadro di visualizzazione.

Nome	Tipo	Descrizione
btmRightPoint	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
topLeftPoint	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.

BoundingBoxCompassNotation

Object

Rettangolo di selezione della posizione.

Nome	Tipo	Descrizione
entity	Entity	Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione.
northEast	string	Latitudine nord-est, coordinata longitudine del rettangolo delimitatore come float delimitati da virgole
southWest	string	Latitudine sud-ovest, coordinata longitudine del rettangolo delimitatore come float delimitati da virgole

Brand

Object

Il marchio associato al punto di interesse

Nome	Tipo	Descrizione
name	string	Nome del marchio

Classification

Object

Classificazione per il punto di interesse restituito

Nome	Tipo	Descrizione
code	string	Proprietà del codice
names	ClassificationName[]	Matrice nomi

ClassificationName

Object

Nome della classificazione

Nome	Tipo	Descrizione
name	string	Name - proprietà
nameLocale	string	Proprietà Delle impostazioni locali name

DataSources

Object

Sezione facoltativa. ID di riferimento da usare con l'API Get Search Polygon.

Nome	Tipo	Descrizione
geometry	Geometry	Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography.

Entity

Enumerazione

Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa questo è sempre uguale alla posizione.

Valore	Descrizione
position	Entità Position

EntryPoint

Object

Punto di ingresso per il punto di interesse restituito.

Nome	Tipo	Descrizione
position	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
type	EntryPointType	Tipo di punto di ingresso. Il valore può essere principale o secondaria.

EntryPointType

Enumerazione

Tipo di punto di ingresso. Il valore può essere principale o secondaria.

Valore	Descrizione
main
minor

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

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

ErrorDetail

Object

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

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

GeographicEntityType

Enumerazione

Tipo di entità Geography. Presente solo quando entityType è stato richiesto ed è disponibile.

Valore	Descrizione
Country	nome paese/area geografica
CountrySecondarySubdivision	Contea
CountrySubdivision	Stato o Provincia
CountryTertiarySubdivision	Area denominata
Municipality	Città/Città
MunicipalitySubdivision	Sub/Super City
Neighbourhood	Quartiere
PostalCodeArea	Codice postale/Cap

Geometry

Object

Informazioni sulla forma geometrica del risultato. Presente solo se type == Geography.

Nome	Tipo	Descrizione
id	string	Passare questo valore come geometryId all'API get search polygon per recuperare le informazioni di geometria per questo risultato.

LatLongPairAbbreviated

Object

Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.

Nome	Tipo	Descrizione
lat	number (double)	Proprietà Latitude
lon	number (double)	Longitudine - proprietà

LocalizedMapView

Enumerazione

Il parametro View (detto anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per aree geopolitiche contestate. Diversi paesi/aree geografiche hanno visualizzazioni diverse di tali aree e il parametro View consente all'applicazione di rispettare la visualizzazione richiesta dal paese o dall'area geografica in cui verrà utilizzata l'applicazione.Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. Per impostazione predefinita, il parametro View è impostato su "Unified" anche se non è stato definito nella richiesta. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. In alternativa, è possibile impostare 'View=Auto', che restituirà i dati della mappa in base all'indirizzo IP della richiesta. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e altri contenuti di terze parti autorizzati ad accedere tramite Mappe di Azure. Esempio: view=IN.

Per informazioni dettagliate e per visualizzare le visualizzazioni disponibili, vedere viste supportate.

Valore	Descrizione
AE	Emirati Arabi Uniti (visualizzazione Araba)
AR	Argentina (vista argentina)
Auto	Restituisce i dati della mappa in base all'indirizzo IP della richiesta.
BH	Bahrein (vista araba)
IN	India (vista indiana)
IQ	Iraq (visualizzazione araba)
JO	Giordania (visualizzazione araba)
KW	Kuwait (vista araba)
LB	Libano (vista araba)
MA	Marocco (vista marocchina)
OM	Oman (vista araba)
PK	Pakistan (vista pakistana)
PS	Autorità palestinese (visualizzazione araba)
QA	Qatar (vista araba)
SA	Arabia Saudita (vista araba)
SY	Siria (visualizzazione araba)
Unified	Visualizzazione unificata (altri)
YE	Yemen (vista araba)

MatchType

Enumerazione

Tipi di corrispondenza per un'operazione di ricerca di indirizzi inversa.

Valore	Descrizione
AddressPoint
HouseNumberRange
Street

OperatingHours

Object

Ore di apertura per un punto di interesse (punti di interesse).

Nome	Tipo	Descrizione
mode	string	Valore usato nella richiesta: nessuno o "nextSevenDays"
timeRanges	OperatingHoursTimeRange[]	Elenco di intervalli di tempo per i prossimi 7 giorni

OperatingHoursTime

Object

Rappresenta una data e un'ora

Nome	Tipo	Descrizione
date	string	Rappresenta la data del calendario corrente nel fuso orario dei punti di interesse, ad esempio "2019-02-07".
hour	integer	Le ore sono nel formato 24 ore nell'ora locale di un punto di interesse; i valori possibili sono compresi tra 0 e 23.
minute	integer	I minuti sono nell'ora locale di un punto di interesse; i valori possibili sono compresi tra 0 e 59.

OperatingHoursTimeRange

Object

Aprire l'intervallo di tempo per un giorno

Nome	Tipo	Descrizione
endTime	OperatingHoursTime	Punto nell'intervallo di 7 giorni successivo quando un punto di interesse specificato viene chiuso o l'inizio dell'intervallo se è stato chiuso prima dell'intervallo.
startTime	OperatingHoursTime	Punto nell'intervallo di 7 giorni successivo quando viene aperto un punto di interesse specificato o l'inizio dell'intervallo se è stato aperto prima dell'intervallo.

PointOfInterest

Object

Dettagli del punto di interesse restituito, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni.

Nome	Tipo	Descrizione
brands	Brand[]	Matrice di marchi. Nome del marchio per il punto di interesse restituito.
categories	string[]	Matrice categorie
categorySet	PointOfInterestCategorySet[]	Elenco delle categorie di punti di interesse più specifiche
classifications	Classification[]	Matrice di classificazione
name	string	Nome della proprietà POI
openingHours	OperatingHours	Ore di apertura per un punto di interesse (punti di interesse).
phone	string	Proprietà numero di telefono
url	string	Proprietà URL sito Web

PointOfInterestCategorySet

Object

Categoria punti di interesse

Nome	Tipo	Descrizione
id	integer	ID categoria

QueryType

Enumerazione

Tipo di query restituito: NEARBY o NON_NEAR.

Valore	Descrizione
NEARBY	La ricerca è stata eseguita intorno a una certa latitudine e longitudine con un raggio definito
NON_NEAR	La ricerca è stata eseguita a livello globale, senza distorsioni a una certa latitudine e longitudine e nessun raggio definito

ResponseFormat

Enumerazione

Formato desiderato della risposta. Il valore può essere json o xml.

Valore	Descrizione
json	il formato dell'interscambio dati notazione oggetto JavaScript
xml	la extensible markup language

SearchAddressResult

Object

Questo oggetto viene restituito dalle chiamate di ricerca riuscite.

Nome	Tipo	Descrizione
results	SearchAddressResultItem[]	Elenco dei risultati dell'API di ricerca.
summary	SearchSummary	Oggetto Riepilogo per una risposta dell'API di ricerca

SearchAddressResultItem

Object

Oggetto Result per una risposta dell'API di ricerca.

Nome	Tipo	Descrizione
address	Address	Indirizzo del risultato
addressRanges	AddressRanges	Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Sono incluse le coordinate per le posizioni iniziale e finale dell'intervallo di indirizzi.
dataSources	DataSources	Sezione facoltativa. ID geometry di riferimento da usare con l'API get search polygon.
detourTime	integer	Tempo di deviazione in secondi. Restituito solo per le chiamate all'API Search Along Route.
dist	number (double)	Distanza linea retta tra il risultato e la posizione geobias in metri.
entityType	GeographicEntityType	Tipo di entità Geography. Presente solo quando entityType è stato richiesto ed è disponibile.
entryPoints	EntryPoint[]	Matrice di Punti di ingresso. Questi descrivono i tipi di ingressi disponibili nella posizione. Il tipo può essere "principale" per gli ingressi principali, ad esempio una porta anteriore, o una hall, e "minore", per porte laterali e posteriore.
id	string	Id - proprietà
info	string	Informazioni sull'origine dati originale del risultato. Usato per le richieste di supporto.
matchType	MatchType	Informazioni sul tipo di corrispondenza. Uno dei seguenti: AddressPoint HouseNumberRange Via
poi	PointOfInterest	Dettagli del punto di interesse restituito, incluse informazioni quali il nome, il telefono, l'indirizzo URL e le classificazioni.
position	LatLongPairAbbreviated	Posizione rappresentata come latitudine e longitudine usando nomi brevi 'lat' & 'lon'.
score	number (double)	Valore all'interno di un set di risultati per indicare il punteggio di corrispondenza relativo tra i risultati. È possibile usarlo per determinare che il risultato x è il doppio delle probabilità di essere rilevante come risultato y se il valore di x è 2x il valore di y. I valori variano tra le query e sono destinati solo a un valore relativo per un set di risultati.
type	SearchAddressResultType	Uno dei seguenti: POI (Punto di interesse) Via Geografia Punto di interesse Intervallo di indirizzi Incrocio
viewport	BoundingBox	Riquadro di visualizzazione che copre il risultato rappresentato dalle coordinate superiore sinistra e inferiore destra del riquadro di visualizzazione.

SearchAddressResultType

Enumerazione

Uno dei seguenti:

POI (Punto di interesse)
Via
Geografia
Punto di interesse
Intervallo di indirizzi
Incrocio

Valore	Descrizione
Address Range
Cross Street
Geography
POI
Point Address
Street

SearchIndexes

Enumerazione

Indici per i quali i codici postali estesi devono essere inclusi nei risultati.

Gli indici disponibili sono:

Addr = Intervalli di indirizzi

Geo = Aree geografiche

PAD = Indirizzi punto

punto di interesse = Punti di interesse

Str = Strade

XStr = Cross Street (intersezioni)

Il valore deve essere un elenco delimitato da virgole di tipi di indice (in qualsiasi ordine) o Nessuna per nessun indice.

Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici tranne Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, quindi devono essere richiesti in modo esplicito quando necessario.

Esempi di utilizzo:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Il codice postale esteso viene restituito come proprietà extendedPostalCode di un indirizzo. La disponibilità dipende dall'area.

Valore	Descrizione
Addr
Geo
PAD
POI
Str
Xstr

SearchSummary

Object

Oggetto riepilogo per una risposta dell'API di ricerca.

Nome	Tipo	Descrizione
fuzzyLevel	integer	Livello massimo di fuzzy necessario per fornire risultati.
geoBias	LatLongPairAbbreviated	Indicazione quando il motore di ricerca interno ha applicato una distorsione geospaziale per migliorare la classificazione dei risultati. In alcuni metodi, questa operazione può essere influenzata impostando i parametri lat e lon, se disponibili. In altri casi è puramente interno.
limit	integer	Numero massimo di risposte che verranno restituite
numResults	integer	Numero di risultati nella risposta.
offset	integer	Offset iniziale dell'oggetto Results restituito all'interno del set di risultati completo.
query	string	Parametro di query usato per produrre questi risultati della ricerca.
queryTime	integer	Tempo impiegato per la risoluzione della query, espresso in millisecondi.
queryType	QueryType	Tipo di query restituito: NEARBY o NON_NEAR.
totalResults	integer	Numero totale di risultati trovati.

Condividi tramite

Search - Get Search Address

Parametri dell'URI

Intestazione della richiesta

Risposte

Sicurezza

AADToken

Ambiti

subscription-key

SAS Token

Esempio

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

Esempio di richiesta

Risposta di esempio

Definizioni

Address

AddressRanges

BoundingBox

BoundingBoxCompassNotation

Brand

Classification

ClassificationName

DataSources

Entity

EntryPoint

EntryPointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GeographicEntityType

Geometry

LatLongPairAbbreviated

LocalizedMapView

MatchType

OperatingHours

OperatingHoursTime

OperatingHoursTimeRange

PointOfInterest

PointOfInterestCategorySet

QueryType

ResponseFormat

SearchAddressResult

SearchAddressResultItem

SearchAddressResultType

SearchIndexes

SearchSummary

Risorse aggiuntive