Í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. Debería ser la última llamada realizada después de una secuencia de llamadas de validación para la misma dirección, y se debe llamar una vez concluida la transacción. Esto solo se debe enviar una vez para la secuencia de solicitudes |
| ValidateAddress |
|---|
|
Valida una dirección. |
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.
| Campos | |
|---|---|
formatted_address |
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. |
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 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. |
missing_component_types[] |
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 |
unconfirmed_component_types[] |
Los tipos de componentes que están presentes en el |
unresolved_tokens[] |
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 |
AddressComponent
Representa un componente de una dirección, como una calle, una ciudad o un estado.
| Campos | |
|---|---|
component_name |
Es el nombre de este componente. |
component_type |
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. |
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 se debe proporcionar para una dirección completa. |
spell_corrected |
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 "centre" a "center". Tampoco siempre se marcan los errores ortográficos comunes, como cuando se cambia "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 cosmé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 la región determinada. La conservamos solo porque fue 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 |
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. |
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.
| Campos | |
|---|---|
business |
Indica que esta es la dirección de una empresa. Si no la estableces, indica que el valor es desconocido. |
po_box |
Indica que es la dirección de un apartado postal. Si no la estableces, indica que el valor es desconocido. |
residential |
Indica que esta es la dirección de una residencia. Si no la estableces, indica que el valor es desconocido. |
ComponentName
Wrapper para el nombre del componente.
| Campos | |
|---|---|
text |
Es el texto del nombre. Por ejemplo, "5.a Avenida" para el nombre de una calle o "1253" para el número de la 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 al que se realizó la geocodificación de la 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 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. |
plus_code |
El Plus Code correspondiente a |
bounds |
Los límites del lugar geocodificado. |
feature_size_meters |
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. |
place_id |
El PlaceID del lugar al que se geocodifica esta entrada. Para obtener más información sobre los IDs de lugar, consulta aquí. |
place_types[] |
Son los tipos de sitio 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: 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.
| Campos | |
|---|---|
global_code |
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). |
compound_code |
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. |
ProvideValidationFeedbackRequest
Es 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 configura como |
response_id |
Obligatorio. El ID de la respuesta a la que corresponde este comentario. Debería ser el [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] de la primera respuesta en una serie de intentos de validación de dirección. |
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 |
La versión de la dirección que proporcionó el usuario se usó para la transacción |
UNVALIDATED_VERSION_USED |
Para la transacción, se utilizó una versión de la dirección ingresada 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 a 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 urbanización puertorriqueño. |
city_state_zip_address_line |
Ciudad + estado + código postal. |
city |
Nombre de la ciudad. |
state |
Es el 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
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.
| 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 |
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 sumas todos los dígitos de delivery_point_barcode, delivery_point_check_digit, código postal y ZIP+4, se debería obtener un número divisible por 10. |
dpv_confirmation |
Valores posibles para la confirmación del DPV. Muestra un solo carácter o no muestra ningún valor.
|
dpv_footnote |
Las notas al pie de la validación del punto de entrega. Se pueden unir varias notas al pie en la misma cadena.
|
dpv_cmra |
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.
|
dpv_vacant |
¿Este lugar está vacante? Muestra un solo carácter.
|
dpv_no_stat |
¿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.
|
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 solo receptor de un sitio. Muestra un solo carácter.
|
dpv_throwback |
Indica que el correo no se entregó a la 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 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. |
dpv_no_secure_location |
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.
|
dpv_pbsa |
Indica que la dirección coincidió con el registro de PBSA. Muestra un solo carácter.
|
dpv_door_not_accessible |
La bandera indica las direcciones en las que el USPS no puede tocar a una puerta para entregar correo. Muestra un solo carácter.
|
dpv_enhanced_delivery_code |
Indica que hay más de un código de retorno de 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 clasificación de la tarifa de ruta de la empresa de transporte. |
ews_no_match |
La dirección de entrega coincide, pero el archivo EWS indica que pronto habrá una coincidencia exacta. |
post_office_city |
Ciudad de la oficina de correo principal. |
post_office_state |
Estado de la oficina de correo principal. |
abbreviated_city |
Ciudad abreviada. |
fips_county_code |
el código de condado del FIPS. |
county |
Nombre del condado. |
elot_number |
un número de línea de viaje mejorado (eLOT). |
elot_flag |
Marca ascendente/descendente de eLOT (A/D). |
lacs_link_return_code |
Código de retorno de LACSLink. |
lacs_link_indicator |
Indicador de LACSLink. |
po_box_only_postal_code |
Código postal exclusivo en el apartado postal. |
suitelink_footnote |
Notas al pie de un archivo que coinciden con un disco de una calle o un edificio alto con información de una suite. Si se encuentra una coincidencia con el nombre de la empresa, se muestra el número secundario.
|
pmb_designator |
Designador de la unidad de PMB (Buzón de correo privado). |
pmb_number |
Número de PMB (Buzón de correo privado) |
address_record_type |
Tipo de registro de dirección que coincide con la dirección de entrada.
|
default_address |
Indicador de que se encontró una dirección predeterminada, pero que existe direcciones más específicas. |
error_message |
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. |
cass_processed |
Indicador de que se procesó la solicitud por CASS. |
ValidateAddressRequest
Es la solicitud para validar una dirección.
| Campos | |
|---|---|
address |
Obligatorio. La dirección que se está validando. Las direcciones sin formato deben enviarse a través de La longitud total de los campos de 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 los cambios que realiza el usuario después de la validación inicial deben volver a validarse), cada solicitud de seguimiento debe propagar este campo con el |
enable_usps_cass |
Habilita el modo compatible con USPS CASS. Esto afecta solo al campo Te recomendamos que uses un |
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 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 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. |
ValidateAddressResponse
La respuesta a una solicitud de validación de dirección.
| Campos | |
|---|---|
result |
El resultado de la validación de la dirección. |
response_id |
El UUID que identifica esta respuesta. Si la dirección debe volver a validarse, este UUID debe acompañar la nueva solicitud. |
ValidationResult
Es el resultado de la validación de una dirección.
| Campos | |
|---|---|
verdict |
Marcas de veredicto general |
address |
Incluye información sobre la dirección en sí misma, a diferencia 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 las regiones |
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. 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 Nota: Los campos |
Veredicto
Descripción general de alto nivel del resultado de la validación de direcciones y geocódigo.
| Campos | |
|---|---|
input_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 Por ejemplo, si la dirección ingresada incluye un número de departamento específico, la |
validation_granularity |
El nivel de detalle con el que la API puede validate por completo la dirección. Por ejemplo, un Puedes encontrar el resultado de la validación de componentes por dirección en |
geocode_granularity |
Información sobre el nivel de detalle de En ocasiones, esto puede diferir de la |
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 |
No se puede categorizar ni validar al menos un componente de la dirección. Consulta |
has_inferred_components |
Se infirió (agregó) al menos un componente de 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 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 "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 "Calle principal 123" en Redwood City, el geocódigo que se muestra puede tener un nivel de detalle de LOCALITY, aunque la dirección sea más detallada.
| Enumeradores | |
|---|---|
GRANULARITY_UNSPECIFIED |
Valor predeterminado Este valor no se usa. |
SUB_PREMISE |
Resultado 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. |