Classe AddressValidation
classe
google.maps.addressValidation.AddressValidation
libreria "addressValidation"
Classe statica per accedere alle API AddressValidation.
const {AddressValidation} = await google.maps.importLibrary("addressValidation");
Metodi statici | |
|---|---|
fetchAddressValidation |
fetchAddressValidation(request)Parametri:
Valore restituito:
Promise<AddressValidation>Convalida un indirizzo. Consulta https://developers.google.com/maps/documentation/javascript/address-validation/validate-address. |
Proprietà | |
|---|---|
address
readonly |
Tipo:
Address optionalInformazioni sull'indirizzo stesso, anziché sul geocodice. |
geocode
readonly |
Tipo:
Geocode optionalInformazioni sulla località e sul luogo in cui è stato geocodificato l'indirizzo. |
metadata
readonly |
Tipo:
AddressMetadata optionalAltre informazioni pertinenti alla deliverability. Non è garantito che metadata venga compilato completamente per ogni indirizzo inviato all'API Address Validation. |
responseId
readonly |
Tipo:
string optionalL'UUID che identifica questa risposta. Se l'indirizzo deve essere convalidato di nuovo, questo UUID deve accompagnare la nuova richiesta. |
uspsData
readonly |
Tipo:
USPSData optionalFlag di recapitabilità aggiuntivi forniti da USPS. Disponibile solo nelle regioni US e PR. |
verdict
readonly |
Tipo:
Verdict optionalFlag di esito complessivo |
Metodi | |
|---|---|
Ereditato:
toJSON
|
Interfaccia AddressValidationRequest
interfaccia
google.maps.addressValidation.AddressValidationRequest
Interfaccia di richiesta per AddressValidation.fetchAddressValidation.
Proprietà | |
|---|---|
address |
Tipo:
PostalAddressLiteralL'indirizzo in fase di convalida. Gli indirizzi non formattati devono essere inviati tramite PostalAddress.addressLines. |
internalUsageAttributionIds
facoltativo |
Tipo:
Iterable<string> optionalIdentificatori utilizzati per attribuire le chiamate a pacchetti o librerie OSS specifici. |
placeAutocompleteElement
facoltativo |
Tipo:
PlaceAutocompleteElement optionalSe utilizzi un PlaceAutocompleteElement, includilo qui per collegare le chiamate all'API Address Validation al token di sessione di completamento automatico. |
previousResponseId
facoltativo |
Tipo:
string optionalQuesto campo non deve essere impostato per la prima richiesta di Address Validation. Se sono necessarie più richieste per convalidare completamente un singolo indirizzo (ad esempio se le modifiche apportate dall'utente dopo la convalida iniziale devono essere riconvalidate), ogni richiesta successiva deve compilare questo campo con il valore AddressValidation.responseId della prima risposta nella sequenza di convalida. |
sessionToken
facoltativo |
Tipo:
AutocompleteSessionToken optionalUn token che identifica una sessione di Autocomplete ai fini della fatturazione. |
uspsCASSEnabled
facoltativo |
Tipo:
boolean optionalAbilita la modalità compatibile con USPS CASS. Questo influisce solo sul campo AddressValidation.uspsData di AddressValidation. Nota: per le richieste abilitate per USPS CASS per gli indirizzi a Portorico, è necessario fornire un PostalAddress.regionCode di address come "PR" o un PostalAddress.administrativeArea di address come "Portorico" (senza distinzione tra maiuscole e minuscole) o "PR". |
Classe Address
classe
google.maps.addressValidation.Address
libreria "addressValidation"
Dettagli dell'indirizzo post-elaborato. La post-elaborazione include la correzione di parti dell'indirizzo con errori ortografici, la sostituzione di parti errate e l'inferenza di parti mancanti.
const {Address} = await google.maps.importLibrary("addressValidation");
Proprietà | |
|---|---|
components
readonly |
Tipo:
Array<AddressComponent>I singoli componenti dell'indirizzo formattato e corretto, insieme alle informazioni di convalida. In questo modo, vengono fornite informazioni sullo stato di convalida dei singoli componenti. |
formattedAddress
readonly |
Tipo:
string optionalL'indirizzo post-elaborato, formattato come indirizzo su una singola riga seguendo le regole di formattazione degli indirizzi della regione in cui si trova l'indirizzo. |
missingComponentTypes
readonly |
Tipo:
Array<string>I tipi di componenti che dovevano essere presenti in un indirizzo postale formattato correttamente, ma che non sono stati trovati nell'input E non è stato possibile dedurre. I componenti di questo tipo non sono presenti in formatted_address, postal_address o address_components. Un esempio potrebbe essere ['street_number', 'route'] per un input come "Boulder, Colorado, 80301, USA". L'elenco dei tipi possibili è disponibile qui. |
postalAddress
readonly |
Tipo:
PostalAddress optionalL'indirizzo post-elaborato rappresentato come indirizzo postale. |
unconfirmedComponentTypes
readonly |
Tipo:
Array<string>I tipi di componenti presenti in address_components, ma di cui non è stato possibile confermare la correttezza. Questo campo viene fornito per comodità: i suoi contenuti equivalgono all'iterazione di address_components per trovare i tipi di tutti i componenti in cui AddressComponent.confirmationLevel non è ConfirmationLevel.CONFIRMED o il flag AddressComponent.inferred non è impostato su true. L'elenco dei tipi possibili è disponibile qui. |
unresolvedTokens
readonly |
Tipo:
Array<string>Eventuali token nell'input che non è stato possibile risolvere. Potrebbe trattarsi di un input non riconosciuto come parte valida di un indirizzo (ad esempio, in un input come "123235253253 Main St, San Francisco, CA, 94105", i token non risolti potrebbero essere simili a ["123235253253"], poiché non sembra un numero civico valido). |
Metodi | |
|---|---|
Ereditato:
toJSON
|
Classe AddressComponent
classe
google.maps.addressValidation.AddressComponent
libreria "addressValidation"
Rappresenta un singolo componente di un indirizzo (ad es. nome della via, città).
const {AddressComponent} = await google.maps.importLibrary("addressValidation");
Proprietà | |
|---|---|
componentName
readonly |
Tipo:
string optionalIl testo del nome del componente. Ad esempio, "5th Avenue" per il nome di una via o "1253" per un numero civico. |
componentNameLanguageCode
readonly |
Tipo:
string optionalIl codice lingua BCP-47. Questo campo non sarà presente se il nome del componente non è associato a una lingua, ad esempio un numero civico. |
componentType
readonly |
Tipo:
string optionalIl tipo di componente dell'indirizzo. Per un elenco dei tipi possibili, consulta la Tabella 2: tipi aggiuntivi restituiti dal servizio Places. |
confirmationLevel
readonly |
Tipo:
ConfirmationLevel optionalIndica il livello di certezza che il componente sia corretto. |
inferred
readonly |
Tipo:
booleanSe impostato su true, questo componente non faceva parte dell'input, ma è stato dedotto per la località dell'indirizzo. L'inclusione di questo componente è consigliata per un indirizzo completo. |
replaced
readonly |
Tipo:
booleanIndica che il nome del componente è stato sostituito con uno completamente diverso. Ad esempio, sostituendo un codice postale errato con quello corretto per l'indirizzo. Non si tratta di una modifica estetica, ma di un cambiamento del componente di input. |
spellCorrected
readonly |
Tipo:
booleanIndica una correzione di un errore ortografico nel nome del componente. L'API non segnala sempre le modifiche da una variante ortografica a un'altra, ad esempio da "centre" a "center". |
unexpected
readonly |
Tipo:
booleanSe impostato su true, questo componente non dovrebbe essere presente in un indirizzo postale per la regione specificata. È stato conservato solo perché faceva parte dell'input. |
Classe AddressMetadata
classe
google.maps.addressValidation.AddressMetadata
libreria "addressValidation"
I metadati dell'indirizzo. Non è garantito che AddressMetadata venga compilato completamente per ogni indirizzo inviato all'API Address Validation.
const {AddressMetadata} = await google.maps.importLibrary("addressValidation");
Proprietà | |
|---|---|
business
readonly |
Tipo:
boolean |
poBox
readonly |
Tipo:
boolean |
residential
readonly |
Tipo:
boolean |
Metodi | |
|---|---|
Ereditato:
toJSON
|
Costanti ConfirmationLevel
constants
google.maps.addressValidation.ConfirmationLevel
library "addressValidation"
I diversi valori possibili che indicano il livello di certezza che il componente sia corretto.
Queste costanti sono utilizzabili anche come stringhe. In TypeScript, i valori letterali stringa sono definiti dal tipo ConfirmationLevelString.
const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation");
Costanti | |
|---|---|
CONFIRMED |
|
UNCONFIRMED_AND_SUSPICIOUS |
|
UNCONFIRMED_BUT_PLAUSIBLE |
|
Classe Geocode
classe
google.maps.addressValidation.Geocode
libreria "addressValidation"
Contiene informazioni sul luogo in cui è stato geocodificato l'input.
const {Geocode} = await google.maps.importLibrary("addressValidation");
Proprietà | |
|---|---|
bounds
readonly |
Tipo:
LatLngBounds optionalI confini del luogo geocodificato. |
featureSizeMeters
readonly |
Tipo:
number optionalLe dimensioni del luogo geocodificato, in metri. Si tratta di un'altra misura dell'approssimazione della posizione geocodificata, ma in termini di dimensioni fisiche anziché di significato semantico. |
location
readonly |
Tipo:
LatLngAltitude optionalLa posizione geocodificata dell'input. |
placeId
readonly |
Tipo:
string optionalL'ID luogo del luogo geocodificato. L'utilizzo di Place è preferibile rispetto all'utilizzo di indirizzi, coordinate di latitudine/longitudine o Plus Code. L'utilizzo delle coordinate per il routing o il calcolo delle indicazioni stradali comporterà sempre l'aggancio del punto alla strada più vicina a queste coordinate. Potrebbe non essere una strada che porta rapidamente o in sicurezza alla destinazione e potrebbe non essere vicina a un punto di accesso alla proprietà. Inoltre, quando una località viene sottoposta a geocodifica inversa, non è garantito che l'indirizzo restituito corrisponda a quello originale. |
placeTypes
readonly |
Tipo:
Array<string>I tipi di luogo in cui è stato geocodificato l'input. Ad esempio, ['locality', 'political']. L'elenco completo dei tipi è disponibile nella documentazione dell'API Geocoding. |
plusCode
readonly |
Tipo:
PlusCode optionalIl Plus Code corrispondente a location. |
Metodi | |
|---|---|
fetchPlace |
fetchPlace()Parametri: nessuno
Valore restituito: nessuno
Restituisce una rappresentazione del luogo di questo codice geografico. Per ottenere i dettagli completi del luogo, è necessario effettuare una chiamata a place.fetchFields(). |
Ereditato:
toJSON
| |
Costanti di granularità
constants
google.maps.addressValidation.Granularity
library "addressValidation"
Le varie granularità che un indirizzo o un geocodice possono avere. Se utilizzati per indicare la granularità di un indirizzo, questi valori indicano il livello di granularità con cui l'indirizzo identifica una destinazione di spedizione. Ad esempio, un indirizzo come "123 Main Street, Redwood City, CA, 94061" identifica un PREMISE, mentre un indirizzo come "Redwood City, CA, 94061" identifica un LOCALITY. Tuttavia, se non riusciamo a trovare un geocodice per "123 Main Street" a Redwood City, il geocodice restituito potrebbe avere una granularità di tipo LOCALITY, anche se l'indirizzo è più granulare.
Queste costanti sono utilizzabili anche come stringhe. In TypeScript, i valori letterali stringa sono definiti dal tipo GranularityString.
const {Granularity} = await google.maps.importLibrary("addressValidation");
Costanti | |
|---|---|
BLOCK |
L'indirizzo o il codice geografico indica un isolato. Utilizzato solo nelle regioni che hanno un indirizzamento a livello di blocco, come il Giappone. |
OTHER |
Tutte le altre granularità, che vengono raggruppate perché non sono pubblicabili. |
PREMISE |
Risultato a livello di edificio. |
PREMISE_PROXIMITY |
Un codice geografico che approssima la posizione dell'indirizzo a livello di edificio. |
ROUTE |
Il geocodice o l'indirizzo è granulare rispetto al percorso, ad esempio una via, una strada o un'autostrada. |
SUB_PREMISE |
Risultato a livello di edificio, ad esempio un appartamento. |
Costanti PossibleNextAction
constants
google.maps.addressValidation.PossibleNextAction
library "addressValidation"
Offre un riepilogo interpretativo della risposta dell'API, con lo scopo di aiutare a determinare una potenziale azione successiva da intraprendere. Questo campo è derivato da altri campi nella risposta dell'API e non deve essere considerato una garanzia di accuratezza o recapitabilità dell'indirizzo.
Queste costanti sono utilizzabili anche come stringhe. In TypeScript, i valori letterali stringa sono definiti dal tipo PossibleNextActionString.
const {PossibleNextAction} = await google.maps.importLibrary("addressValidation");
Costanti | |
|---|---|
ACCEPT |
La risposta dell'API non contiene indicatori che giustificano uno degli altri valori PossibleNextAction. Potresti prendere in considerazione l'utilizzo dell'indirizzo post-elaborato senza chiedere ulteriori informazioni al cliente, anche se questo non garantisce che l'indirizzo sia valido e potrebbe comunque contenere correzioni. È tua responsabilità determinare se e come chiedere conferma al cliente, in base alla tua analisi del rischio. |
CONFIRM |
Uno o più campi della risposta dell'API indicano potenziali problemi di minore entità con l'indirizzo post-elaborato, ad esempio il componente dell'indirizzo postal_code era replaced. Chiedere al cliente di rivedere l'indirizzo potrebbe contribuire a migliorarne la qualità. |
CONFIRM_ADD_SUBPREMISES |
La risposta dell'API indica che l'indirizzo post-elaborato potrebbe non contenere un'unità secondaria. Chiedere al cliente di rivedere l'indirizzo e di valutare l'aggiunta di un numero di unità potrebbe contribuire a migliorare la qualità dell'indirizzo. L'indirizzo post-elaborato potrebbe presentare anche altri problemi minori. Nota: questo valore enum può essere restituito solo per gli indirizzi degli Stati Uniti. |
FIX |
Uno o più campi della risposta dell'API indicano un potenziale problema con l'indirizzo post-elaborato, ad esempio verdict.validation_granularity è OTHER. Chiedere al cliente di modificare l'indirizzo potrebbe contribuire a migliorarne la qualità. |
Classe USPSAddress
classe
google.maps.addressValidation.USPSAddress
libreria "addressValidation"
Rappresentazione USPS di un indirizzo statunitense.
const {USPSAddress} = await google.maps.importLibrary("addressValidation");
Proprietà | |
|---|---|
city
readonly |
Tipo:
string optionalIl nome della città. |
cityStateZipAddressLine
readonly |
Tipo:
string optionalLa riga dell'indirizzo contenente città, stato e codice postale. |
firm
readonly |
Tipo:
string optionalIl nome dell'azienda. |
firstAddressLine
readonly |
Tipo:
string optionalLa prima riga dell'indirizzo. |
secondAddressLine
readonly |
Tipo:
string optionalLa seconda riga dell'indirizzo. |
state
readonly |
Tipo:
string optionalIl codice stato di 2 lettere. |
urbanization
readonly |
Tipo:
string optionalIl nome dell'urbanizzazione portoricana. |
zipCode
readonly |
Tipo:
string optionalIl codice postale, ad esempio "10009". |
zipCodeExtension
readonly |
Tipo:
string optionalL'estensione del codice postale di 4 cifre, ad esempio "5023". |
Metodi | |
|---|---|
Ereditato:
toJSON
|
Classe USPSData
classe
google.maps.addressValidation.USPSData
libreria "addressValidation"
I dati USPS per l'indirizzo. Non è garantito che USPSData venga compilato completamente per ogni indirizzo degli Stati Uniti o di Porto Rico inviato all'API Address Validation. Se utilizzi uspsData come parte principale della risposta, ti consigliamo di integrare i campi dell'indirizzo di backup nella risposta.
const {USPSData} = await google.maps.importLibrary("addressValidation");
Proprietà | |
|---|---|
abbreviatedCity
readonly |
Tipo:
string optionalCittà abbreviata. |
addressRecordType
readonly |
Tipo:
string optionalTipo di record dell'indirizzo che corrisponde all'indirizzo di input. |
carrierRoute
readonly |
Tipo:
string optionalIl codice del percorso del corriere. Un codice di quattro caratteri composto da un prefisso di una lettera e un identificatore di rotta di tre cifre. |
carrierRouteIndicator
readonly |
Tipo:
string optionalIndicatore di ordinamento delle tariffe per il percorso del corriere. |
cassProcessed
readonly |
Tipo:
booleanIndicatore che la richiesta è stata elaborata da CASS. |
county
readonly |
Tipo:
string optionalNome della contea. |
deliveryPointCheckDigit
readonly |
Tipo:
string optionalLa cifra di controllo del punto di consegna. Questo numero viene aggiunto alla fine del delivery_point_barcode per la posta scansionata meccanicamente. La somma di tutte le cifre di delivery_point_barcode, delivery_point_check_digit, codice postale e ZIP+4 deve dare un numero divisibile per 10. |
deliveryPointCode
readonly |
Tipo:
string optionalIl codice del punto di consegna di 2 cifre. |
dpvCMRA
readonly |
Tipo:
string optionalIndica se l'indirizzo è un CMRA (Commercial Mail Receiving Agency), ovvero un'attività privata che riceve posta per i clienti. Restituisce un singolo carattere. |
dpvConfirmation
readonly |
Tipo:
string optionalI valori possibili per la conferma DPV. Restituisce un singolo carattere o non restituisce alcun valore. |
dpvDoorNotAccessible
readonly |
Tipo:
string optionalIl flag indica gli indirizzi in cui USPS non può bussare a una porta per consegnare la posta. Restituisce un singolo carattere. |
dpvDrop
readonly |
Tipo:
string optionalIl flag indica che la posta viene recapitata a un unico destinatario in un sito. Restituisce un singolo carattere. |
dpvEnhancedDeliveryCode
readonly |
Tipo:
string optionalIndica che per l'indirizzo è valido più di un codice di ritorno DPV. Restituisce un singolo carattere. |
dpvFootnote
readonly |
Tipo:
string optionalLe note a piè di pagina della convalida del punto di consegna. Più note a piè di pagina possono essere concatenate nella stessa stringa. |
dpvNonDeliveryDays
readonly |
Tipo:
string optionalIl flag indica che la consegna della posta non viene eseguita tutti i giorni della settimana. Restituisce un singolo carattere. |
dpvNonDeliveryDaysValues
readonly |
Tipo:
number optionalNumero intero che identifica i giorni di mancata consegna. Può essere interrogato utilizzando i flag di bit: 0x40 - Domenica non è un giorno di consegna 0x20 - Lunedì non è un giorno di consegna 0x10 - Martedì non è un giorno di consegna 0x08 - Mercoledì non è un giorno di consegna 0x04 - Giovedì non è un giorno di consegna 0x02 - Venerdì non è un giorno di consegna 0x01 - Sabato non è un giorno di consegna |
dpvNoSecureLocation
readonly |
Tipo:
string optionalIl flag indica che la porta è accessibile, ma il pacco non verrà lasciato per motivi di sicurezza. Restituisce un singolo carattere. |
dpvNoStat
readonly |
Tipo:
string optionalIndica se l'indirizzo è un indirizzo non statistico o un indirizzo attivo. Gli indirizzi "No stat" sono quelli che non sono occupati in modo continuativo o quelli non serviti dall'USPS. Restituisce un singolo carattere. |
dpvNoStatReasonCode
readonly |
Tipo:
number optionalIndica il tipo di NoStat. Restituisce un codice motivo come int. |
dpvPBSA
readonly |
Tipo:
string optionalIndica che l'indirizzo è stato abbinato al record PBSA. Restituisce un singolo carattere. |
dpvThrowback
readonly |
Tipo:
string optionalIndica che la posta non viene consegnata all'indirizzo. Restituisce un singolo carattere. |
dpvVacant
readonly |
Tipo:
string optionalIndica se l'indirizzo è vuoto. Restituisce un singolo carattere. |
elotFlag
readonly |
Tipo:
string optionalFlag eLOT Ascending/Descending (A/D). |
elotNumber
readonly |
Tipo:
string optionalNumero eLOT (Enhanced Line of Travel). |
errorMessage
readonly |
Tipo:
string optionalMessaggio di errore per il recupero dei dati USPS. Questo campo viene compilato quando l'elaborazione USPS viene sospesa a causa del rilevamento di indirizzi creati artificialmente. |
fipsCountyCode
readonly |
Tipo:
string optionalCodice contea FIPS. |
hasDefaultAddress
readonly |
Tipo:
booleanIndicatore che è stato trovato un indirizzo predefinito, ma esistono indirizzi più specifici. |
hasNoEWSMatch
readonly |
Tipo:
booleanL'indirizzo di consegna è abbinabile, ma il file EWS indica che a breve sarà disponibile una corrispondenza esatta. |
lacsLinkIndicator
readonly |
Tipo:
string optionalIndicatore LACSLink. |
lacsLinkReturnCode
readonly |
Tipo:
string optionalCodice di ritorno LACSLink. |
pmbDesignator
readonly |
Tipo:
string optionalIndicatore di unità PMB (Private Mail Box). |
pmbNumber
readonly |
Tipo:
string optionalNumero di casella postale privata (PMB). |
poBoxOnlyPostalCode
readonly |
Tipo:
booleanCodice postale solo per casella postale. |
postOfficeCity
readonly |
Tipo:
string optionalCittà dell'ufficio postale principale. |
postOfficeState
readonly |
Tipo:
string optionalStato dell'ufficio postale principale. |
standardizedAddress
readonly |
Tipo:
USPSAddress optionalIndirizzo standardizzato USPS. |
suiteLinkFootnote
readonly |
Tipo:
string optionalNote a piè di pagina relative alla corrispondenza tra un record di una strada o di un grattacielo e le informazioni sulla suite. Se viene trovata una corrispondenza con il nome dell'attività, viene restituito il numero secondario. |
Metodi | |
|---|---|
Ereditato:
toJSON
|
Classe Verdict
classe
google.maps.addressValidation.Verdict
libreria "addressValidation"
Rappresenta l'indirizzo post-elaborato per l'indirizzo fornito.
const {Verdict} = await google.maps.importLibrary("addressValidation");
Proprietà | |
|---|---|
addressComplete
readonly |
Tipo:
booleanL'indirizzo è considerato completo se non sono presenti token non risolti, componenti dell'indirizzo imprevisti o mancanti. Se non impostato, indica che il valore è false. Per ulteriori dettagli, consulta i campi Address.missingComponentTypes, Address.unresolvedTokens o AddressComponent.unexpected. |
geocodeGranularity
readonly |
Tipo:
Granularity optionalInformazioni sulla granularità di Geocode. Questo può essere inteso come il significato semantico di quanto è approssimativa o precisa la posizione geocodificata. |
hasInferredComponents
readonly |
Tipo:
booleanÈ stato dedotto (ovvero aggiunto) almeno un componente dell'indirizzo che non era presente nell'input. Per maggiori dettagli, consulta AddressComponent. |
hasReplacedComponents
readonly |
Tipo:
boolean optionalAlmeno un componente dell'indirizzo è stato sostituito. Per i dettagli, consulta AddressComponent. |
hasUnconfirmedComponents
readonly |
Tipo:
booleanAlmeno un componente dell'indirizzo non può essere classificato o convalidato. Per maggiori dettagli, consulta AddressComponent. |
inputGranularity
readonly |
Tipo:
Granularity optionalLa granularità dell'indirizzo di input. Questo è il risultato dell'analisi dell'indirizzo di input e non fornisce indicatori di convalida. Per gli indicatori di convalida, consulta validationGranularity. |
readonly |
Tipo:
PossibleNextAction optionalUna possibile azione successiva da intraprendere in base ad altri campi della risposta dell'API. Per ulteriori dettagli, consulta PossibleNextAction. |
validationGranularity
readonly |
Tipo:
Granularity optionalIl livello di granularità con cui l'API può convalidare completamente l'indirizzo. Ad esempio, un validationGranularity di PREMISE indica che è possibile convalidare tutti i componenti dell'indirizzo a livello di PREMISE e più ampi. |