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

La API de Address Validation proporciona un cuerpo de respuesta como un archivo JSON que contiene dos propiedades de nivel superior:

• result, un objeto de tipo ValidationResult
• 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"
}

Este documento se enfoca en el objeto result. Para obtener información sobre el responseID, consulta Cómo controlar direcciones actualizadas.

La propiedad verdict

La propiedad verdict resume los resultados de la validación de la dirección y debería ser la primera propiedad que se debe evaluar cuando se compila la lógica de verificación de direcciones. La propiedad puede mostrar una variedad de campos, según la calidad de la de salida. Por ejemplo, a continuación, se muestra la propiedad verdict de un de buena calidad, que devuelve 4 campos para esta solicitud en particular:

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

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

El nivel de detalle de la dirección se refiere al nivel de detalle que se usa para determinar la la especificidad de una dirección o un geocódigo. La especificidad de la dirección La respuesta validationGranularity es un indicador clave de si una dirección es entregable.

La propiedad verdict muestra estos indicadores de nivel de detalle:

• inputGranularity: describe el nivel de detalle capturado desde el de servicio enviada a la API de Address Validation. El nivel de detalle de la dirección en la 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 inferior a PREMISE debajo Por lo general, el nivel no da como resultado una validationGranularity a una PREMISE. a nivel de organización.
• validationGranularity: Es el nivel de detalle que tiene el La API de Address Validation puede validar por completo la dirección. En la mayoría de los casos, un el nivel de detalle de PREMISE o SUB_PREMISE indica que se trata de una dirección de calidad que es probable que se entregue.
• geocodeGranularity: Describe el nivel de detalle del geocódigo. asociado a la dirección. Por ejemplo, los registros de Google pueden indicar la la existencia de un número de departamento, pero no su ubicación precisa departamento en un gran complejo de departamentos. En ese caso, el validationGranularity es SUB_PREMISE, pero la geocodeGranularityisPREMISE`.

Consulta Nivel de detalle en la guía de referencia.

Integridad de la dirección

El veredicto muestra la propiedad addressComplete como indicador para un dirección de alta calidad, lo que significa que no falta ninguna dirección, componentes no resueltos 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 configura en false.

Ver addressComplete en Veredicto y Dirección 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, como componentes de dirección inferidos o faltantes. Para ejemplo, la siguiente propiedad verdict indica una dirección con componentes y un campo addressComplete faltante:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}

Consulta el Veredicto en la guía de referencia.

Las propiedades address y addressComponent

La propiedad address proporciona formato para la dirección procesada que se proporciona en la solicitud, junto con resúmenes a nivel de componente de la dirección, lo que incluye partes de la dirección mal escritas, reemplazadas partes incorrectas e inferidos faltantes partes interesadas.

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 a la que Se procesó la API de Address Validation. La API identifica cada componente 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 entrada. web. Esta propiedad proporciona detalles sobre la ubicación en sí, como los siguientes: su ID de lugar.

Consulta Geocode en la guía de referencia.

La propiedad metadata

Es posible que esta propiedad no se complete con todas las direcciones que procesa el API de Address Validation, pero indica si la dirección es de tipo residencial. tu empresa o un apartado postal.

Consulta Cobertura de la API de Address Validation y la referencia para Address metadata.

La propiedad uspsData

Esta propiedad proporciona información útil sobre las direcciones postales de Estados Unidos. Sin embargo, no se garantiza que los datos se completen en todas las direcciones validadas por el servicio. Por ese motivo, no debes confiar en esta propiedad como el único medio para validar direcciones, pero debes verificar el verdict y address.

Consulta Cómo administrar direcciones de Estados Unidos y la referencia de UspsData.