Comprendre une réponse de validation d'adresse de base

La réponse de l'API Address Validation contient les propriétés de premier niveau suivantes :

{
  // Address details determined by the API.
  "address": {},
  // Validation verdict.
  "verdict": {},
  // 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"
}

Propriété verdict

La propriété verdict résume les résultats de la validation d'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 différents champs, en fonction de la qualité de l'adresse de sortie. Par exemple, l'exemple suivant montre la propriété verdict d'une adresse de bonne qualité, qui renvoie les champs suivants pour cette requête spécifique :

"verdict": {
  "inputGranularity": "PREMISE",
  "validationGranularity": "PREMISE",
  "geocodeGranularity": "PREMISE",
  "possibleNextAction": "ACCEPT",
  "addressComplete": true,
  "hasUnconfirmedComponents": false,
  "hasInferredComponents": true,
  "hasReplacedComponents": false
}

Les sections suivantes récapitulent tous les champs de la propriété verdict.

Granularité de l'adresse

La précision de l'adresse fait référence au niveau de détail utilisé pour déterminer la spécificité d'une adresse ou d'un code géographique. La spécificité de l'adresse dans la réponse validationGranularity est un signal clé pour déterminer si une adresse est livrable 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 à Address Validation dans l'API Maps JavaScript. 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 un inputGranularity inférieur au niveau PREMISE n'entraîne généralement pas de validationGranularity vers un niveau PREMISE.
• validationGranularity : niveau de précision auquel l'API Address Validation dans l'API Maps JavaScript peut valider entièrement l'adresse. Dans la plupart des cas, un niveau de précision de PREMISE ou SUB_PREMISE indique une adresse de qualité qui est probablement livrable.
• geocodeGranularity : décrit le niveau de détail du code géographique associé à l'adresse. Par exemple, les enregistrements Google peuvent indiquer l'existence d'un numéro d'appartement, mais pas la position exacte de cet appartement dans un grand complexe résidentiel. Dans ce cas, l'validationGranularity est SUB_PREMISE, mais l'geocodeGranularity est PREMISE.

Exhaustivité de l'adresse

Le verdict renvoie la propriété addressComplete comme 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.

Qualité de l'adresse

Un certain nombre de champs possibles indiquent des problèmes liés aux composants d'adresse ou des ajustements de 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
}

Action suivante possible

Le champ de verdict possibleNextAction fournit un résumé interprétatif de la réponse de l'API, destiné à vous aider à déterminer une éventuelle action ultérieure à entreprendre. Ce champ est dérivé d'autres champs de la réponse de l'API et ne doit pas être considéré comme une garantie de l'exactitude ou de la distribution de l'adresse.

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 de l'adresse mal orthographiées, les parties incorrectes remplacées et les parties manquantes déduites.

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 que l'API Address Validation dans Maps JavaScript a traités. L'API identifie chaque champ de composant fourni par son nom, son type et son niveau de confirmation.

Propriété geocode

La propriété geocode indique l'emplacement géocodé associé à l'adresse d'entrée. Cette propriété fournit des détails sur l'emplacement lui-même, comme son ID de lieu.

Propriété metadata

Cette propriété n'est pas forcément renseignée pour toutes les adresses traitées par l'API Address Validation dans l'API Maps JavaScript, mais elle indique si l'adresse est de type résidentiel, professionnel ou s'il s'agit d'une boîte postale.

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, mais également vérifier verdict et address.