Condividi tramite


Search - Get Search Address

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 che restituisce le coordinate di latitudine e longitudine quando viene passato 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. Search è anche possibile accedere esclusivamente alla ricerca dell'indirizzo. 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 stradali esatti, strade o intersezioni, nonché aree geografiche di livello superiore, ad esempio centri città, contee, stati e così via.

GET https://atlas.microsoft.com/search/address/{format}?api-version=1.0&query={query}
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 nelle aree geografiche. Limita 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 specifica 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 Get Search API Polygon. I parametri seguenti vengono ignorati quando entityType è impostato:

  • Intestazione
  • d'acquisto
  • 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 Nessuno per nessun indice.

Per impostazione predefinita, i codici postali estesi sono inclusi per tutti gli indici ad eccezione di Geo. Gli elenchi di codici postali estesi per le aree geografiche possono essere molto lunghi, pertanto 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

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

Offset iniziale dei risultati restituiti all'interno del set di risultati completo. Predefinito: 0

radius
query

integer

Raggio in metri di per 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

Proprietà di tipo Boolean. 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 (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente 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à eseguita l'applicazione. 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 mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN.

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

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-id

string

Specifica l'account destinato all'utilizzo in combinazione con il modello di sicurezza Microsoft Entra ID. Rappresenta un ID univoco per l'account Mappe di Azure e può essere recuperato dall'API account del piano di gestione Mappe di Azure. Per usare Microsoft Entra ID sicurezza in Mappe di Azure vedere gli articoli seguenti per indicazioni.

Risposte

Nome Tipo Descrizione
200 OK

SearchAddressResult

OK

Other Status Codes

ErrorResponse

Si è verificato un errore imprevisto.

Sicurezza

AADToken

Si tratta dei flussi OAuth 2.0 Microsoft Entra. Se abbinato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. 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 Mappe di Azure API REST.

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 Mappe di Azure risorsa a cui 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 Microsoft Entra ID.
  • Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, AZURE SDK o API REST.
  • L'utilizzo di Mappe di Azure 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.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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 crea un account 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 alle applicazioni client riservate per accedere alle API REST Mappe di Azure in modo che la chiave possa essere archiviata in modo sicuro.

Type: apiKey
In: query

SAS Token

Si tratta di un token di firma di accesso condiviso creato dall'operazione List SAS nella risorsa Mappe di Azure tramite il piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, Azure SDK o 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.

Type: apiKey
In: header

Esempio

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

Sample Request

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

Sample Response

{
  "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. Le coordinate per le posizioni iniziali e finali dell'intervallo di indirizzi sono incluse.

BoundingBox

Viewport che copre il risultato rappresentato dalle coordinate in alto a sinistra e in basso a destra del riquadro di visualizzazione.

BoundingBoxCompassNotation

Riquadro delimitatore della posizione.

Brand

Il marchio associato al punto di interesse

Classification

Classificazione dell'oggetto POI restituito

ClassificationName

Nome per la 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, questa operazione è sempre uguale alla posizione.

EntryPoint

Punto di ingresso per l'oggetto POI restituito.

EntryPointType

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

ErrorAdditionalInfo

Informazioni aggiuntive sulla 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

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

LocalizedMapView

Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente 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à eseguita l'applicazione. 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 mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN.

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

MatchType

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

OperatingHours

Orari di apertura per un punto di interesse (Punti di interesse).

OperatingHoursTime

Rappresenta una data e un'ora

OperatingHoursTimeRange

Intervallo di tempo aperto per un giorno

PointOfInterest

Dettagli dell'oggetto POI restituito, incluse informazioni quali il nome, il telefono, l'indirizzo url e le classificazioni.

PointOfInterestCategorySet

Categoria POI

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 da una chiamata di Search riuscita.

SearchAddressResultItem

Oggetto Result per una risposta API Search.

SearchAddressResultType

Uno dei valori possibili:

  • POI
  • Indirizzo
  • Area geografica
  • 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 del punto

POI = 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 Nessuno 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, pertanto 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 API Search.

Address

Indirizzo del risultato

Nome Tipo Descrizione
boundingBox

BoundingBoxCompassNotation

Casella di selezione della posizione.

buildingNumber

string

Numero di edificio sulla strada. DEPRECATO, usare invece streetNumber.

country

string

nome paese/area geografica

countryCode

string

Paese (Nota: si tratta di un codice a due lettere, non di un nome paese/area geografica).

countryCodeISO3

string

Codice paese ISO alfa-3

countrySecondarySubdivision

string

Contea

countrySubdivision

string

State or Province

countrySubdivisionCode

string

countrySubdivisionCode prefisso da countryCode ( countryCode-countrySubdivisionCode ) e il trattino forma 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 un formato abbreviato. Supportato solo per Stati Uniti, Canada e Regno Unito.

countryTertiarySubdivision

string

Area denominata

crossStreet

string

Nome della strada incrociata.

extendedPostalCode

string

Codice postale esteso (la disponibilità dipende dall'area).

freeformAddress

string

Una riga di indirizzo formattata in base alle regole di formattazione del paese/area geografica di un risultato o nel caso di un paese/area geografica, il nome completo del paese o dell'area geografica.

localName

string

Componente di 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 freeformAddress proprietà. localName rappresenta il comune postale. A seconda della posizione, 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 invece di municipality.

municipality

string

Città/Città
Nota: municipality rappresenta il comune residenziale. A seconda della posizione, il municipality valore può essere diverso dal nome comunemente noto di una città o di una città. Per il nome comunemente noto della città o della città, è consigliabile usare il localName valore anziché il municipality valore.

municipalitySubdivision

string

Sub/Super City

neighbourhood

string

Un quartiere è un'area geograficamente localizzata all'interno di una città o città con caratteristiche distintive e interazioni sociali tra gli abitanti.

postalCode

string

Codice postale/codice postale

routeNumbers

string[]

Codici usati per identificare in modo non ambiguo la strada

street

string

Nome della strada. DEPRECATO, usare invece streetName.

streetName

string

Nome della strada.

streetNameAndNumber

string

Nome della strada e numero.

streetNumber

string

Numero di edificio sulla strada.

AddressRanges

Descrive l'intervallo di indirizzi su entrambi i lati della strada per un risultato di ricerca. Le coordinate per le posizioni iniziali e finali dell'intervallo di indirizzi sono incluse.

Nome Tipo Descrizione
from

LatLongPairAbbreviated

Una 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

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

BoundingBox

Viewport che copre il risultato rappresentato dalle coordinate in alto a sinistra e in basso a destra del riquadro di visualizzazione.

Nome Tipo Descrizione
btmRightPoint

LatLongPairAbbreviated

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

topLeftPoint

LatLongPairAbbreviated

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

BoundingBoxCompassNotation

Riquadro delimitatore della posizione.

Nome Tipo Descrizione
entity

Entity

Origine del tipo di entità del rettangolo di selezione. Per la geocodifica inversa, questa operazione è 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

Il marchio associato al punto di interesse

Nome Tipo Descrizione
name

string

Nome del marchio

Classification

Classificazione dell'oggetto POI restituito

Nome Tipo Descrizione
code

string

Proprietà code

names

ClassificationName[]

Matrice dei nomi

ClassificationName

Nome per la classificazione

Nome Tipo Descrizione
name

string

Name (proprietà)

nameLocale

string

Proprietà Delle impostazioni locali name

DataSources

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 tipo == Geography.

Entity

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

Nome Tipo Descrizione
position

string

Entità Position

EntryPoint

Punto di ingresso per l'oggetto POI restituito.

Nome Tipo Descrizione
position

LatLongPairAbbreviated

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

type

EntryPointType

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

EntryPointType

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

Nome Tipo Descrizione
main

string

minor

string

ErrorAdditionalInfo

Informazioni aggiuntive sulla 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.

GeographicEntityType

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

Nome Tipo Descrizione
Country

string

nome paese/area geografica

CountrySecondarySubdivision

string

Contea

CountrySubdivision

string

State or Province

CountryTertiarySubdivision

string

Area denominata

Municipality

string

Città/Città

MunicipalitySubdivision

string

Sub/Super City

Neighbourhood

string

Quartiere

PostalCodeArea

string

Codice postale/codice postale

Geometry

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

Nome Tipo Descrizione
id

string

Passarlo come geometryId all'API Get Search Polygon per recuperare le informazioni di geometria per questo risultato.

LatLongPairAbbreviated

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

Nome Tipo Descrizione
lat

number

Latitudine, proprietà

lon

number

Proprietà Longitudine

LocalizedMapView

Il parametro View (chiamato anche parametro "area utente") consente di visualizzare le mappe corrette per un determinato paese/area geografica per le aree geopoliticamente 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à eseguita l'applicazione. 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 mappe, immagini e altri dati e contenuto di terze parti autorizzati ad accedere tramite Mappe di Azure è reso disponibile. Esempio: view=IN.

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

Nome Tipo Descrizione
AE

string

Emirati Arabi Uniti (visualizzazione araba)

AR

string

Argentina (visualizzazione argentina)

Auto

string

Restituisce i dati della mappa in base all'indirizzo IP della richiesta.

BH

string

Bahrain (visualizzazione araba)

IN

string

India (visualizzazione indiana)

IQ

string

Iraq (visualizzazione araba)

JO

string

Giordania (visualizzazione araba)

KW

string

Kuwait (visualizzazione araba)

LB

string

Libano (visualizzazione araba)

MA

string

Marocco (visualizzazione marocchina)

OM

string

Oman (visualizzazione araba)

PK

string

Pakistan (visualizzazione pakistana)

PS

string

Autorità Palestinese (visualizzazione araba)

QA

string

Qatar (visualizzazione araba)

SA

string

Arabia Saudita (visualizzazione araba)

SY

string

Siria (visualizzazione araba)

Unified

string

Visualizzazione unificata (altri)

YE

string

Yemen (visualizzazione araba)

MatchType

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

Nome Tipo Descrizione
AddressPoint

string

HouseNumberRange

string

Street

string

OperatingHours

Orari 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

Rappresenta una data e un'ora

Nome Tipo Descrizione
date

string

Rappresenta la data del calendario corrente nel fuso orario di calendario, ad esempio "2019-02-07".

hour

integer

Le ore sono nel formato di 24 ore nell'ora locale di un punto di interesse; i valori possibili sono 0 - 23.

minute

integer

I minuti sono nell'ora locale di un punto di interesse; I valori possibili sono compresi tra 0 e 59.

OperatingHoursTimeRange

Intervallo di tempo aperto per un giorno

Nome Tipo Descrizione
endTime

OperatingHoursTime

Punto nell'intervallo di 7 giorni successivo in cui viene chiuso un punto di interesse specificato o l'inizio dell'intervallo se è stato chiuso prima dell'intervallo.

startTime

OperatingHoursTime

Punto nell'intervallo di 7 giorni successivo in cui viene aperto un punto di interesse specificato o l'inizio dell'intervallo se è stato aperto prima dell'intervallo.

PointOfInterest

Dettagli dell'oggetto POI 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 poi restituito.

categories

string[]

Matrice categorie

categorySet

PointOfInterestCategorySet[]

Elenco delle categorie più specifiche di POI

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

Categoria POI

Nome Tipo Descrizione
id

integer

ID della categoria

QueryType

Tipo di query restituito: NEARBY o NON_NEAR.

Nome Tipo Descrizione
NEARBY

string

Search è stato eseguito intorno a una determinata latitudine e longitudine con un raggio definito

NON_NEAR

string

Search è stata eseguita a livello globale, senza pregiudizi a una determinata latitudine e longitudine, e nessun raggio definito

ResponseFormat

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

Nome Tipo Descrizione
json

string

Formato di interscambio dati dell'oggetto JavaScript

xml

string

Linguaggio di markup estendibile

SearchAddressResult

Questo oggetto viene restituito da una chiamata di Search riuscita.

Nome Tipo Descrizione
results

SearchAddressResultItem[]

Elenco dei risultati dell'API Search.

summary

SearchSummary

Oggetto Riepilogo per una risposta API di Search

SearchAddressResultItem

Oggetto Result per una risposta API Search.

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. Le coordinate per le posizioni iniziali e finali dell'intervallo di indirizzi sono incluse.

dataSources

DataSources

Sezione facoltativa. ID geometry di riferimento per l'uso con l'API Get Search Polygon.

detourTime

integer

Detour time in secondi. Restituito solo per le chiamate all'API Search Lungo route.

dist

number

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. Tali informazioni descrivono i tipi di ingresso 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 indietro.

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 valori possibili:

  • AddressPoint
  • HouseNumberRange
  • Indirizzo
poi

PointOfInterest

Dettagli dell'oggetto POI restituito, incluse informazioni quali il nome, il telefono, l'indirizzo url e le classificazioni.

position

LatLongPairAbbreviated

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

score

number

Valore all'interno di un set di risultati per indicare il punteggio di corrispondenza relativo tra i risultati. È possibile usare questa operazione per determinare che il risultato x è due volte più probabile che sia rilevante come risultato y se il valore di x è 2x il valore di y. I valori variano tra query e sono destinati solo a un valore relativo per un set di risultati.

type

SearchAddressResultType

Uno dei valori possibili:

  • POI
  • Indirizzo
  • Area geografica
  • Punto di interesse
  • Intervallo di indirizzi
  • Incrocio
viewport

BoundingBox

Viewport che copre il risultato rappresentato dalle coordinate in alto a sinistra e in basso a destra del riquadro di visualizzazione.

SearchAddressResultType

Uno dei valori possibili:

  • POI
  • Indirizzo
  • Area geografica
  • Punto di interesse
  • Intervallo di indirizzi
  • Incrocio
Nome Tipo Descrizione
Address Range

string

Cross Street

string

Geography

string

POI

string

Point Address

string

Street

string

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 del punto

POI = 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 Nessuno 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, pertanto 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.

Nome Tipo Descrizione
Addr

string

Geo

string

PAD

string

POI

string

Str

string

Xstr

string

SearchSummary

Oggetto Riepilogo per una risposta API Search.

Nome Tipo Descrizione
fuzzyLevel

integer

Il livello massimo di fuzzy richiesto per fornire risultati.

geoBias

LatLongPairAbbreviated

Indicazione quando il motore di ricerca interno ha applicato un pregiudizio geospaziale per migliorare la classificazione dei risultati. In alcuni metodi questo può essere interessato impostando i parametri lat e lon in cui sono disponibili. In altri casi è puramente interna.

limit

integer

Numero massimo di risposte che verranno restituite

numResults

integer

Numero di risultati nella risposta.

offset

integer

Offset iniziale dei risultati restituiti all'interno del set di risultati completo.

query

string

Parametro di query usato per produrre questi risultati della ricerca.

queryTime

integer

Tempo trascorso per la risoluzione della query, in millisecondi.

queryType

QueryType

Tipo di query restituito: NEARBY o NON_NEAR.

totalResults

integer

Numero totale di risultati trovati.