L'API Address Validation fournit un corps de la réponse au format JSON contenant deux propriétés de niveau supérieur:
result
, un objet de typeValidationResult
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"
}
Ce document porte sur l'objet result
. Pour en savoir plus sur les
responseID
, consultez Gérer les adresses mises à jour.
Propriété verdict
La propriété verdict
résume les résultats de la validation de l'adresse et
doit être la première propriété à évaluer lors de la création de la logique de vérification des adresses.
La propriété peut renvoyer différents champs, selon la qualité de la
adresse de sortie. L'exemple suivant montre la propriété verdict
d'une
de bonne qualité, qui renvoie 4 champs pour cette requête particulière:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Les sections suivantes récapitulent tous les champs de la propriété verdict
.
Voir Verdict dans le guide de référence. |
Précision de l'adresse
La précision des adresses fait référence au niveau de détail utilisé pour déterminer
la spécificité d'une adresse ou d'un géocode. Traitez la spécificité dans le
La réponse validationGranularity
est un signal clé permettant de déterminer si une adresse
est produit livrable.
La propriété verdict
renvoie les signaux de précision suivants:
inputGranularity
: décrit le niveau de détail capturé à partir de la envoyée à l'API Address Validation. Le niveau de détail de l'adresse dans la requête influence le niveau de détail de l'adresse dans la réponse de validation. Par exemple, une adresse avec uninputGranularity
inférieur àPREMISE
ci-dessous n'entraîne généralement pas devalidationGranularity
àPREMISE
. d'application.validationGranularity
: niveau de précision auquel L'API Address Validation peut entièrement valider l'adresse. Dans la plupart des cas, Le niveau de précisionPREMISE
ouSUB_PREMISE
indique une adresse de qualité. qui est probablement livrable.geocodeGranularity
: décrit le niveau de détail du géocode associé à l'adresse. Par exemple, les enregistrements Google peuvent indiquer de l'existence d'un numéro d'appartement, mais pas de l'emplacement précis un appartement en particulier au sein d'un grand complexe. Dans ce cas,validationGranularity
correspond àSUB_PREMISE
, mais àgeocodeGranularity
is
PREMISE.
Voir Précision dans le guide de référence. |
Exhaustivité de l'adresse
Le verdict renvoie la propriété addressComplete
en tant que signal pour une
de haute qualité, c'est-à-dire
qu'il ne manque aucune adresse manquante,
des composants non résolus ou inattendus:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Si l'adresse comporte des composants manquants, non résolus ou inattendus, le champ
est défini sur false
.
Voir addressComplete à moins de
Verdict et
Adresse dans le guide de référence. |
Qualité de l'adresse
Un certain nombre de champs possibles indiquent des problèmes avec les composants d'adresse ou des ajustements apportés à ceux-ci, tels que des composants d'adresse inférés ou manquants. Pour
exemple, la propriété verdict
suivante indique une adresse dont la valeur n'est pas confirmée
et un champ addressComplete
manquant:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
Consultez la section Avis du guide de référence. |
Propriétés address
et addressComponent
La propriété address
permet de mettre en forme l'adresse traitée fournie dans
la demande, ainsi que des résumés au niveau des composants de l'adresse, y compris
fautes d'orthographe dans l'adresse, remplacement des parties incorrectes et identification des défauts manquants
de l'infrastructure.
Consultez Address dans le guide de référence. |
La propriété addressComponent
est un sous-composant de address
, qui fournit
une liste détaillée des éléments, ou composants, de l'adresse
L'API Address Validation a été traitée. L'API identifie chaque composant
indique par son nom, son type et son niveau de confirmation.
Consultez la section addressComponent dans le guide de référence. |
Propriété geocode
La propriété geocode
indique l'emplacement géocodé associé à l'entrée.
adresse e-mail. Cette propriété fournit des informations sur l'établissement lui-même, par exemple :
son identifiant de lieu.
Consultez la section Geocode dans le guide de référence. |
Propriété metadata
Il est possible que cette propriété ne soit pas renseignée pour toutes les adresses traitées par la l'API Address Validation, mais elle indique si l'adresse est de type résidentiel, entreprise ou une boîte postale.
Consultez la couverture de l'API Address Validation et la documentation de référence sur Address metadata .
|
Propriété uspsData
Cette propriété fournit des informations utiles pour les adresses postales aux États-Unis.
Toutefois, il n'est pas garanti que ce champ soit entièrement rempli pour chaque adresse validée.
par le service. C'est pourquoi vous ne devez pas vous appuyer sur cette propriété
est le seul moyen de valider les adresses, mais de vérifier les verdict
et
address
.
Consultez Gérer les adresses aux États-Unis et la référence concernant UspsData .
|