L'API di convalida degli indirizzi fornisce un corpo della risposta come oggetto JSON che contiene due proprietà di primo livello:
result
, un oggetto di tipoValidationResult
responseID
{
"result": {
// Validation verdict.
"verdict": {},
// Address details determined by the API.
"address": {},
// The geocode generated for the input address.
"geocode": {},
// Information indicating if the address is a business, residence, etc.
"metadata": {},
// Information about the address from the US Postal Service
// ("US" and "PR" addresses only).
"uspsData": {},
},
// A unique identifier generated for every request to the API.
"responseId": "ID"
}
Questo documento è incentrato sull'oggetto result
. Per informazioni sul
responseID
, vedi Gestire gli indirizzi aggiornati.
La proprietà verdict
La proprietà verdict
riassume i risultati della convalida degli indirizzi e
dovrebbe essere la prima proprietà da valutare durante la creazione della logica di controllo degli indirizzi.
La proprietà può restituire diversi campi, a seconda della qualità del
l'indirizzo di output. Ad esempio, di seguito è riportata la proprietà verdict
di un
indirizzo di buona qualità, che restituisce 4 campi per questa richiesta specifica:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Le seguenti sezioni riepilogano tutti i campi della proprietà verdict
.
Consulta Esito nella guida di riferimento. |
Granularità dell'indirizzo
La granularità dell'indirizzo si riferisce al livello di dettaglio utilizzato per determinare la specificità di un indirizzo o di un codice geografico. Indirizza la specificità nel
La risposta validationGranularity
è un indicatore chiave che indica se un indirizzo
la soluzione è da considerarsi.
La proprietà verdict
restituisce i seguenti indicatori di granularità:
inputGranularity
: descrive il livello di dettaglio acquisito dall'elemento indirizzo IP inviato all'API Address Validation. Il livello di dettaglio dell'indirizzo nella richiesta influisce sul livello di dettaglio dell'indirizzo nella risposta di convalida. Ad esempio, un indirizzo coninputGranularity
inferiore aPREMISE
sotto livello non dà generalmente unvalidationGranularity
a unPREMISE
livello.validationGranularity
: il livello di granularità L'API Address Validation può convalidare completamente l'indirizzo. Nella maggior parte dei casi, un livello di granularità diPREMISE
oSUB_PREMISE
indica un indirizzo di qualità che probabilmente è realizzabile.geocodeGranularity
: descrive il livello di dettaglio del codice geografico associato all'indirizzo. Ad esempio, i record di Google potrebbero indicare l'esistenza di un numero di appartamento, ma non la posizione esatta un particolare appartamento all'interno di un grande complesso residenziale. In questo caso,validationGranularity
èSUB_PREMISE
, mageocodeGranularity
is
PREMISE.
Consulta la sezione Granularità della guida di riferimento. |
Completezza dell'indirizzo
L'esito restituisce la proprietà addressComplete
come indicatore per un
di alta qualità, vale a dire che non manca,
non risolti o non previsti:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Se l'indirizzo ha componenti mancanti, non risolti o imprevisti, il campo
è impostato su false
.
Vedi addressComplete in
Esito e
Indirizzo nella guida di riferimento. |
Qualità dell'indirizzo
Una serie di possibili campi indica problemi con i componenti degli indirizzi oppure
ad esempio, componenti indirizzo dedotti o mancanti. Ad esempio, la seguente proprietà verdict
indica un indirizzo con componenti non confermati e un campo addressComplete
mancante:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
Consulta il Esito nella guida di riferimento. |
Le proprietà address
e addressComponent
La proprietà address
fornisce la formattazione per l'indirizzo elaborato fornito in
la richiesta, insieme ai riepiloghi a livello di componente dell'indirizzo, tra cui
parti dell'indirizzo con errori ortografici, parti errate sostituite e ipotesi mancanti
parti.
Consulta Address nella guida di riferimento. |
La proprietà addressComponent
è un sottocomponente di address
che fornisce
un elenco dettagliato degli elementi (o componenti) dell'indirizzo
L'API Address Validation è stata elaborata. L'API identifica ogni componente
fornito in base a nome, tipo e livello di conferma.
Consulta addressComponent nella guida di riferimento. |
La proprietà geocode
La proprietà geocode
indica la posizione geocodificata associata all'input
. Questa proprietà fornisce dettagli sulla località stessa, ad esempio
l'ID della sua posizione.
Consulta Geocode nella guida di riferimento. |
La proprietà metadata
Questa proprietà potrebbe non essere compilata per ogni indirizzo elaborato dall'API Address Validation, ma indica se l'indirizzo è di tipo residenziale, aziendale o una casella postale.
Vedi Copertura API Address Validation e il riferimento per Address metadata .
|
La proprietà uspsData
Questa proprietà fornisce informazioni utili per gli indirizzi postali degli Stati Uniti.
Tuttavia, non è garantito che il completamento sia stato completato per ogni indirizzo convalidato
dal servizio. Per questo motivo, non devi considerare questa proprietà come
significa convalidare gli indirizzi, ma controllare verdict
e
address
.
Vedi Gestire gli indirizzi degli Stati Uniti e il riferimento per UspsData .
|