L'API Address Validation fournit un corps de la réponse sous forme d'objet JSON contenant deux propriétés de niveau supérieur:
result, un objet de typeValidationResultresponseID
{
"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 se concentre sur l'objet result. Pour en savoir plus sur responseID, consultez Gérer les adresses mises à jour.
La 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 d'adresse.
La propriété peut renvoyer divers champs, en fonction de la qualité de l'adresse de sortie. Par exemple, voici la propriété verdict d'une adresse de bonne qualité, qui renvoie quatre 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.
| Consultez la section Verdict dans le guide de référence. |
Précision de l'adresse
La précision d'une adresse fait référence au niveau de détail utilisé pour déterminer la spécificité d'une adresse ou d'un geocoding. La spécificité d'adresse dans la réponse validationGranularity est un signal clé qui permet de déterminer si une adresse peut être livrée ou non.
La propriété verdict renvoie les signaux de précision suivants:
inputGranularity: décrit le niveau de détail capturé à partir de l'adresse 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 dont lainputGranularityest inférieure àPREMISEen dessous du niveau n'entraîne généralement pas une conversion devalidationGranularityà un niveauPREMISE.validationGranularity: niveau de précision par lequel l'API Address Validation peut valider entièrement l'adresse. Dans la plupart des cas, un niveau de précision dePREMISEouSUB_PREMISEindique une adresse de qualité qui est probablement livrable.geocodeGranularity: décrit le niveau de détail du geocoding associé à l'adresse. Par exemple, les enregistrements Google peuvent indiquer l'existence d'un numéro d'appartement, mais pas son emplacement précis au sein d'un grand complexe d'appartements. Dans ce cas,validationGranularityestSUB_PREMISE, maisgeocodeGranularityisPREMISE`.
| Consultez la section Précision dans le guide de référence. |
Exhaustivité de l'adresse
Le verdict renvoie la propriété addressComplete en tant que signal d'une adresse de haute qualité, ce qui signifie spécifiquement qu'elle ne comporte aucun composant manquant, non résolu ou inattendu:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Lorsque l'adresse comporte des composants manquants, non résolus ou inattendus, le champ est défini sur false.
Consultez addressComplete sous Verdict et Address (Adresse) dans le guide de référence. |
Qualité de l'adresse
Un certain nombre de champs possibles indiquent des problèmes liés aux composants d'adresse, ou des ajustements à ces composants, tels que des composants d'adresse déduits ou manquants. Par exemple, la propriété verdict suivante indique une adresse avec des composants non confirmés et un champ addressComplete manquant:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
| Consultez la section Verdict dans le guide de référence. |
Propriétés address et addressComponent
La propriété address fournit la mise en forme de l'adresse traitée fournie dans la requête, ainsi que des résumés de l'adresse au niveau des composants, y compris les parties mal orthographiées de l'adresse, les parties incorrectes remplacées et les parties manquantes déduites.
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 traités par l'API Address Validation. L'API identifie chaque champ de composant fourni par son nom, son type et son niveau de confirmation.
Consultez addressComponent dans le guide de référence. |
La propriété geocode
La propriété geocode indique le lieu géocodé associé à l'adresse d'entrée. Cette propriété fournit des informations sur l'établissement lui-même, comme son ID de lieu.
Consultez Geocode dans le guide de référence. |
La propriété metadata
Il est possible que cette propriété ne soit pas renseignée pour chaque adresse traitée par l'API Address Validation, mais elle indique si l'adresse est de type "résidentiel", "professionnel" ou "boîte postale".
Consultez la couverture de l'API Address Validation et la documentation de référence sur Address metadata.
|
La propriété uspsData
Cette propriété fournit des informations utiles pour les adresses postales aux États-Unis.
Toutefois, il n'est pas garanti qu'il soit entièrement renseigné pour chaque adresse validée par le service. C'est pourquoi vous ne devez pas vous fier à cette propriété comme seul moyen de valider les adresses. Vérifiez également verdict et address.
Consultez Gérer les adresses aux États-Unis et la documentation de référence sur UspsData.
|