Índice
AddressValidation(interfaz)Address(mensaje)AddressComponent(mensaje)AddressComponent.ConfirmationLevel(enumeración)AddressMetadata(mensaje)ComponentName(mensaje)Geocode(mensaje)LanguageOptions(mensaje)PlusCode(mensaje)ProvideValidationFeedbackRequest(mensaje)ProvideValidationFeedbackRequest.ValidationConclusion(enumeración)ProvideValidationFeedbackResponse(mensaje)UspsAddress(mensaje)UspsData(mensaje)ValidateAddressRequest(mensaje)ValidateAddressResponse(mensaje)ValidationResult(mensaje)Verdict(mensaje)Verdict.Granularity(enumeración)
AddressValidation
El servicio para validar direcciones.
| ProvideValidationFeedback |
|---|
|
Comentarios sobre el resultado de la secuencia de intentos de validación. Esta debería ser la última llamada realizada después de una secuencia de llamadas de validación para la misma dirección y se debería llamar una vez que concluye la transacción. Este solo debe enviarse una vez para la secuencia de solicitudes |
| ValidateAddress |
|---|
|
Valida una dirección. |
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.
| Campos | |
|---|---|
formatted_address |
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. |
postal_address |
La dirección con procesamiento posterior, representada como una dirección postal. |
address_components[] |
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. |
missing_component_types[] |
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 |
unconfirmed_component_types[] |
Son los tipos de componentes presentes en |
unresolved_tokens[] |
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 |
AddressComponent
Representa un componente de dirección, como una calle, una ciudad o un estado.
| Campos | |
|---|---|
component_name |
El nombre de este componente. |
component_type |
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. |
confirmation_level |
Indica el nivel de certeza que tenemos de que el componente sea correcto. |
inferred |
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. |
spell_corrected |
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 |
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 |
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. |
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. |
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.
| Campos | |
|---|---|
business |
Indica que esta es la dirección de una empresa. Si no está establecido, indica que el valor es desconocido. |
po_box |
Indica la dirección de un apartado postal. Si no está establecido, indica que el valor es desconocido. |
residential |
Indica que esta es la dirección de una residencia. Si no está establecido, indica que el valor es desconocido. |
ComponentName
Wrapper para el nombre del componente.
| Campos | |
|---|---|
text |
Es el texto del nombre. Por ejemplo, "Quinta Avenida" para el nombre de una calle o "1253" para el número de una calle. |
language_code |
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. |
Geocodificación
Contiene información sobre el lugar hasta el que se geocodificaron los datos de entrada.
| Campos | |
|---|---|
location |
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. |
plus_code |
El Plus Code correspondiente a |
bounds |
Límites del sitio geocodificado. |
feature_size_meters |
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. |
place_id |
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. |
place_types[] |
Los tipos de lugar a los que se geocodifica la entrada. Por ejemplo, |
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.
| Campos | |
|---|---|
return_english_latin_address |
Vista previa: muestra un |
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.
| Campos | |
|---|---|
global_code |
Código global (completo) del sitio, como "9FWM33GV+HQ", que representa un área de 1/8000 por 1/8000 grados (~14 por 14 metros). |
compound_code |
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. |
ProvideValidationFeedbackRequest
La solicitud para enviar comentarios de validación.
| Campos | |
|---|---|
conclusion |
Obligatorio. El resultado de la secuencia de intentos de validación. Si este campo se establece como |
response_id |
Obligatorio. El ID de la respuesta para la que son estos comentarios. Debería ser el [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] de la primera respuesta de una serie de intentos de validación de direcciones. |
ValidationConclusion
Son los posibles resultados finales de la secuencia de solicitudes de validación de direcciones necesarias para validar una dirección.
| Enumeradores | |
|---|---|
VALIDATION_CONCLUSION_UNSPECIFIED |
Este valor no se usa. Si el campo ProvideValidationFeedbackRequest.conclusion se configura como VALIDATION_CONCLUSION_UNSPECIFIED, se mostrará un error INVALID_ARGUMENT. |
VALIDATED_VERSION_USED |
Para la transacción, se usó la versión de la dirección que muestra la API de Address Validation. |
USER_VERSION_USED |
Se utilizó la versión de la dirección que proporcionó el usuario para la transacción. |
UNVALIDATED_VERSION_USED |
Para la transacción, se utilizó una versión de la dirección que se ingresó después del último intento de validación, pero que no se volvió a validar. |
UNUSED |
Se abandonó la transacción y no se usó la dirección. |
ProvideValidationFeedbackResponse
Este tipo no tiene campos.
La respuesta para los comentarios de validación.
La respuesta estará vacía si los comentarios se envían correctamente.
UspsAddress
Representación del USPS de una dirección de EE.UU.
| Campos | |
|---|---|
first_address_line |
Primera línea de dirección. |
firm |
Nombre de la empresa. |
second_address_line |
Segunda línea de dirección. |
urbanization |
Nombre de la urbanización puertorriqueña. |
city_state_zip_address_line |
Ciudad + estado + código postal |
city |
Nombre de la ciudad. |
state |
Código de estado de 2 letras. |
zip_code |
Código postal, p.ej., 10009. |
zip_code_extension |
Extensión de código postal de 4 dígitos, p.ej., 5023. |
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.
| Campos | |
|---|---|
standardized_address |
Dirección estandarizada del USPS. |
delivery_point_code |
Código de punto de entrega de 2 dígitos |
delivery_point_check_digit |
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, delivery_point_check_digit, de código postal y de ZIP+4, deberías obtener un número divisible por 10. |
dpv_confirmation |
Son los valores posibles para la confirmación de DPV. Muestra un solo carácter o no muestra ningún valor.
|
dpv_footnote |
Notas al pie de la validación del punto de entrega. Se pueden combinar varias notas al pie en la misma cadena.
|
dpv_cmra |
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.
|
dpv_vacant |
¿Este lugar está vacante? Muestra un solo carácter.
|
dpv_no_stat |
¿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.
|
dpv_no_stat_reason_code |
Indica el tipo NoStat. Muestra un código de motivo como int.
|
dpv_drop |
La marca indica que el correo se entrega a un único lugar receptivo en un sitio. Muestra un solo carácter.
|
dpv_throwback |
Indica que no se ha entregado el correo a esa dirección. Muestra un solo carácter.
|
dpv_non_delivery_days |
La marca indica que la entrega de correo no se realiza todos los días de la semana. Muestra un solo carácter.
|
dpv_non_delivery_days_values |
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 |
dpv_no_secure_location |
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.
|
dpv_pbsa |
Indica que la dirección coincidió con el registro PBSA. Muestra un solo carácter.
|
dpv_door_not_accessible |
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.
|
dpv_enhanced_delivery_code |
Indica que hay más de un código de devolución DPV válido para la dirección. Muestra un solo carácter.
|
carrier_route |
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:
|
carrier_route_indicator |
Indicador de orden de la tarifa de la ruta de la empresa de transporte. |
ews_no_match |
La dirección de entrega coincide, pero el archivo EWS indica que una coincidencia exacta estará disponible pronto. |
post_office_city |
Ciudad de la oficina postal principal |
post_office_state |
Estado de la oficina de correos principal |
abbreviated_city |
Ciudad abreviada. |
fips_county_code |
código de condado del FIPS. |
county |
Nombre del condado. |
elot_number |
Número de línea de viaje mejorada (eLOT). |
elot_flag |
eLOT ascendente/descendente (A/D). |
lacs_link_return_code |
Código de devolución de LACSLink. |
lacs_link_indicator |
Indicador de vínculo de LACS. |
po_box_only_postal_code |
Código postal solo en apartado postal |
suitelink_footnote |
Notas al pie que hacen coincidir el registro de una calle o un edificio alto con la información de un local. Si se encuentra una coincidencia con el nombre de la empresa, se devuelve el número secundario.
|
pmb_designator |
Designador de unidad de PMB (Buzón de correo privado). |
pmb_number |
Número de PMB (buzón de correo privado); |
address_record_type |
Tipo del registro de dirección que coincide con la dirección de entrada.
|
default_address |
Indicador de que se encontró una dirección predeterminada, pero existe una dirección más específica. |
error_message |
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. |
cass_processed |
Indicador de que se procesó la solicitud de CASS. |
ValidateAddressRequest
La solicitud para validar una dirección.
| Campos | |
|---|---|
address |
Obligatorio. La dirección que se está validando. Las direcciones sin formato se deben enviar a través de La longitud total de los campos en esta entrada no debe superar los 280 caracteres. Puedes encontrar las regiones admitidas aquí. El valor La API de Address Validation ignora los valores de |
previous_response_id |
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 |
enable_usps_cass |
Habilita el modo compatible con CASS de USPS. Esto afecta solo al campo Se recomienda usar un elemento |
language_options |
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. |
session_token |
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 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. |
ValidateAddressResponse
Es la respuesta a una solicitud de validación de dirección.
| Campos | |
|---|---|
result |
Es el resultado de la validación de la dirección. |
response_id |
Es el UUID que identifica esta respuesta. Si se debe volver a validar la dirección, este UUID debe acompañar la solicitud nueva. |
ValidationResult
Es el resultado de validar una dirección.
| Campos | |
|---|---|
verdict |
Marcas de veredicto generales |
address |
Incluye información sobre la dirección en sí, en lugar del geocódigo. |
geocode |
Información sobre la ubicación y el lugar a los que se geocodifica la dirección. |
metadata |
Otra información relevante para la entrega. No se garantiza que |
usps_data |
Marcas de entrega adicionales proporcionadas por el USPS. Solo se proporciona en la región |
english_latin_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 Nota: Los campos |
Veredicto
Descripción general de alto nivel del resultado de validación de la dirección y el geocódigo.
| Campos | |
|---|---|
input_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 Por ejemplo, si la dirección de entrada incluye un número de departamento específico, |
validation_granularity |
El nivel de detalle en el que la API puede validate por completo la dirección. Por ejemplo, un Puedes encontrar el resultado de la validación del componente por dirección en |
geocode_granularity |
Información sobre el nivel de detalle de En ocasiones, esto puede diferir del |
address_complete |
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 |
has_unconfirmed_components |
Al menos un componente de la dirección no se puede categorizar o validar. Consulta |
has_inferred_components |
Se infirió (agregado) al menos un componente de la dirección que no estaba en la entrada. Consulta |
has_replaced_components |
Se reemplazó al menos un componente de la dirección. Consulta |
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 |