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 se deben enviar a través de addressLines.

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

Puedes encontrar las regiones admitidas aquí.

El valor languageCode en la dirección de entrada se reserva para usos futuros y se ignora hoy. El resultado de la dirección validada se completará en función del idioma preferido de la dirección dada, tal como lo identifica el sistema.

La API de Address Validation ignora los valores de recipients y organization. Todos los valores en esos campos se descartarán y no se mostrarán. 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 se deben volver a validar los cambios que realiza el usuario después de la validación inicial), cada solicitud de seguimiento debe propagar este campo con el responseId de la primera respuesta en la secuencia de validación.
enableUspsCass

boolean

Habilita el modo compatible con CASS de USPS. 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 habilitadas por el CASS del USPS para direcciones en Puerto Rico, se debe proporcionar un google.type.PostalAddress.region_code del address como "PR", o bien un google.type.PostalAddress.administrative_area de address como "Puerto Rico" (no distingue mayúsculas de minúsculas) o "PR".

Se recomienda usar un elemento address con componentes o, como alternativa, especificar al menos dos elementos 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 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 en base64 segura para URL y nombre de archivo con un máximo de 36 caracteres ASCII de longitud. De lo contrario, se muestra un error INVALID_ formato.

La sesión comienza cuando el usuario hace una consulta de 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 una sesión, el token deja de ser válido, y 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 (nuevo), 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

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

Es el UUID que identifica esta respuesta. Si se debe volver a validar la dirección, este UUID debe acompañar 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 sobre el ingreso o edición de direcciones: - Usa un widget de dirección listo para la internacionalización, como https://github.com/google/libaddressinput). - No se deben presentar a los usuarios 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. 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 hoy se ignora. 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 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), el "indicador de á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. En particular, para España es 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 en 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 consta de 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, realizar la 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. La API de Address Validation no la usa en la actualidad. Si bien en este momento la API no rechazará las solicitudes con este campo establecido, 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 en la actualidad. Si bien en este momento la API no rechazará las solicitudes con este campo establecido, 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 validar 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 generales
address

object (Address)

Incluye información sobre la dirección en sí, en lugar 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íe a la API de Address Validation.
uspsData

object (UspsData)

Marcas de entrega adicionales proporcionadas por el USPS. Solo se proporciona en la región 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.

Dirección traducida al inglés.

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

Si parte de la dirección no tiene una traducción al inglés, el servicio la mostrará en un idioma alternativo que utilice alfabeto latino. Consulta aquí para obtener una explicación de cómo se selecciona el idioma alternativo. Si una parte de la dirección no tiene traducciones o transliteraciones en un idioma que usa 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 validación de la 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 de 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 hacer coincidir el número de departamento en las bases de datos o el número de departamento no es válido, es probable que el validationGranularity sea PREMISE o inferior.
validationGranularity

enum (Granularity)

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

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

enum (Granularity)

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

En ocasiones, esto puede diferir del 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. Si no está establecido, indica que el valor es false. Consulta los campos missingComponentTypes, unresolvedTokens o unexpected para obtener más información.
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ó (agregado) al menos un componente de la 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 diversos 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 a un destino de correo postal. Por ejemplo, una dirección como “123 Main Street, Redwood City, CA, 94061” identifica una PREMISE, mientras que algo como “Redwood City, CA, 94061” identifica una LOCALITY. Sin embargo, si no podemos encontrar un geocódigo para "123 Main Street" en Redwood City, es posible que el geocódigo que se muestra tenga 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 de edificio debajo del edificio, como un departamento.
PREMISE Resultado a nivel de edificio.
PREMISE_PROXIMITY Un geocódigo que aproxima la ubicación de la dirección a nivel de edificio.
BLOCK La dirección o el geocódigo indican un bloque. Solo se usa en regiones con direcciones a nivel de bloque, como Japón.
ROUTE El geocódigo o la dirección son granulares para la ruta, como una calle, una ruta o una autopista.
OTHER Todas las demás granularidades, que se agrupan debido a que no se pueden entregar

Dirección

Detalles de la dirección después del procesamiento. El procesamiento posterior incluye corregir las partes con errores ortográficos 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 que se procesó con posterioridad, 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 corregida y con formato, 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 esperaba que estuvieran presentes en una dirección de correo con 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

Son los tipos de componentes presentes en addressComponents, pero que no se pudieron 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 la marca inferred no se establece en true. La lista de tipos posibles se puede encontrar aquí.
unresolvedTokens[]

string

Cualquier token de 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 podrían parecerse a ["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)

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 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 debería proporcionarse para una dirección completa.
spellCorrected

boolean

Indica una 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 “centre” a “center”. Tampoco siempre se marcan los errores ortográficos comunes, como al cambiar “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, 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 una región determinada. Lo retenemos solo porque era 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, "Quinta Avenida" para el nombre de una calle o "1253" para el número de una 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.

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 creíble que exista. Por ejemplo, el número de una calle dentro de un rango de números válido conocido en 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 que se geocodificaron los datos de 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 códigos plus. El uso de coordenadas al enrutar o calcular indicaciones siempre dará como resultado que el punto se ajuste a la ruta más cercana a esas coordenadas. Puede que esta no sea una ruta que lleve al destino de forma rápida o segura, ni que esté cerca de un punto de acceso a la propiedad. Además, cuando una ubicación tiene una geocodificación inversa, no hay garantía de que la dirección devuelta coincida con la original.
plusCode

object (PlusCode)

El Plus Code correspondiente a location
bounds

object (Viewport)

Límites del sitio geocodificado.
featureSizeMeters

number

Indica el tamaño del lugar geocodificado en metros. Esta es otra medida de la aspereza de la ubicación geocodificada, pero en cuanto a tamaño físico y no por significado semántico.
placeId

string

El PlaceID del lugar con el 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 lugar a los que se geocodifica la entrada. Por ejemplo, ['locality', 'political']. Puedes 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].

PlusCode

El Plus Code (http://plus.codes) es una referencia de ubicación con dos formatos: un código global que define un rectángulo de 14 mx14 m (1/8, 000 de un grado) 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 sitio, como "9FWM33GV+HQ", que representa un área de 1/8000 por 1/8000 grados (~14 por 14 metros).
compoundCode

string

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

Viewport

Un viewport de latitud y longitud, representado por dos puntos diagonales low y high opuestos. Una 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 de -180 a 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 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 estará vacío.

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

Tanto low como high deben completarse, 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:

{ "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. El punto inferior del viewport.
high

object (LatLng)

Obligatorio. El punto alto del viewport.

AddressMetadata

Los metadatos de la dirección. No se garantiza que metadata se propague por completo para cada dirección que se envíe 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 está establecido, indica que el valor es desconocido.
poBox

boolean

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

boolean

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

UspsData

Los datos del USPS para la dirección. No se garantiza que uspsData esté completamente propagado para cada dirección de EE.UU. o de relaciones públicas que se envía a la API de Address Validation. Si usas uspsData como la parte principal de la respuesta, te recomendamos integrar los campos de la dirección de respaldo.

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

El dígito de control del punto de entrega. Este número se agrega al final de delivery_point_barcode para los correos electrónicos escaneados mecánicamente. Si sumas 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 o no muestra ningún valor.

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

string

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

  • 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: 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: Número principal no válido
  • P1: falta el número de casilla de la dirección de entrada de la orden de compra, del RR o del HC
  • P3: Número de casilla de ayuda, orden de compra, RR o HC no 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: Dirección confirmada por el DPV con información de PMB
  • R1: Dirección confirmada por el DPV sin información de PMB
  • R7: El proveedor de ruta R777 o registro R779
  • IA: Se identificó la dirección informada
  • TA: número principal coincidente al quitar un alfa al final
dpvCmra

string

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

  • Y: La dirección corresponde a una CMRA
  • N: La dirección no pertenece a 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 una dirección activa? No hay direcciones de estadísticas son aquellas que no se ocupan continuamente o direcciones que el USPS no presta servicios. 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 de entrega interna): direcciones que no reciben correos electrónicos directamente del USPS, pero que se entregan a una dirección directa que las presta servicios.
  • 2: CDS. Direcciones que aún no se han entregado. Por ejemplo, una nueva subdivisión en la que se determinaron los lotes y los números principales, pero aún no existe una estructura para la ocupación.
  • 3: Colisión. Direcciones que no confirman realmente las 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 la entrega y que las direcciones no se registran como posibles entregas.
  • 6: Es un campo secundario obligatorio. La dirección requiere información secundaria.
dpvDrop

string

La marca indica que el correo se entrega a un único lugar receptivo en un sitio. Muestra un solo carácter.

  • Y: El correo se entrega a un único área receptiva de un sitio.
  • N: El correo no se entrega a un único espacio receptivo en un sitio.
dpvThrowback

string

Indica que no se ha entregado el correo a esa dirección. Muestra un solo carácter.

  • Y: El correo no se entrega a la dirección postal.
  • N: El correo se entrega a la dirección postal.
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 del correo electrónico no se realiza todos los días de la semana.
dpvNonDeliveryDaysValues

integer

Número entero que identifica los días de la falta de entrega. Se puede interactuar con marcas de bits: 0x40: el domingo es un día sin entrega 0 x 20; el lunes es un día sin entrega 0 x 10; el martes es un día sin entrega 0x08; el miércoles es un día sin entrega 0x04; el jueves es un día sin entrega 0x02; el viernes es un día sin entrega 0x02; el viernes es un día sin entrega 0x02; el viernes es un día sin entrega 0x02
dpvNoSecureLocation

string

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

  • Y: El paquete no se dejará por problemas de seguridad.
  • N: No hay indicación de que el paquete no se dejará debido a problemas de seguridad.
dpvPbsa

string

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

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

string

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

  • Y: No se puede acceder a la puerta.
  • N: No hay indicación de que no se pueda acceder a la puerta.
dpvEnhancedDeliveryCode

string

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

  • Y: Se confirmó la dirección DPV de los números principales y secundarios.
  • N: No se pudo confirmar la información del número principal ni secundario.
  • S: Se confirmó la dirección del DPV solo para el número principal, y la información del número secundario aparecía como si no se confirmó, o se omitió un solo alfa al final de un número principal para que se generara una coincidencia del DPV y se requiriera información secundaria.
  • D: Se confirmó la dirección DPV solo para el número principal y faltaba la información del número secundario.
  • R: Se confirmó la dirección, pero se asignó a las rutas fantasmas 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 urbana)
  • R: Ruta rural
  • H: Ruta contractual de autopista
  • B: Sección de boletería de correos
  • G: Unidad de entrega general
carrierRouteIndicator

string

Indicador de orden de la 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 de la oficina postal principal
postOfficeState

string

Estado de la oficina de correos principal
abbreviatedCity

string

Ciudad abreviada.
fipsCountyCode

string

código de 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 en apartado postal
pmbDesignator

string

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

string

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

string

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

  • F: FIRM Se trata de una coincidencia con un registro de empresa, que es el mejor nivel de coincidencia disponible para una dirección.
  • G: ENTREGA GENERAL. Esta coincidencia coincide con un registro de entrega general.
  • H: EDICIO O DEPARTAMENTO Esta es una coincidencia con el registro de un edificio o departamento.
  • P: Apartado postal. Coincide con un apartado postal.
  • R: CONTRATO DE RUTA RURAL o CONTRATO DE ALTA CARRERA: Es una coincidencia con un registro de ruta rural o de contrato de autopista, los cuales pueden tener rangos de números de cuadros asociados.
  • S: REGISTRO DE LA STREET: Corresponde a una coincidencia con un registro de la calle que contiene un rango de números primarios válido.
defaultAddress

boolean

Indicador de que se encontró una dirección predeterminada, pero existe una dirección más específica.
errorMessage

string

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

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