Í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
Es el servicio para validar direcciones.
ProvideValidationFeedback |
---|
Comentarios sobre el resultado de la secuencia de intentos de validación. Esta debe ser la última llamada que se realiza después de una secuencia de llamadas de validación para la misma dirección y se debe llamar una vez que se concluye la transacción. Solo se debe enviar una vez para la secuencia de solicitudes de |
ValidateAddress |
---|
Valida una dirección. |
Dirección
Son los detalles de la dirección después del procesamiento. El procesamiento posterior incluye corregir las partes de la dirección con errores ortográficos, reemplazar las partes incorrectas y deducir las partes faltantes.
Campos | |
---|---|
formatted_address |
Es la dirección procesada posteriormente, con el formato de una sola línea y que sigue las reglas de formato de la región en la que se encuentra. Nota: Es posible que el formato de esta dirección no coincida con el formato de la dirección en el campo |
postal_address |
Es la dirección procesada después, 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 la dirección no están ordenados de una manera en particular. No hagas suposiciones sobre el orden de los componentes de la dirección en la lista. |
missing_component_types[] |
Son 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 que no se pudieron inferir. Un ejemplo podría ser Nota: Es posible que veas un tipo de componente faltante cuando creas que ya lo proporcionaste. Por ejemplo, esto puede ocurrir cuando la dirección de entrada contiene el nombre del edificio, pero no el número de la propiedad. En la dirección "渋谷区渋谷3丁目 Shibuya Stream", el nombre del edificio "Shibuya Stream" tiene el tipo de componente |
unconfirmed_component_types[] |
Son los tipos de componentes que están presentes en |
unresolved_tokens[] |
Cualquier token de la entrada que no se pudo resolver Puede ser una entrada que no se reconoció como parte válida de una dirección. Por ejemplo, para una entrada como "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", los tokens no resueltos podrían verse como |
AddressComponent
Representa un componente de dirección, como una calle, una ciudad o un estado.
Campos | |
---|---|
component_name |
Es el nombre de este componente. |
component_type |
Es el tipo de 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 es correcto. |
inferred |
Indica que el componente no formaba parte de la entrada, pero lo inferimos para la ubicación de la dirección y creemos que se debe proporcionar para obtener 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 marca los errores ortográficos comunes, como cuando se cambia "Amphitheater Pkwy" por "Amphitheatre Pkwy". |
replaced |
Indica que el nombre del componente se reemplazó por uno completamente diferente, por ejemplo, un código postal incorrecto se reemplazó por uno correcto para la dirección. Este no es un cambio estético, sino que se cambió el componente de entrada por uno diferente. |
unexpected |
Indica un componente de dirección que no se espera que esté presente en una dirección postal de la región determinada. Solo lo conservamos porque formaba parte de la entrada. |
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 |
No se pudo confirmar este componente, pero es posible que exista. Por ejemplo, un número de calle dentro de un rango válido conocido de números en una calle donde no se conocen los 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
Son 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 se establece, indica que el valor es desconocido. |
po_box |
Indica que la dirección es un apartado postal. Si no se establece, indica que el valor es desconocido. |
residential |
Indica que esta es la dirección de una residencia. Si no se establece, indica que el valor es desconocido. |
ComponentName
Es un wrapper para el nombre del componente.
Campos | |
---|---|
text |
Es el texto del nombre. Por ejemplo, "5th Avenue" para un nombre de calle o "1253" para un número de 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 geocodió la entrada.
Campos | |
---|---|
location |
Es la ubicación geocodificada de la entrada. Se prefiere usar los IDs de lugar en lugar de direcciones, coordenadas de latitud y longitud o códigos plus. El uso de coordenadas cuando se planifican rutas o se calculan instrucciones sobre cómo llegar siempre hará que el punto se ajuste a la ruta más cercana a esas coordenadas. Es posible que no sea una ruta que te lleve al destino de forma rápida o segura, y que no esté cerca de un punto de acceso a la propiedad. Además, cuando se codifica geográficamente una ubicación de forma inversa, no hay garantía de que la dirección que se muestra coincida con la original. |
plus_code |
El Plus Code correspondiente al |
bounds |
Los límites del lugar geocodificado |
feature_size_meters |
Es el tamaño del lugar geocodificado, en metros. Esta es otra medida de la imprecisión de la ubicación geocodificada, pero en tamaño físico en lugar de significado semántico. |
place_id |
El PlaceID del lugar al que geocodifica esta entrada. Para obtener más información sobre los IDs de lugar, consulta este artículo. |
place_types[] |
Los tipos de lugares a los que se geocodió 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 del Servicio 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: el código global, que define un rectángulo de 14 m x 14 m (1/8,000 de un grado) o menos, y el código compuesto, que reemplaza el prefijo por una ubicación de referencia.
Campos | |
---|---|
global_code |
Es el código global (completo) del lugar, como "9FWM33GV+HQ", que representa un área de 1/8,000 por 1/8,000 de grado (~14 por 14 metros). |
compound_code |
El 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
La solicitud para enviar comentarios de validación
Campos | |
---|---|
conclusion |
Es obligatorio. El resultado de la secuencia de intentos de validación. Si este campo se establece en |
response_id |
Es obligatorio. Es el ID de la respuesta para la que se escribieron estos comentarios. Debe ser el [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] de la primera respuesta en 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.
Enumeraciones | |
---|---|
VALIDATION_CONCLUSION_UNSPECIFIED |
Este valor no se usa. Si el campo ProvideValidationFeedbackRequest.conclusion se establece en VALIDATION_CONCLUSION_UNSPECIFIED , se mostrará un error INVALID_ARGUMENT . |
VALIDATED_VERSION_USED |
La versión de la dirección que muestra la API de Address Validation se usó para la transacción. |
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 usó 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 |
La transacción se abandonó y no se usó la dirección. |
ProvideValidationFeedbackResponse
Este tipo no tiene campos.
Es 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 la dirección. |
urbanization |
Nombre de la urbanización de Puerto Rico. |
city_state_zip_address_line |
Ciudad, estado y código postal |
city |
Nombre de la ciudad. |
state |
Es un 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 de la dirección No se garantiza que uspsData
se propague por completo para cada dirección de EE.UU. o Puerto Rico que se envíe a la API de Address Validation. Se recomienda integrar los campos de dirección de respaldo en la respuesta si usas uspsData como la 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 |
El dígito de control del punto de entrega Este número se agrega al final del código de barras de delivery_point para el correo escaneado mecánicamente. Si sumas todos los dígitos de delivery_point_barcode, delivery_point_check_digit, postal_code y 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 |
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 de recepción de correo comercial), una empresa privada que recibe correo para clientes. Muestra un solo carácter.
|
dpv_vacant |
¿Está disponible este lugar? Muestra un solo carácter.
|
dpv_no_stat |
¿Es una dirección sin estadísticas o una dirección activa? Las direcciones sin estadísticas son aquellas que no están ocupadas de forma continua o que el USPS no entrega. Muestra un solo carácter.
|
dpv_no_stat_reason_code |
Indica el tipo de NoStat. Muestra un código de motivo como int.
|
dpv_drop |
La marca indica que el correo se entrega a un solo receptáculo en un sitio. Muestra un solo carácter.
|
dpv_throwback |
Indica que el correo no se entrega en 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 |
Es un número entero que identifica los días en los que no se realizó la publicación. Se puede interrogar con marcas de bits: 0x40: El domingo es un día sin entrega. 0x20: El lunes es un día sin entrega. 0x10: 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. 0x01: El sábado es un día sin entrega. |
dpv_no_secure_location |
La marca indica que se puede acceder a la puerta, pero no se dejará el paquete debido a problemas de seguridad. Muestra un solo carácter.
|
dpv_pbsa |
Indica que la dirección coincide con el registro de PBSA. Muestra un solo carácter.
|
dpv_door_not_accessible |
La marca indica las direcciones en las que el USPS no puede tocar la puerta para entregar el correo. Muestra un solo carácter.
|
dpv_enhanced_delivery_code |
Indica que más de un código de devolución de DPV es válido para la dirección. Muestra un solo carácter.
|
carrier_route |
Es el código de ruta del transportista. Es un código de cuatro caracteres que consta de un prefijo de una letra y un designador de ruta de tres dígitos. Prefijos:
|
carrier_route_indicator |
Indicador de clasificación de tarifas de ruta de la empresa de transporte. |
ews_no_match |
La dirección de entrega coincide, pero el archivo EWS indica que pronto estará disponible una coincidencia exacta. |
post_office_city |
Ciudad de la oficina de correos principal |
post_office_state |
Estado de la oficina postal principal. |
abbreviated_city |
Es la ciudad abreviada. |
fips_county_code |
Código de condado del FIPS. |
county |
Es el nombre del condado. |
elot_number |
Número de línea de viaje mejorada (eLOT). |
elot_flag |
Marca ascendente o 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 solo para apartados postales |
suitelink_footnote |
Notas al pie de coincidencia de un registro de calle o rascacielos con la información de un departamento. Si se encuentra una coincidencia con el nombre de la empresa, se muestra el número secundario.
|
pmb_designator |
Designador de unidad de PMB (buzón privado). |
pmb_number |
Número de PMB (buzón privado) |
address_record_type |
Es el tipo de registro de dirección que coincide con la dirección de entrada.
|
default_address |
Indica que se encontró una dirección predeterminada, pero existen direcciones más específicas. |
error_message |
Mensaje de error para la recuperación de datos del USPS. Este valor se propaga cuando se suspende el procesamiento del 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 se presente este error. |
cass_processed |
Es un indicador de que la solicitud se procesó según el CASS. |
ValidateAddressRequest
La solicitud para validar una dirección.
Campos | |
---|---|
address |
Es 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 de esta entrada no debe exceder 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 completamente 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 CASS de USPS. Esto afecta solo al campo Se recomienda usar 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 del Servicio 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 para realizar la facturación correspondiente. Debe ser una cadena base64 segura para la URL y el nombre de archivo con una longitud máxima de 36 caracteres ASCII. De lo contrario, se muestra un error INVALID_ARGUMENT. La sesión comienza cuando el usuario realiza 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 búsquedas 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 con la API de Autocomplete. Consulta https://developers.google.com/maps/documentation/places/web-service/session-pricing para obtener más información. |
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 la dirección debe volver a validarse, este UUID debe acompañar a la solicitud nueva. |
ValidationResult
Es el resultado de la validación de una dirección.
Campos | |
---|---|
verdict |
Marcas de veredicto general |
address |
Es la información sobre la dirección en sí, en lugar del código geográfico. |
geocode |
Es la información sobre la ubicación y el lugar al que se geocodificó la dirección. |
metadata |
Otra información relevante para la entrega No se garantiza que |
usps_data |
Marcas de entrega adicionales proporcionadas por 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 del Servicio 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 volver a usar como entrada de la API. El servicio las proporciona para que el usuario pueda usar su idioma nativo y 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 una escritura latina. Consulta este vínculo para obtener 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 usa un alfabeto latino, el servicio muestra esa parte en el idioma local asociado con la dirección. Habilita este resultado con la marca Nota: No se propagan los campos |
Veredicto
Descripción general de alto nivel del resultado de la validación de la dirección y el geocódigo.
Campos | |
---|---|
input_granularity |
El nivel de detalle de la dirección de entrada. Este es el resultado del análisis de la dirección de entrada y no proporciona ningún indicador de validación. Para obtener información sobre los indicadores de validación, consulta Por ejemplo, si la dirección de entrada incluye un número de departamento específico, el |
validation_granularity |
Es el nivel de detalle hasta el que la API puede validar la dirección. Por ejemplo, un El resultado de la validación de cada componente de la dirección se puede encontrar en |
geocode_granularity |
Información sobre el nivel de detalle de En ocasiones, 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 se establece, indica que el valor es |
has_unconfirmed_components |
Al menos un componente de la dirección no se puede categorizar ni validar. 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 diferentes niveles de detalle que puede tener una dirección o un código geográfico. 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. Por ejemplo, una dirección como "123 Main Street, Redwood City, CA, 94061" identifica un PREMISE
, mientras que una dirección como "Redwood City, CA, 94061" identifica un LOCALITY
. Sin embargo, si no podemos encontrar una geocodificación para "123 Main Street" en Redwood City, la geocodificación que se muestra puede ser de nivel de detalle LOCALITY
, aunque la dirección sea más detallada.
Enumeraciones | |
---|---|
GRANULARITY_UNSPECIFIED |
Valor predeterminado Este valor no se usa. |
SUB_PREMISE |
Es un resultado inferior al nivel del edificio, como un departamento. |
PREMISE |
Resultado a nivel del edificio. |
PREMISE_PROXIMITY |
Es un código geodésico que aproxima la ubicación a nivel del edificio de la dirección. |
BLOCK |
La dirección o el geocódigo indican un bloque. Solo se usa en regiones que tienen direcciones a nivel de bloque, como Japón. |
ROUTE |
El geocódigo o la dirección es detallado para la ruta, como una calle, una ruta o una autopista. |
OTHER |
Todos los demás niveles de detalle, que se agrupan, ya que no se pueden entregar. |