Method: validateAddress

Valida una dirección.

Solicitud HTTP

POST https://addressvalidation.googleapis.com/v1:validateAddress

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  }
}
Campos
address

object (PostalAddress)

Obligatorio. La dirección que se está validando. Las direcciones sin formato deben enviarse a través de addressLines.

La longitud total de los campos de esta entrada no debe superar los 280 caracteres.

Aquí encontrarás las regiones admitidas.

El valor languageCode de la dirección de entrada se reserva para usos futuros y se ignora hoy. El resultado de la dirección validada se propagará en función del idioma preferido de la dirección determinada, según lo que identifique el sistema.

La API de Address Validation ignora los valores en recipients y organization. Se descartarán todos los valores en esos campos y no se mostrarán. No debes establecerlas.
previousResponseId

string

Este campo debe estar vacío para la primera solicitud de validación de dirección. Si se necesitan más solicitudes para validar por completo una sola dirección (por ejemplo, si los cambios que realiza el usuario después de la validación inicial deben volver a validarse), cada solicitud de seguimiento debe propagar este campo con los responseId de la primera respuesta de la secuencia de validación.
enableUspsCass

boolean

Habilita el modo compatible con USPS CASS. Esto afecta solo al campo google.maps.addressvalidation.v1.ValidationResult.usps_data de google.maps.addressvalidation.v1.ValidationResult. Nota: Para las solicitudes de direcciones de Puerto Rico habilitadas para el CASS de USPS, se debe proporcionar una google.type.PostalAddress.region_code del address como “PR”, o bien una google.type.PostalAddress.administrative_area de address como “Puerto Rico” (distingue mayúsculas de minúsculas) o “PR”.

Se recomienda usar un elemento address con componentes o, como alternativa, especificar al menos dos google.type.PostalAddress.address_lines en los que la primera línea contenga el número y el nombre de la calle, y la segunda, la ciudad, el estado y el código postal.
languageOptions

object (LanguageOptions)

Opcional. Versión preliminar: Esta función se encuentra en versión preliminar (fase previa a la DG). Los productos y las funciones que se encuentran en la fase previa a la DG pueden tener asistencia limitada, y los cambios en estos productos y funciones podrían no ser compatibles con otras versiones de la fase previa a la DG. Las ofertas que se encuentran en la fase previa a la DG están cubiertas por las Condiciones Específicas del Servicio de Google Maps Platform. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

Habilita la API de Address Validation para incluir información adicional en la respuesta.

Cuerpo de la respuesta

Es la respuesta a una solicitud de validación de dirección.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Campos
result

object (ValidationResult)

Es el resultado de la validación de la dirección.
responseId

string

El UUID que identifica esta respuesta. Si se debe volver a validar la dirección, este UUID debe acompañar a la solicitud nueva.

PostalAddress

Representa una dirección postal, p. ej., para envíos postales o direcciones de pago. Si se proporciona una dirección postal, un servicio postal puede enviar artículos a las instalaciones, a la casilla postal o a otras ubicaciones similares. No está diseñado para modelar ubicaciones geográficas (caminos, pueblos, montañas).

En el uso común, una dirección se crearía a través de una entrada del usuario o a partir de la importación de datos existentes, según el tipo de proceso.

Consejos para ingresar o editar direcciones: - Usa un widget de dirección listo para la internacionalización, como https://github.com/google/libaddressinput). - Los usuarios no deben ver elementos de la IU para ingresar o editar campos fuera de países en los que se usa ese campo.

Para obtener orientación sobre cómo usar este esquema, consulta https://support.google.com/business/answer/6397478

Representación JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Campos
revision

integer

La revisión del esquema de PostalAddress. Cualquier valor distinto de 0 hará que la API muestre un error INVALID_ARGUMENT.
regionCode

string

Opcional. Código de región de CLDR para el país o la región de la dirección. Para obtener más información, consulta https://cldr.unicode.org/ y https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Ejemplo: "CH" para Suiza. Si no se proporciona el código de región, se inferirá de la dirección. Para obtener el mejor rendimiento, te recomendamos que incluyas el código de región (si lo conoces). Tener regiones incoherentes o repetidas puede generar un rendimiento deficiente. Por ejemplo, si addressLines ya incluye la región, no vuelvas a proporcionar el código regional en este campo. Consulta las Preguntas frecuentes para conocer las regiones admitidas.
languageCode

string

El código de idioma de la dirección de entrada se reserva para usos futuros y se ignora hoy. La API muestra la dirección en el idioma adecuado en el que se encuentra.
postalCode

string

Opcional. Código postal de la dirección. No todos los países usan o exigen la presencia de códigos postales, pero en los lugares donde se usan, es posible que activen una validación adicional con otras partes de la dirección (p. ej., validación del código postal o el estado en EE.UU.).
sortingCode

string

Opcional. Código de ordenamiento adicional específico para cada país. No se usa en la mayoría de las regiones. Cuando se usa, el valor es una string como "CEDEX", opcionalmente seguida de un número (p.ej., "CEDEX 7") o solo un número, que representa el "código del sector" (Jamaica), el "indicador del área de entrega" (Malaui) o el "indicador de oficina de correo" (p.ej., Costa de Marfil).
administrativeArea

string

Opcional. División administrativa más alta que se usa para las direcciones postales de un país o una región. Por ejemplo, puede ser un estado, una provincia, una óblast o una prefectura. Específicamente, en España se trata de la provincia y no la comunidad autónoma (p.ej., "Barcelona" y no "Cataluña"). Muchos países no usan un área administrativa en las direcciones postales. P. ej., en Suiza se dejaría vacío.
locality

string

Opcional. Por lo general, se refiere a la parte de la dirección que indica la ciudad o el pueblo. Ejemplos: ciudad de EE.UU., comuna de Italia o ciudad postal en el Reino Unido. En regiones del mundo donde las localidades no están bien definidas o no coinciden bien con esta estructura, deja la localidad vacía y usa addressLines.
sublocality

string

Opcional. Sublocalidad de la dirección. Por ejemplo, pueden ser barrios, vecindarios o distritos.
addressLines[]

string

Obligatorio. Líneas de dirección no estructuradas que describen los niveles más bajos de una dirección.

Debido a que los valores de addressLines no tienen información de tipo y, a veces, pueden contener varios valores en un solo campo (p.ej., “Austin, TX”), es importante que el orden de las líneas sea claro. El orden de las líneas de dirección debe ser el "orden de sobre" que se usa en el país o la región de la dirección.

La representación estructural mínima permitida de una dirección consiste en toda la información que se coloca en addressLines. Si no se proporciona un regionCode, la región se infiere de las líneas de dirección.

Crear una dirección que solo contenga addressLines y, luego, realizar la geocodificación es la forma recomendada de manejar direcciones sin estructura alguna (en lugar de adivinar qué partes de la dirección deben ser localidades o áreas administrativas).
recipients[]

string

Evita configurar este campo. La API de Address Validation no la usa actualmente. Aunque en este momento la API no rechazará las solicitudes con este campo configurado, la información se descartará y no se mostrará en la respuesta.
organization

string

Evita configurar este campo. La API de Address Validation no la usa actualmente. Aunque en este momento la API no rechazará las solicitudes con este campo configurado, la información se descartará y no se mostrará en la respuesta.

Opciones de idioma

Versión preliminar: Esta función se encuentra en versión preliminar (fase previa a la DG). Los productos y las funciones que se encuentran en la fase previa a la DG pueden tener asistencia limitada, y los cambios en estos productos y funciones podrían no ser compatibles con otras versiones de la fase previa a la DG. Las ofertas que se encuentran en la fase previa a la DG están cubiertas por las Condiciones Específicas del Servicio de Google Maps Platform. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

Habilita la API de Address Validation para incluir información adicional en la respuesta.

Representación JSON 
{
  "returnEnglishLatinAddress": boolean
}
Campos
returnEnglishLatinAddress

boolean

Vista previa: Muestra un google.maps.addressvalidation.v1.Address en inglés. Consulta google.maps.addressvalidation.v1.ValidationResult.english_latin_address para obtener información.

ValidationResult

El resultado de la validación de una dirección.

Representación JSON 
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
Campos
verdict

object (Verdict)

Marcas de veredicto general
address

object (Address)

Incluye información sobre la dirección en sí, a diferencia del geocódigo.
geocode

object (Geocode)

Información sobre la ubicación y el lugar a los que se geocodifica la dirección.
metadata

object (AddressMetadata)

Otra información relevante para la entrega. No se garantiza que metadata se propague por completo para cada dirección que se envía a la API de Address Validation.
uspsData

object (UspsData)

Marcas de entrega adicionales proporcionadas por USPS Solo se proporciona en las regiones US y PR.
englishLatinAddress

object (Address)

Versión preliminar: Esta función se encuentra en versión preliminar (fase previa a la DG). Los productos y las funciones que se encuentran en la fase previa a la DG pueden tener asistencia limitada, y los cambios en estos productos y funciones podrían no ser compatibles con otras versiones de la fase previa a la DG. Las ofertas que se encuentran en la fase previa a la DG están cubiertas por las Condiciones Específicas del Servicio de Google Maps Platform. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

La dirección se tradujo al inglés. Si una parte de la dirección no tiene traducción al inglés, el servicio muestra esa parte en un idioma alternativo que utilice la escritura latina. Consulta aquí una explicación sobre cómo se selecciona el idioma alternativo. Si una parte de la dirección no tiene traducciones ni transliteraciones en un idioma que utiliza un alfabeto latino, el servicio muestra esa parte en el idioma local asociado a la dirección.

Habilitaste este resultado con la marca google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Nota: Los campos google.maps.addressvalidation.v1.Address.unconfirmed_component_types en englishLatinAddress y google.maps.addressvalidation.v1.AddressComponent.confirmation_level en englishLatinAddress.address_components no se propagan.

Veredicto

Descripción general de alto nivel del resultado de la validación de dirección y el geocódigo

Representación JSON 
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Campos
inputGranularity

enum (Granularity)

El nivel de detalle de la dirección input. Este es el resultado del análisis de la dirección de entrada y no proporciona ninguna señal de validación. Para conocer los indicadores de validación, consulta validationGranularity a continuación.

Por ejemplo, si la dirección de entrada incluye un número de departamento específico, inputGranularity aquí será SUB_PREMISE. Si no podemos encontrar el número de departamento en las bases de datos o este no es válido, es probable que el validationGranularity sea PREMISE o inferior.
validationGranularity

enum (Granularity)

El nivel de detalle con el que la API puede validar por completo la dirección. Por ejemplo, un validationGranularity de PREMISE indica que se pueden validar todos los componentes de dirección en el nivel de PREMISE o más valores generales.

El resultado de la validación por componente de la dirección se puede encontrar en google.maps.addressvalidation.v1.Address.address_components.
geocodeGranularity

enum (Granularity)

Información sobre el nivel de detalle de geocode. Esto puede entenderse como el significado semántico de qué tan amplia o precisa es la ubicación geocodificada.

En ocasiones, esto puede diferir de la validationGranularity anterior. Por ejemplo, es posible que nuestra base de datos registre la existencia de un número de departamento, pero que no tenga una ubicación precisa del departamento dentro de un complejo grande de departamentos. En ese caso, el validationGranularity será SUB_PREMISE, pero el geocodeGranularity será PREMISE.
addressComplete

boolean

La dirección se considera completa si no hay tokens sin resolver ni componentes de dirección inesperados o faltantes. Consulta los campos missingComponentTypes, unresolvedTokens o unexpected para obtener más detalles.
hasUnconfirmedComponents

boolean

Al menos un componente de la dirección no se puede categorizar o validar. Consulta google.maps.addressvalidation.v1.Address.address_components para obtener más información.
hasInferredComponents

boolean

Se infirió al menos un componente de la dirección (se agregó) que no estaba en la entrada. Consulta google.maps.addressvalidation.v1.Address.address_components para obtener más información.
hasReplacedComponents

boolean

Se reemplazó al menos un componente de la dirección. Para obtener más información, consulta google.maps.addressvalidation.v1.Address.address_components.

Nivel de detalle

Los diversos niveles de nivel de detalle que puede tener una dirección o un geocódigo. Cuando se usan para indicar el nivel de detalle de una dirección, estos valores indican con qué nivel de detalle la dirección identifica un destino de correo postal. Por ejemplo, una dirección como “123 Main Street, Redwood City, CA, 94061” identifica un PREMISE, mientras que algo como “Redwood City, CA, 94061” identifica un LOCALITY. Sin embargo, si no podemos encontrar un geocódigo para “123 Main Street” en Redwood City, el geocódigo que se muestra podría tener un nivel de detalle de LOCALITY, aunque la dirección sea más detallada.

Enumeradores
GRANULARITY_UNSPECIFIED Valor predeterminado Este valor no se usa.
SUB_PREMISE Resultado del nivel inferior del edificio, como un departamento
PREMISE Resultado a nivel del edificio.
PREMISE_PROXIMITY Un geocódigo que se aproxima a la ubicación de la dirección a nivel de edificio.
BLOCK La dirección o el geocódigo indica un bloque. Solo se usa en regiones que tienen direccionamiento a nivel de bloque, como Japón.
ROUTE El geocódigo o la dirección son detallados para la ruta, como una calle, carretera o autopista.
OTHER Todos los demás niveles de detalle, que se agrupan en buckets porque no se pueden entregar

Dirección

Detalles de la dirección posterior al procesamiento. El posprocesamiento incluye la corrección de las partes con errores ortográficos de la dirección, el reemplazo de las partes incorrectas y la inferencia de las partes faltantes.

Representación JSON 
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Campos
formattedAddress

string

La dirección procesada con posterioridad, con el formato de una dirección de una sola línea según las reglas de formato de la región donde se encuentra la dirección.
postalAddress

object (PostalAddress)

La dirección después del procesamiento representada como una dirección postal.
addressComponents[]

object (AddressComponent)

Lista sin ordenar. Los componentes individuales de la dirección con formato y la corrección corregida, junto con la información de validación. Esto proporciona información sobre el estado de validación de los componentes individuales.

Los componentes de dirección no están ordenados de manera particular. No hagas suposiciones sobre el orden de los componentes de dirección en la lista.
missingComponentTypes[]

string

Los tipos de componentes que se esperaban presentes en una dirección de correo con el formato correcto, pero que no se encontraron en la entrada Y no se pudieron inferir. Los componentes de este tipo no están presentes en formattedAddress, postalAddress ni addressComponents. Un ejemplo podría ser ['street_number', 'route'] para una entrada como “Boulder, Colorado, 80301, EE.UU.”. La lista de tipos posibles se encuentra aquí.
unconfirmedComponentTypes[]

string

Los tipos de componentes que están presentes en addressComponents, pero que no se pudo confirmar como correctos Este campo se proporciona para mayor comodidad: su contenido es equivalente a iterar a través de addressComponents para encontrar los tipos de todos los componentes en los que confirmationLevel no es CONFIRMED o en los que la marca inferred no está configurada en true. La lista de tipos posibles se encuentra aquí.
unresolvedTokens[]

string

Cualquier token en la entrada que no se pudo resolver. Puede tratarse de una entrada que no se reconoció como una parte válida de una dirección (por ejemplo, en una entrada como "123235253253 Main St, San Francisco, CA, 94105"), los tokens sin resolver pueden tener el siguiente aspecto: ["123235253253"], ya que no parece un número de calle válido.

AddressComponent

Representa un componente de dirección, como una calle, una ciudad o un estado.

Representación JSON 
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
Campos
componentName

object (ComponentName)

Es el nombre de este componente.
componentType

string

El tipo del componente de la dirección. Consulta la Tabla 2: Tipos adicionales que muestra el servicio Places para obtener una lista de los tipos posibles.
confirmationLevel

enum (ConfirmationLevel)

Indica el nivel de certeza que tenemos de que el componente es correcto.
inferred

boolean

Indica que el componente no era parte de la entrada, pero lo inferimos para la ubicación de la dirección y creemos que debería proporcionarse para una dirección completa.
spellCorrected

boolean

Indica una corrección de una falta de ortografía en el nombre del componente. La API no siempre marca los cambios de una variante ortográfica a otra, como cuando cambia “centre” a “center”. Tampoco siempre se marcan los errores ortográficos comunes, como cuando se cambia "Amphitheater Pkwy" a "Amphitheatre Pkwy".
replaced

boolean

Indica que el nombre del componente se reemplazó por uno completamente diferente; por ejemplo, se reemplazó un código postal incorrecto por uno correcto para la dirección. Este no es un cambio estético, se cambió el componente de entrada por uno diferente.
unexpected

boolean

Indica un componente de dirección que no se espera que esté presente en una dirección postal de la región determinada. Lo retenemos solo porque era parte de la entrada.

NombreComponente

Es un wrapper para el nombre del componente.

Representación JSON 
{
  "text": string,
  "languageCode": string
}
Campos
text

string

Es el texto del nombre. Por ejemplo, "Quinta Avenida" para el nombre de la calle o "1253" para el número de la calle.
languageCode

string

Es el código de idioma BCP-47. No estará presente si el nombre del componente no está asociado a un idioma, como un número de calle.

Nivel de confirmación

Los diferentes valores posibles para los niveles de confirmación.

Enumeradores
CONFIRMATION_LEVEL_UNSPECIFIED Valor predeterminado Este valor no se usa.
CONFIRMED Pudimos verificar que este componente existe y tiene sentido en el contexto del resto de la dirección.
UNCONFIRMED_BUT_PLAUSIBLE No se pudo confirmar este componente, pero es posible que exista. Por ejemplo, un número de calle dentro de un rango válido de números de una calle en la que no se conocen números de casa específicos.
UNCONFIRMED_AND_SUSPICIOUS Este componente no se confirmó y es probable que sea incorrecto. Por ejemplo, un vecindario que no coincide con el resto de la dirección.

Geocodificación

Contiene información sobre el lugar hasta el cual se geocodifica la entrada.

Representación JSON 
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Campos
location

object (LatLng)

Es la ubicación geocodificada de la entrada.

Es preferible usar IDs de lugar en lugar de direcciones, coordenadas de latitud y longitud o Plus Codes. El uso de coordenadas al trazar o calcular rutas en auto siempre hará que el punto se acople a la ruta más cercana a esas coordenadas. Es posible que esta no sea una ruta que lleve al destino de forma rápida o segura y que no esté cerca de un punto de acceso a la propiedad. A su vez, cuando una ubicación se somete a geocodificación inversa, no hay garantía de que la dirección devuelta coincida con la original.
plusCode

object (PlusCode)

El Plus Code correspondiente al location.
bounds

object (Viewport)

Los límites del lugar geocodificado.
featureSizeMeters

number

Tamaño del lugar geocodificado en metros Esta es otra medida de la toscosidad de la ubicación geocodificada, pero en relación con el tamaño físico y no en el significado semántico.
placeId

string

El PlaceID del lugar al que se geocodifica esta entrada.

Para obtener más información sobre los IDs de lugar, consulta este vínculo.
placeTypes[]

string

Los tipos de sitios a los que se geocodifica la entrada. Por ejemplo, ['locality', 'political']. Puede encontrar la lista completa de tipos aquí.

LatLng

Es un objeto que representa un par de valores de latitud y longitud. Esto se expresa como un par de dobles para representar la latitud en grados y la longitud en grados. A menos que se especifique lo contrario, este objeto debe cumplir con el estándar WGS84. Los valores deben pertenecer a rangos normalizados.

Representación JSON 
{
  "latitude": number,
  "longitude": number
}
Campos
latitude

number

La latitud expresada en grados. Debe pertenecer al rango [-90.0, +90.0].
longitude

number

La longitud expresada en grados. Debe pertenecer al rango [-180.0, +180.0].

Código Plus

El código Plus (http://plus.codes) es una referencia de ubicación con dos formatos: un código global que define un rectángulo de 14 × 14 m (1/8, 000 grados) o un rectángulo más pequeño, y un código compuesto que reemplaza el prefijo por una ubicación de referencia.

Representación JSON 
{
  "globalCode": string,
  "compoundCode": string
}
Campos
globalCode

string

Código global (completo) del lugar, como "9FWM33GV+HQ", que representa un área de 1/8000 por 1/8000 grados (~14 por 14 metros).
compoundCode

string

Código compuesto del lugar, como "33GV+HQ, Ramberg, Noruega", que contiene el sufijo del código global y reemplaza el prefijo con el nombre con formato de una entidad de referencia.

Viewport

Un viewport de latitud y longitud, representado como dos puntos low y high opuestos en diagonal. Un viewport se considera una región cerrada, es decir, incluye su límite. Los límites de latitud deben variar entre -90 y 90 grados inclusive, y los límites de longitud deben variar entre -180 y 180 grados inclusive. Entre los diversos casos, se incluyen los siguientes:

  • Si low = high, el viewport consta de ese único punto.

  • Si low.longitude > high.longitude, el intervalo de longitud se invierte (el viewport cruza la línea de longitud de 180 grados).

  • Si low.longitude = -180 grados y high.longitude = 180 grados, el viewport incluye todas las longitudes.

  • Si low.longitude = 180 grados y high.longitude = -180 grados, el rango de longitud estará vacío.

  • Si low.latitude > high.latitude, el rango de latitud está vacío.

Se deben propagar low y high, y el cuadro representado no puede estar vacío (como se especifica en las definiciones anteriores). Un viewport vacío generará un error.

Por ejemplo, este viewport abarca por completo la ciudad de Nueva York:

{ "bajo": { "latitud": 40.477398, "longitud": -74.259087 }, "alta": { "latitud": 40.91618, "longitud": -73.70018 } }

Representación JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Campos
low

object (LatLng)

Obligatorio. Punto bajo del viewport
high

object (LatLng)

Obligatorio. El punto alto del viewport.

Metadatos de la dirección

Los metadatos de la dirección. No se garantiza que metadata se propague por completo para cada dirección que se envía a la API de Address Validation.

Representación JSON 
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Campos
business

boolean

Indica que esta es la dirección de una empresa. Si no se establece, indica que el valor es desconocido.
poBox

boolean

Indica la dirección de un apartado postal. Si no se establece, indica que el valor es desconocido.
residential

boolean

Indica que esta es la dirección de una residencia. Si no se establece, indica que el valor es desconocido.

Datos de USP

Los datos de USPS para la dirección. No se garantiza que uspsData se propague por completo en todas las direcciones de EE.UU. o de PR que se envían a la API de Address Validation. Si usas uspsData como la parte principal de la respuesta, se recomienda integrar los campos de dirección de copia de seguridad en la respuesta.

Representación JSON 
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
Campos
standardizedAddress

object (UspsAddress)

Dirección estandarizada del USPS.
deliveryPointCode

string

Código de punto de entrega de 2 dígitos
deliveryPointCheckDigit

string

Es el dígito de control del punto de entrega. Este número se agrega al final del código de barras delivery_point_barcode para el correo electrónico analizado de forma mecánica. Si agregas todos los dígitos de delivery_point_barcode, deliveryPointCheckDigit, código postal y ZIP+4, deberías obtener un número divisible por 10.
dpvConfirmation

string

Son los valores posibles para la confirmación de DPV. Muestra un solo carácter.

  • Y: Se confirmó la dirección DPV para los números principales y secundarios.
  • N: No se pudo confirmar la información del número principal ni el secundario.
  • S: Se confirmó la dirección solo para el número principal y la información del número secundario estaba presente, pero no se confirmó.
  • D: Se confirmó la dirección solo para el número principal y faltaba la información del número secundario.
dpvFootnote

string

Las notas al pie de la validación del punto de entrega. Es posible que varias notas al pie estén juntas en la misma string.

  • AA: La dirección de entrada coincide con el archivo ZIP+4.
  • A1: La dirección de entrada no coincide con el archivo ZIP+4.
  • BB: Coincide con DPV (todos los componentes)
  • CC: Número secundario no coincidente (presente, pero no válido)
  • N1: Falta el número secundario en la dirección de gran altura
  • M1: Falta el número principal
  • M3: Número principal no válido
  • P1: Falta el número de casilla de la dirección de entrada RR o del Centro de ayuda
  • P3: El número de la orden de compra de la dirección de entrada, RR o HC no es válido.
  • F1: La dirección de entrada coincide con una dirección militar
  • G1: La dirección de entrada coincide con una dirección de entrega general
  • U1: La dirección de entrada coincide con un código postal único.
  • PB: La dirección de entrada coincide con el registro PBSA.
  • RR: DPV confirmó una dirección con información de PMB
  • R1: Dirección confirmada por DPV sin información de PMB
  • R7: registro de la ruta R777 o R779 del proveedor
dpvCmra

string

Indica si la dirección es una CMRA (agencia de recepción de correo comercial), una empresa privada que recibe correo para los clientes. Muestra un solo carácter.

  • Y: La dirección corresponde a una CMRA
  • N: La dirección no pertenece a la CMRA
dpvVacant

string

¿Está vacante este lugar? Muestra un solo carácter.

  • Y: La dirección está vacante
  • N: La dirección no está vacante
dpvNoStat

string

¿Es una dirección sin estadísticas o una dirección activa? Ninguna dirección estadística es aquella que no se ocupa continuamente o que no brinda el servicio USPS. Muestra un solo carácter.

  • Y: La dirección no está activa
  • N: La dirección está activa
carrierRoute

string

Es el código de ruta de la empresa de transporte. Es un código de cuatro caracteres que consta de un prefijo de una letra y un designador de ruta de tres dígitos.

Prefijos:

  • C: Ruta de la empresa de transporte (o ruta de la ciudad)
  • R: Ruta rural
  • H: Ruta de contrato de autopista
  • B: Sección de apartado postal
  • G: Unidad de entrega general
carrierRouteIndicator

string

Indicador de orden de tarifa de la ruta de la empresa de transporte.
ewsNoMatch

boolean

La dirección de entrega coincide, pero el archivo EWS indica que una coincidencia exacta estará disponible pronto.
postOfficeCity

string

Ciudad principal de la oficina de correos.
postOfficeState

string

Estado principal de la oficina de correos
abbreviatedCity

string

Ciudad abreviada.
fipsCountyCode

string

Código del condado del FIPS.
county

string

Nombre del condado.
elotNumber

string

Número de línea de viaje mejorada (eLOT).
elotFlag

string

eLOT ascendente/descendente (A/D).
poBoxOnlyPostalCode

boolean

Código postal solo para apartado postal.
pmbDesignator

string

Designador de unidades de PMB (buzón privado).
pmbNumber

string

Número de PMB (buzón de correo privado);
addressRecordType

string

El tipo de registro de dirección que coincide con la dirección de entrada.

  • F: FIRM. Esto coincide con un registro de la empresa, que es el mejor nivel de coincidencia disponible para una dirección.
  • G: ENTREGA GENERAL. Esto coincide con un registro de entrega general.
  • H: EDICIÓN O Departamento. Esto coincide con un registro de edificio o departamento.
  • P: RECURSO DE OFICINA. Esto coincide con un apartado postal.
  • R: CONTRATO DE RUTA RURAL o CARTERA: Es una coincidencia con un registro de ruta rural o contrato de autopista, que pueden tener rangos de números de casilla asociados.
  • S: STREET RECORD: Es una coincidencia con un registro de Street Record que contiene un rango de números primarios válido.
defaultAddress

boolean

Indicador de que se encontró una dirección predeterminada, pero existen direcciones más específicas.
errorMessage

string

Mensaje de error para la recuperación de datos del USPS. Se propaga cuando se suspende el procesamiento de la USPS debido a la detección de direcciones creadas de forma artificial.

Es posible que los campos de datos de USPS no se propaguen cuando se presente este error.
cassProcessed

boolean

Indicador de que se procesó la solicitud de CASS.

Dirección de US

Representación del USPS de una dirección de EE.UU.

Representación JSON 
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
Campos
firstAddressLine

string

Primera línea de dirección.
firm

string

Nombre de la empresa.
secondAddressLine

string

Segunda línea de dirección.
urbanization

string

Nombre de la urbanización puertorriqueña.
cityStateZipAddressLine

string

Ciudad + estado + código postal.
city

string

Nombre de la ciudad.
state

string

Código de estado de 2 letras.
zipCode

string

Código postal, p.ej., 10009.
zipCodeExtension

string

Extensión de código postal de 4 dígitos, p.ej., 5023.