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 de l'adresse. Il s'agit de la première propriété à évaluer lors de la création d'une 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'extrait 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.

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 géocode. La spécificité de l'adresse dans la réponse validationGranularity est un signal clé pour déterminer si une adresse est distribuable 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 dans 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 dont le niveau inputGranularity est inférieur à PREMISE ne génère généralement pas de validationGranularity au niveau PREMISE.
• validationGranularity : niveau de précision auquel l'API Address Validation dans Maps JavaScript peut valider complètement l'adresse. Dans la plupart des cas, un niveau de précision PREMISE ou SUB_PREMISE indique une adresse de qualité qui est probablement distribuable.
• geocodeGranularity : décrit le niveau de détail du géocode associé à l'adresse. Par exemple, les enregistrements Google peuvent indiquer l'existence d'un numéro d'appartement, mais pas l'emplacement précis de cet appartement dans un grand complexe résidentiel. Dans ce cas, validationGranularity est SUB_PREMISE, mais 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 plus précisément 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 avec les composants d'adresse ou des ajustements apportés à ceux-ci, tels que des composants d'adresse inférés 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 offre un résumé interprétatif de la réponse de l'API, destiné à 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écapitulatifs au niveau des composants de l'adresse, y compris les parties 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ée. L'API identifie chaque champ de composant fourni par son nom, son type et son niveau de confirmation.

Propriété geocode