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)
  },
  "sessionToken": string
}
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.

Puedes encontrar las regiones admitidas aquí.

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 para la dirección dada, que identifica el sistema.

La API de Address Validation ignora los valores de recipients y organization. Cualquier valor en esos campos se descartará y no se mostrará. No las establezcas.
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 completar este campo con el responseId de la primera respuesta en 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: En el caso de las solicitudes del CASS del USPS habilitadas para direcciones en Puerto Rico, se debe proporcionar un google.type.PostalAddress.region_code de address como "PR" o un google.type.PostalAddress.administrative_area de address como "Puerto Rico". (no distingue mayúsculas de minúsculas) o “PR”.

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

object (LanguageOptions)

Opcional. Versión preliminar: Esta función está 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 se rigen por las Condiciones Específicas de los Servicios de Google Maps Platform. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

Permite que la API de Address Validation incluya información adicional en la respuesta.
sessionToken

string

Opcional. Es una cadena que identifica una sesión de Autocomplete con fines de facturación. Debe ser una string base64 segura de URL y nombre de archivo con un máximo de 36 caracteres ASCII de longitud. De lo contrario, se muestra un error INVALID_ARGUMENT.

La sesión comienza cuando el usuario realiza una consulta a Autocomplete y termina cuando selecciona un lugar y se realiza una llamada a Place Details o Address Validation. Cada sesión puede tener varias consultas de Autocomplete, seguidas de una solicitud de Place Details o Address Validation. Las credenciales que se usan para cada solicitud dentro de una sesión deben pertenecer al mismo proyecto de la consola de Google Cloud. Una vez que finaliza la sesión, el token deja de ser válido. tu app debe generar un token nuevo para cada sesión. Si se omite el parámetro sessionToken, o si reutilizas un token de sesión, la sesión se cobrará como si no se hubiera proporcionado un token de sesión (cada solicitud se factura por separado).

Nota: Address Validation solo se puede usar en sesiones con la API de Autocomplete (nueva), no en la API de Autocomplete. Para obtener más información, consulta https://developers.google.com/maps/documentation/places/web-service/session-pricing.

Cuerpo de la respuesta

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)

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

string

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

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 sobre el ingreso o la edición de direcciones: - Usa un widget de dirección preparado 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. Consulta https://cldr.unicode.org/ y https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html para obtener detalles. 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. Puedes encontrar las regiones admitidas en las Preguntas frecuentes.
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 según el cual se encuentra la dirección.
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 utiliza, el valor es una cadena como "CEDEX", opcionalmente seguida de un número (p.ej., "CEDEX 7"), o solo un número, que representa el "código de sector" (Jamaica), "indicador del área de entrega" (Malaui) o "indicador de oficina de correos" (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 el caso de España, corresponde a la provincia y no a 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 en addressLines no tienen información de tipo y, en ocasiones, 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 incluye 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, aplicar geocodificación es la forma recomendada de controlar direcciones completamente no estructuradas (en lugar de adivinar qué partes de la dirección deben ser localidades o áreas administrativas).
recipients[]

string

Evita configurar este campo. Actualmente, la API de Address Validation no la usa. Si bien 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. Actualmente, la API de Address Validation no la usa. Si bien 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.

LanguageOptions

Versión preliminar: Esta función está 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 se rigen por las Condiciones Específicas de los Servicios de Google Maps Platform. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

Permite que la API de Address Validation incluya 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

Es 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í misma, 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 esté completamente propagado para todas las direcciones enviadas a la API de Address Validation.
uspsData

object (UspsData)

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

object (Address)

Versión preliminar: Esta función está 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 se rigen por las Condiciones Específicas de los Servicios de Google Maps Platform. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

La dirección traducida al inglés.

Las direcciones traducidas no se pueden reutilizar como entrada de la API. El servicio las proporciona para que el usuario pueda usar su idioma nativo para confirmar o rechazar la validación de la dirección proporcionada originalmente.

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

Habilita 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 direcciones y 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. Es el resultado del análisis de la dirección de entrada y no proporciona indicadores de validación. Para conocer los indicadores de validación, consulta validationGranularity a continuación.

Por ejemplo, si la dirección ingresada incluye un número de departamento específico, la inputGranularity aquí será SUB_PREMISE. Si no podemos hacer coincidir el número de departamento que aparece en las bases de datos o si este no es válido, es probable que el valor de validationGranularity sea PREMISE o menor.
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 PREMISE o más generales.

Puedes encontrar el resultado de la validación de componentes por dirección en google.maps.addressvalidation.v1.Address.address_components.
geocodeGranularity

enum (Granularity)

Información sobre el nivel de detalle de geocode. Esto se puede interpretar como el significado semántico de cuán amplia o precisa es la ubicación geocodificada.

En ocasiones, esto puede diferir de la validationGranularity anterior. Por ejemplo, nuestra base de datos podría registrar la existencia de un número de departamento, pero no tener una ubicación precisa de este dentro de un gran complejo de departamentos. En ese caso, validationGranularity será SUB_PREMISE, pero 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. Si no está establecido, indica que el valor es false. Consulta los campos missingComponentTypes, unresolvedTokens o unexpected para obtener más detalles.
hasUnconfirmedComponents

boolean

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

boolean

Se infirió (agregó) al menos un componente de dirección 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. Consulta google.maps.addressvalidation.v1.Address.address_components para obtener más información.

Nivel de detalle

Los distintos niveles 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 "Calle Principal 123, 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 "Calle Principal 123" En Redwood City, el geocódigo que se muestra puede tener un nivel de detalle LOCALITY, aunque la dirección sea más detallada.

Enumeraciones
GRANULARITY_UNSPECIFIED Valor predeterminado Este valor no se usa.
SUB_PREMISE Resultado por debajo del nivel del edificio, como un departamento.
PREMISE Resultado a nivel del edificio.
PREMISE_PROXIMITY Es un geocódigo que aproxima la ubicación de la dirección a nivel del edificio.
BLOCK La dirección o el geocódigo indican un bloque. Solo se usa en regiones que tienen direcciones a nivel de bloques, como Japón.
ROUTE El geocódigo o la dirección son detallados para la ruta, como una calle, una calle o una autopista.
OTHER Todos los demás niveles de detalle, que se agrupan porque no son entregables.

Dirección

Detalles de la dirección con procesamiento posterior. El procesamiento posterior incluye corregir partes mal escritas de la dirección, reemplazar las partes incorrectas e inferir 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 con procesamiento posterior, con el formato de una dirección de una sola línea que sigue las reglas de formato de dirección de la región donde se encuentra la dirección.
postalAddress

object (PostalAddress)

La dirección con procesamiento posterior representada como una dirección postal.
addressComponents[]

object (AddressComponent)

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

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

string

Los tipos de componentes que se esperaban que estuvieran 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 puede encontrar aquí.
unconfirmedComponentTypes[]

string

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

string

Cualquier token en la entrada que no se pudo resolver. Esta podría ser 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 aspecto ["123235253253"], ya que no parece un número de calle válido.

AddressComponent

Representa un componente de una 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 de componente de la dirección. Consulta la Tabla 2: Tipos adicionales que muestra el servicio Places para obtener una lista de tipos posibles.
confirmationLevel

enum (ConfirmationLevel)

Indica el nivel de certeza que tenemos de que el componente sea 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 se debe proporcionar para una dirección completa.
spellCorrected

boolean

Indica la corrección de un error ortográfico en el nombre del componente. La API no siempre marca los cambios de una variante ortográfica a otra, como cuando se cambia "centro". en "center". Tampoco siempre identifica 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 cosmético, ya que el componente de entrada se cambió por uno diferente.
unexpected

boolean

Indica un componente de dirección que no se espera que esté presente en una dirección postal para la región determinada. La conservamos solo porque fue parte de la entrada.

ComponentName

Wrapper para el nombre del componente.

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

string

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

string

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

ConfirmationLevel

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

Enumeraciones
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 Este componente no se pudo confirmar, pero es plausible que exista. Por ejemplo, el número de una calle dentro de un intervalo válido de números de una calle en la que se desconocen números de casas específicos.
UNCONFIRMED_AND_SUSPICIOUS Este componente no se confirmó y es probable que sea incorrecto. Por ejemplo, un vecindario que no se ajusta al resto de la dirección.

Geocodificación

Contiene información sobre el lugar al que se realizó la geocodificación de 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 para crear rutas o calcular la ruta en auto siempre hará que el punto se ajuste a la ruta más cercana a esas coordenadas. Es posible que esta no sea una ruta que te lleve al destino de manera rápida o segura, y que no esté cerca de un punto de acceso a la propiedad. Además, cuando se realiza la geocodificación inversa de una ubicación, no se garantiza que la dirección devuelta coincida con la original.
plusCode

object (PlusCode)

El Plus Code correspondiente a location.
bounds

object (Viewport)

Los límites del lugar geocodificado.
featureSizeMeters

number

Tamaño del sitio geocodificado, en metros. Esta es otra medida de la grosor de la ubicación geocodificada, pero en cuanto al tamaño físico y no en términos semánticos.
placeId

string

El PlaceID del lugar al que se geocodifica esta entrada.

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

string

Son los tipos de lugar a los que se geocodifica la entrada. Por ejemplo, ['locality', 'political']. Aquí encontrarás la lista completa de tipos.

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].

PlusCode

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

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

string

El código global (completo) del lugar, como "9FWM33GV+HQ", que representa un área de 1/8,000 por 1/8,000 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 por un nombre con formato de una entidad de referencia.

Viewport

Un viewport de latitud y longitud, representado por 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 oscilar entre -90 y 90 grados inclusive, y los límites de longitud deben oscilar entre -180 y 180 grados inclusive. Varios casos incluyen los siguientes:

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

  • Si low.longitude > high.longitude, el rango 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 está vacío.

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

Tanto low como high se deben completar, y el cuadro representado no puede estar vacío (como se especifica en las definiciones anteriores). Si el viewport está vacío, se producirá un error.

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

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

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

object (LatLng)

Obligatorio. Es el punto inferior del viewport.
high

object (LatLng)

Obligatorio. Es el punto superior del viewport.

AddressMetadata

Los metadatos para la dirección. No se garantiza que metadata esté completamente propagado para todas las direcciones enviadas 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 la estableces, indica que el valor es desconocido.
poBox

boolean

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

boolean

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

UspsData

Son los datos del USPS correspondientes a la dirección. No se garantiza que uspsData esté completamente propagado para cada dirección de EE.UU. o PR que se envía a la API de Address Validation. Se recomienda integrar los campos de la dirección de copia de seguridad en la respuesta si usas uspsData como parte principal de la respuesta.

Representación JSON 
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": 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 valor de delivery_point_barcode para el correo electrónico escaneado mecánicamente. Si suma todos los dígitos de delivery_point_barcode, deliveryPointCheckDigit, postal y ZIP+4, se obtiene un número divisible por 10.
dpvConfirmation

string

Valores posibles para la confirmación del DPV. Muestra un solo carácter o no muestra ningún valor.

  • N: No se pudo confirmar el DPV con la información del número principal ni secundario.
  • D: La dirección se confirmó por medio de un DPV solo para el número principal, pero faltaba la información del número secundario.
  • S: El DPV de la dirección se confirmó únicamente para el número principal y la información del número secundario estaba presente, pero no se confirmó.
  • Y: La dirección se confirmó por DPV para los números principales y secundarios.
  • Vacío: Si la respuesta no contiene un valor dpvConfirmation, significa que no se envió la dirección para la confirmación del DPV.
dpvFootnote

string

Las notas al pie de la validación del punto de entrega. Se pueden unir varias notas al pie en la misma cadena.

  • AA: La dirección ingresada coincide con el archivo ZIP+4.
  • A1: La dirección ingresada no coincide con el archivo ZIP+4.
  • BB: Coincide con el DPV (todos los componentes)
  • CC: El número secundario no coincide y no es obligatorio
  • C1: El número secundario no coincide, pero es obligatorio
  • N1: Falta el número secundario en la dirección de gran altura
  • M1: Falta el número principal
  • M3: El número principal no es válido
  • P1: Falta el número de casilla de correo postal, RR o HC
  • P3: El número de casilla de correo, PO, RR o HC de la dirección ingresada no es válido.
  • F1: La dirección ingresada coincide con una dirección militar.
  • G1: La dirección ingresada coincide con una dirección de entrega general
  • U1: Dirección ingresada que coincide con un código postal único
  • PB: La dirección de entrada coincide con el registro de PBSA
  • RR: Dirección confirmada del DPV con información de PMB
  • R1: dirección confirmada del DPV sin información del PMB
  • R7: Registro de ruta del operador R777 o R779
  • IA: Se identificó la dirección informada
  • TA: Número principal que coincide con la eliminación de un valor alfa final
dpvCmra

string

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

  • Y: La dirección es una CMRA
  • N: La dirección no es una CMRA
dpvVacant

string

¿Este lugar está vacante? 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 está activa? No hay direcciones de estadísticas que no estén ocupadas de forma continua o direcciones a las que el USPS no presta servicio. Muestra un solo carácter.

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

integer

Indica el tipo NoStat. Muestra un código de motivo como int.

  • 1: IDA (dirección interna de entrega) – Direcciones que no reciben correo directamente del USPS, pero que se entregan a una dirección de entrega directa que las proporciona.
  • 2: CDS: Direcciones que aún no se pueden entregar. Por ejemplo, una nueva subdivisión en la que se determinaron lotes y números primarios, pero aún no existe una estructura para la ocupación.
  • 3: colisión; las direcciones que en realidad no confirman el DPV
  • 4: CMZ (universidad, militar y otros tipos); ZIP + 4 registros que el USPS incorporó a los datos
  • 5: Regular: Indica que las direcciones no reciben entrega y que las direcciones no se registran como entregas posibles.
  • 6: secundaria obligatoria. La dirección requiere información secundaria.
dpvDrop

string

La marca indica que el correo se entrega a un solo receptor de un sitio. Muestra un solo carácter.

  • Y: El correo electrónico se entrega a un solo receptor de un sitio.
  • N: El correo electrónico no se entrega a un solo receptor de un sitio.
dpvThrowback

string

Indica que el correo no se entregó a la dirección. Muestra un solo carácter.

  • Y: El correo no se entrega a la dirección.
  • N: El correo se entrega a la dirección.
dpvNonDeliveryDays

string

La marca indica que la entrega de correo no se realiza todos los días de la semana. Muestra un solo carácter.

  • Y: La entrega de correo no se realiza todos los días de la semana.
  • N: No hay indicación de que la entrega de correo no se haya realizado todos los días de la semana.
dpvNonDeliveryDaysValues

integer

Número entero que identifica los días de entrega fallida. Se puede interrogar con marcas de bits: 0x40; el domingo es un día de la entrega fallida 0x20; el lunes es un día de no entrega de 0x10; el martes es un día de no entrega de 0x08; el miércoles es un día de no entrega 0x04; el jueves es un día de no entrega 0x02; el viernes es un día de no entrega 0x02; el viernes es un día de no entrega 0x02; el viernes es un día de no entrega 0x02; el viernes es un día de no entrega 0x02; el viernes es un día de no entrega 0x02; el viernes es un día de no entrega 0x02.
dpvNoSecureLocation

string

La bandera indica que se puede acceder a la puerta, pero no se puede dejar el paquete por cuestiones de seguridad. Muestra un solo carácter.

  • Y: El paquete no se quedará por cuestiones de seguridad.
  • N: No hay indicaciones para que el paquete no se salga por cuestiones de seguridad.
dpvPbsa

string

Indica que la dirección coincidió con el registro de PBSA. Muestra un solo carácter.

  • Y: La dirección coincidió con el registro de PBSA.
  • N: La dirección no coincidió con el registro de PBSA.
dpvDoorNotAccessible

string

La bandera indica las direcciones en las que el USPS no puede tocar a una puerta para entregar correo. Muestra un solo carácter.

  • Y: No se puede acceder a la puerta.
  • N: No hay indicaciones de que no se puede acceder a la puerta.
dpvEnhancedDeliveryCode

string

Indica que hay más de un código de retorno de DPV válido para la dirección. Muestra un solo carácter.

  • Y: La dirección se confirmó por DPV para los números principales y secundarios.
  • N: No se pudo confirmar el DPV con la información del número principal ni secundario.
  • S: La dirección se confirmó con el DPV solo para el número principal y la información del número secundario estaba presente, pero no se confirmó, o se omitió una sola letra alfa final de un número principal para hacer una coincidencia del DPV y solicitar información secundaria.
  • D: La dirección se confirmó por medio de un DPV solo para el número principal, pero faltaba la información del número secundario.
  • R: Se confirmó la dirección, pero se asignó a las rutas fantasma R777 y R779, y no se proporcionó la entrega del USPS.
carrierRoute

string

Es el código de ruta de la empresa de transporte. 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 del contrato de autopista
  • B: Sección de apartado postal
  • G: Unidad de entrega general
carrierRouteIndicator

string

Indicador de clasificación de la tarifa de ruta de la empresa de transporte.
ewsNoMatch

boolean

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

string

Ciudad de la oficina de correo principal.
postOfficeState

string

Estado de la oficina de correo principal.
abbreviatedCity

string

Ciudad abreviada.
fipsCountyCode

string

el código de condado del FIPS.
county

string

Nombre del condado.
elotNumber

string

un número de línea de viaje mejorado (eLOT).
elotFlag

string

Marca ascendente/descendente de eLOT (A/D).
poBoxOnlyPostalCode

boolean

Código postal exclusivo en el apartado postal.
pmbDesignator

string

Designador de la unidad de PMB (Buzón de correo privado).
pmbNumber

string

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

string

Tipo de registro de dirección que coincide con la dirección de entrada.

  • F: FIRM. Esta es una coincidencia con un registro de empresa, que es el mejor nivel de coincidencia disponible para una dirección.
  • G: ENTREGA GENERAL. Esta es una coincidencia con un registro de entrega general.
  • H: EDIFICIO O APARTAMENTO. Esta es una coincidencia con el registro de un edificio o departamento.
  • P: CASILLA POSTAL. Esta es una coincidencia con un apartado postal.
  • R: CONTRATO DE RUTA RURAL o SECUNDARIA: Corresponde a una coincidencia con el registro de una ruta rural o de un contrato de autopista, ambos pueden tener rangos de números de caja asociados.
  • S: STREET RECORD: Esta es una coincidencia con un registro de Street que contiene un intervalo de números primarios válido.
defaultAddress

boolean

Indicador de que se encontró una dirección predeterminada, pero que existe 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 del USPS debido a la detección de direcciones creadas artificialmente.

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

boolean

Indicador de que se procesó la solicitud por CASS.

UspsAddress

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 urbanización puertorriqueño.
cityStateZipAddressLine

string

Ciudad + estado + código postal.
city

string

Nombre de la ciudad.
state

string

Es el 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., 5,023.