Comprende la respuesta básica de validación de la dirección

La respuesta de la API de Address Validation contiene estas propiedades de nivel superior:

{
  // 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"
}

La propiedad verdict

La propiedad verdict resume los resultados de la validación de la dirección y debe ser la primera propiedad que se evalúe cuando se compile la lógica de verificación de direcciones. La propiedad puede devolver una variedad de campos, según la calidad de la dirección de salida. Por ejemplo, a continuación, se muestra la propiedad verdict de una dirección de buena calidad, que devuelve los siguientes campos para esta solicitud en particular:

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

En las siguientes secciones, se resumen todos los campos de la propiedad verdict.

Consulta Veredicto en la guía de referencia.

Nivel de detalle de la dirección

La nivel de detalle de la dirección se refiere al nivel de detalle que se usa para determinar la especificidad de una dirección o geocodificación. La especificidad de la dirección en la respuesta de validationGranularity es un indicador clave de si una dirección se puede entregar o no.

La propiedad verdict devuelve estos indicadores de nivel de detalle:

  • inputGranularity: Describe el nivel de detalle capturado de la dirección enviada a la API de Address Validation en la API de Maps JavaScript. El nivel de detalle de la dirección en la solicitud influye en el nivel de detalle de la dirección en la respuesta de validación. Por ejemplo, una dirección con un inputGranularity por debajo del nivel PREMISE no suele dar como resultado un validationGranularity en un nivel PREMISE.
  • validationGranularity: Es el nivel de detalle con el que la API de Address Validation en la API de Maps JavaScript puede validar por completo la dirección. En la mayoría de los casos, un nivel de detalle de PREMISE o SUB_PREMISE indica una dirección de calidad que es probable que se pueda entregar.
  • geocodeGranularity: Describe el nivel de detalle de la geocodificación asociada con la dirección. Por ejemplo, los registros de Google podrían indicar la existencia de un número de departamento, pero no una ubicación precisa para ese departamento en particular dentro de un gran complejo de departamentos. En ese caso, el validationGranularity es SUB_PREMISE, pero el geocodeGranularity es PREMISE.
Consulta Granularidad en la guía de referencia.

Integridad de la dirección

El veredicto devuelve la propiedad addressComplete como un indicador de una dirección de alta calidad, lo que significa específicamente que no tiene componentes faltantes, sin resolver o inesperados:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "PREMISE",
    "geocodeGranularity": "PREMISE",
    "addressComplete": true
}

Cuando la dirección tiene componentes faltantes, sin resolver o inesperados, el campo se establece en false.

Consulta addressComplete en Verdict y Address en la guía de referencia.

Calidad de la dirección

Varios campos posibles indican problemas con los componentes de la dirección o ajustes en ellos, como componentes de la dirección inferidos o faltantes. Por ejemplo, la siguiente propiedad verdict indica una dirección con componentes sin confirmar y un campo addressComplete faltante:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}
Consulta Veredicto en la guía de referencia.

Posible próxima acción

El campo de veredicto possibleNextAction ofrece un resumen interpretativo de la respuesta de la API, con el objetivo de ayudar a determinar una posible acción posterior que se deba realizar. Este campo se deriva de otros campos de la respuesta de la API y no debe considerarse como una garantía de la exactitud o la capacidad de entrega de la dirección.

Las propiedades address y addressComponent

La propiedad address proporciona el formato de la dirección procesada que se proporciona en la solicitud, junto con resúmenes a nivel de componente de la dirección, incluidas las partes de la dirección con errores ortográficos, las partes incorrectas reemplazadas y las partes faltantes inferidas.

Consulta Address en la guía de referencia.

La propiedad addressComponent es un subcomponente de address que proporciona una lista detallada de los elementos o componentes de la dirección que procesó la API de Address Validation en Maps JavaScript. La API identifica cada campo de componente que proporciona por su nombre, tipo y nivel de confirmación.

Consulta addressComponent en la guía de referencia.

La propiedad geocode

La propiedad geocode indica la ubicación geocodificada asociada con la dirección de entrada. Esta propiedad proporciona detalles sobre la ubicación en sí, como su ID de lugar.

Consulta Geocode en la guía de referencia.

La propiedad metadata

Es posible que esta propiedad no se complete para todas las direcciones que procesa la API de Address Validation en Maps JavaScript, pero indica si la dirección es de tipo residencial, comercial o un apartado postal.

Consulta la cobertura de la API de Address Validation y la referencia de Address metadata.

La propiedad uspsData

Esta propiedad proporciona información útil para las direcciones postales de Estados Unidos. Sin embargo, no se garantiza que se complete por completo para cada dirección que valide el servicio. Por ese motivo, no debes confiar en esta propiedad como el único medio para validar direcciones, sino que también debes verificar verdict y address.

Consulta Cómo controlar las direcciones de Estados Unidos y la referencia de USPSData.