Clase AddressValidation
Clase google.maps.addressValidation.AddressValidation
Clase estática para acceder a las APIs de AddressValidation.
Llama al const {AddressValidation} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Métodos estáticos | |
---|---|
fetchAddressValidation |
fetchAddressValidation(request) Parámetros:
Valor de devolución:
Promise<AddressValidation> Valida una dirección. Consulta https://developers.google.com/maps/documentation/javascript/address-validation/validate-address. |
Propiedades | |
---|---|
address |
Tipo:
Address optional Es la información sobre la dirección en sí, a diferencia de la geocodificación. |
geocode |
Tipo:
Geocode optional Es la información sobre la ubicación y el lugar al que se geocodificó la dirección. |
metadata |
Tipo:
AddressMetadata optional Otra información relevante para la entrega. No se garantiza que metadata se complete por completo para cada dirección que se envíe a la API de Address Validation. |
responseId |
Tipo:
string optional Es el UUID que identifica esta respuesta. Si se debe volver a validar la dirección, este UUID debe acompañar la nueva solicitud. |
uspsData |
Tipo:
USPSData optional Son marcas de capacidad de entrega adicionales proporcionadas por el USPS. Solo se proporciona en las regiones US y PR . |
verdict |
Tipo:
Verdict optional Marcas de veredicto general |
Métodos | |
---|---|
toJSON |
toJSON() Parámetros: Ninguno
Valor de devolución:
Object Convierte la clase AddressValidation en un objeto JSON con las mismas propiedades. |
Interfaz de AddressValidationRequest
Interfaz de google.maps.addressValidation.AddressValidationRequest
Es la interfaz de solicitud para AddressValidation.fetchAddressValidation
.
Propiedades | |
---|---|
address |
Tipo:
PostalAddressLiteral Es la dirección que se valida. Las direcciones sin formato se deben enviar a través de PostalAddress.addressLines . |
previousResponseId optional |
Tipo:
string optional Este campo no se debe establecer para la primera solicitud de validación de dirección. Si se necesitan más solicitudes para validar por completo una sola dirección (por ejemplo, si los cambios que realiza el usuario después de la validación inicial deben volver a validarse), cada solicitud de seguimiento debe completar este campo con el AddressValidation.responseId de la primera respuesta en la secuencia de validación. |
uspsCASSEnabled optional |
Tipo:
boolean optional Habilita el modo compatible con CASS del USPS. Esto afecta solo el campo AddressValidation.uspsData de AddressValidation . Nota: Para las solicitudes habilitadas para CASS del USPS de direcciones en Puerto Rico, se debe proporcionar un PostalAddress.regionCode del address como "PR", o bien un PostalAddress.administrativeArea del address como "Puerto Rico" (sin distinción entre mayúsculas y minúsculas) o "PR". |
Clase Address
Clase google.maps.addressValidation.Address
Son los detalles de la dirección posterior al procesamiento. El procesamiento posterior incluye corregir las partes mal escritas de la dirección, reemplazar las partes incorrectas y deducir las partes faltantes.
Llama al const {Address} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Propiedades | |
---|---|
components |
Tipo:
Array<AddressComponent> Son los componentes de dirección 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. |
formattedAddress |
Tipo:
string optional Es la dirección posterior al procesamiento, con el formato de una dirección de una sola línea que sigue las reglas de formato de la región en la que se encuentra la dirección. |
missingComponentTypes |
Tipo:
Array<string> Son los tipos de componentes que se esperaba que estuvieran presentes en una dirección postal con el formato correcto, pero no se encontraron en la entrada Y no se pudieron inferir. Los componentes de este tipo no están presentes en formatted_address , postal_address ni address_components . Un ejemplo podría ser ['street_number', 'route'] para una entrada como "Boulder, Colorado, 80301, EE.UU.". Puedes encontrar la lista de tipos posibles aquí. |
postalAddress |
Tipo:
PostalAddress optional Es la dirección procesada posteriormente, representada como una dirección postal. |
unconfirmedComponentTypes |
Tipo:
Array<string> Son los tipos de componentes que están presentes en address_components , pero no se pudo confirmar que sean correctos. Este campo se proporciona por conveniencia: su contenido equivale a iterar a través de address_components para encontrar los tipos de todos los componentes en los que AddressComponent.confirmationLevel no es ConfirmationLevel.CONFIRMED o la marca AddressComponent.inferred no está establecida en true . Puedes encontrar la lista de tipos posibles aquí. |
unresolvedTokens |
Tipo:
Array<string> Son los tokens de la entrada que no se pudieron resolver. Podría tratarse de una entrada que no se reconoció como parte válida de una dirección (por ejemplo, en una entrada como "123235253253 Main St, San Francisco, CA, 94105", los tokens no resueltos podrían verse como ["123235253253"] , ya que no parece un número de calle válido). |
Clase AddressComponent
Clase google.maps.addressValidation.AddressComponent
Representa un solo componente de una dirección (p. ej., nombre de la calle, ciudad).
Llama al const {AddressComponent} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Propiedades | |
---|---|
componentName |
Tipo:
string optional Es el texto del nombre del componente. Por ejemplo, "5th Avenue" para un nombre de calle o "1253" para un número de calle. |
componentNameLanguageCode |
Tipo:
string optional Es el código de idioma BCP-47. No estará presente si el nombre del componente no está asociado a un idioma, como un número de calle. |
componentType |
Tipo:
string optional Es el tipo de componente de dirección. Consulta la Tabla 2: Tipos adicionales que muestra el servicio Places para obtener una lista de los tipos posibles. |
confirmationLevel |
Tipo:
ConfirmationLevel optional Indica el nivel de certeza de que el componente es correcto. |
inferred |
Tipo:
boolean Si es verdadero, este componente no formaba parte de la entrada, pero se infirió para la ubicación de la dirección. Se recomienda incluir este componente para una dirección completa. |
replaced |
Tipo:
boolean Indica que el nombre del componente se reemplazó por uno completamente diferente. Por ejemplo, reemplazar un código postal incorrecto por uno que sea correcto para la dirección. Este no es un cambio estético, ya que se reemplazó el componente de entrada por otro. |
spellCorrected |
Tipo:
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 "centre" a "center". |
unexpected |
Tipo:
boolean Si es verdadero, no se espera que este componente esté presente en una dirección postal para la región determinada. Se conservó solo porque formaba parte de la entrada. |
Clase AddressMetadata
Clase google.maps.addressValidation.AddressMetadata
Son los metadatos de la dirección. No se garantiza que AddressMetadata se complete por completo para cada dirección que se envíe a la API de Address Validation.
Llama al const {AddressMetadata} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Propiedades | |
---|---|
business |
Tipo:
boolean |
poBox |
Tipo:
boolean |
residential |
Tipo:
boolean |
Constantes de ConfirmationLevel
Constantes de google.maps.addressValidation.ConfirmationLevel
Son los diferentes valores posibles que indican el nivel de certeza de que el componente sea correcto.
Llama al const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constantes | |
---|---|
CONFIRMED |
|
UNCONFIRMED_AND_SUSPICIOUS |
|
UNCONFIRMED_BUT_PLAUSIBLE |
Clase Geocode
Clase google.maps.addressValidation.Geocode
Contiene información sobre el lugar al que se geocodificó la entrada.
Llama al const {Geocode} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Propiedades | |
---|---|
bounds |
Tipo:
LatLngBounds optional Son los límites del lugar geocodificado. |
featureSizeMeters |
Tipo:
number optional 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. |
location |
Tipo:
LatLngAltitude optional Es la ubicación geocodificada de la entrada. |
placeId |
Tipo:
string optional Es el ID de lugar del lugar geocodificado. Se prefiere usar Place en lugar de direcciones, coordenadas de latitud y longitud, o Plus Codes. Usar coordenadas para generar rutas o calcular instrucciones sobre cómo llegar en automóvil siempre hará que el punto se ajuste a la ruta más cercana a esas coordenadas. Es posible que no sea un camino que lo lleve de forma rápida o segura al destino, y que no esté cerca de un punto de acceso a la propiedad. Además, cuando se realiza la codificación geográfica inversa de una ubicación, no se garantiza que la dirección devuelta coincida con la original. |
placeTypes |
Tipo:
Array<string> Es el tipo o los tipos de lugar al que se geocodificó la entrada. Por ejemplo, ['locality', 'political'] . Puedes encontrar la lista completa de tipos en la documentación de la API de Geocoding. |
plusCode |
Tipo:
PlusCode optional Es el Plus Code correspondiente a location . |
Métodos | |
---|---|
fetchPlace |
fetchPlace() Parámetros: Ninguno
Valor de retorno: Ninguno
Devuelve una representación de Place de este Geocode. Para obtener los detalles completos del lugar, se debe realizar una llamada a place.fetchFields(). |
Constantes de Granularity
Constantes de google.maps.addressValidation.Granularity
Son las distintas granularidades que puede tener una dirección o un código geográfico. Cuando se usan para indicar la granularidad de una dirección, estos valores indican con qué nivel de detalle la dirección identifica un destino de envío. Por ejemplo, una dirección como "123 Main Street, Redwood City, CA, 94061" identifica un PREMISE
, mientras que algo como "Redwood City, CA, 94061" identifica un LOCALITY
. Sin embargo, si no podemos encontrar un código geográfico para "123 Main Street" en Redwood City, es posible que el código geográfico que se devuelva sea de granularidad LOCALITY
, aunque la dirección sea más granular.
Llama al const {Granularity} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constantes | |
---|---|
BLOCK |
La dirección o el geocódigo indican una cuadra. Solo se usa en regiones que tienen direcciones a nivel de cuadra, como Japón. |
OTHER |
Todas las demás granularidades, que se agrupan, ya que no se pueden entregar. |
PREMISE |
Es un resultado a nivel del edificio. |
PREMISE_PROXIMITY |
Es un código geográfico que aproxima la ubicación a nivel del edificio de la dirección. |
ROUTE |
El geocódigo o la dirección son específicos para la ruta, como una calle, una ruta o una autopista. |
SUB_PREMISE |
Es un resultado a nivel de subedificio, como un departamento. |
Constantes de PossibleNextAction
Constantes de google.maps.addressValidation.PossibleNextAction
Ofrece un resumen interpretativo de la respuesta de la API, cuyo objetivo es ayudar a determinar una posible acción posterior. Este campo se deriva de otros campos en la respuesta de la API y no debe considerarse como una garantía de la exactitud o la capacidad de entrega de la dirección.
Llama al const {PossibleNextAction} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constantes | |
---|---|
ACCEPT |
La respuesta de la API no contiene indicadores que justifiquen uno de los otros valores de PossibleNextAction. Puedes considerar usar la dirección procesada sin solicitarle más información al cliente, aunque esto no garantiza que la dirección sea válida y es posible que aún contenga correcciones. Es tu responsabilidad determinar si debes solicitarle información a tu cliente y cómo hacerlo, según tu propia evaluación de riesgos. |
CONFIRM |
Uno o más campos de la respuesta de la API indican posibles problemas menores con la dirección posterior al procesamiento, por ejemplo, el componente de dirección postal_code era replaced . Pedirle a tu cliente que revise la dirección podría ayudar a mejorar su calidad. |
CONFIRM_ADD_SUBPREMISES |
La respuesta de la API indica que es posible que a la dirección posterior al procesamiento le falte una subinstalación. Pedirle a tu cliente que revise la dirección y considere agregar un número de unidad podría ayudar a mejorar la calidad de la dirección. La dirección posterior al procesamiento también podría tener otros problemas menores. Nota: Este valor de enumeración solo se puede devolver para las direcciones de EE.UU. |
FIX |
Uno o más campos de la respuesta de la API indican un posible problema con la dirección posterior al procesamiento, por ejemplo, verdict.validation_granularity es OTHER . Pedirle al cliente que edite la dirección podría ayudar a mejorar su calidad. |
Clase USPSAddress
Clase google.maps.addressValidation.USPSAddress
Es la representación del USPS de una dirección de EE.UU.
Llama al const {USPSAddress} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Propiedades | |
---|---|
city |
Tipo:
string optional Es el nombre de la ciudad. |
cityStateZipAddressLine |
Tipo:
string optional Es la línea de dirección que contiene la ciudad, el estado y el código postal. |
firm |
Tipo:
string optional Es el nombre de la empresa. |
firstAddressLine |
Tipo:
string optional Primera línea de la dirección. |
secondAddressLine |
Tipo:
string optional Segunda línea de la dirección |
state |
Tipo:
string optional Código de estado de 2 letras. |
urbanization |
Tipo:
string optional Nombre de la urbanización de Puerto Rico. |
zipCode |
Tipo:
string optional El código postal, p.ej., "10009". |
zipCodeExtension |
Tipo:
string optional Es la extensión del código postal de 4 dígitos, p.ej., "5023". |
Clase USPSData
Clase google.maps.addressValidation.USPSData
Son los datos del USPS para la dirección. No se garantiza que USPSData se complete 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 utilizas uspsData como la parte principal de la respuesta.
Llama al const {USPSData} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Propiedades | |
---|---|
abbreviatedCity |
Tipo:
string optional Ciudad abreviada. |
addressRecordType |
Tipo:
string optional Es el tipo de registro de dirección que coincide con la dirección de entrada. |
carrierRoute |
Tipo:
string optional Es el código de ruta del operador. Es un código de cuatro caracteres que consta de un prefijo de una letra y un designador de ruta de tres dígitos. |
carrierRouteIndicator |
Tipo:
string optional Es el indicador de ordenamiento de tarifas de la ruta de la empresa de transporte. |
cassProcessed |
Tipo:
boolean Indicador de que la solicitud se procesó con CASS. |
county |
Tipo:
string optional Nombre del condado. |
deliveryPointCheckDigit |
Tipo:
string optional Dígito de control del punto de entrega. Este número se agrega al final del código de barras del punto de entrega para el correo escaneado mecánicamente. La suma de todos los dígitos de delivery_point_barcode, delivery_point_check_digit, código postal y ZIP+4 debe dar como resultado un número divisible por 10. |
deliveryPointCode |
Tipo:
string optional Es el código de punto de entrega de 2 dígitos. |
dpvCMRA |
Tipo:
string optional Indica si la dirección es una CMRA (Commercial Mail Receiving Agency), es decir, una empresa privada que recibe correo para clientes. Devuelve un solo carácter. |
dpvConfirmation |
Tipo:
string optional Son los valores posibles para la confirmación de la DPV. Devuelve un solo carácter o no devuelve ningún valor. |
dpvDoorNotAccessible |
Tipo:
string optional La marca indica las direcciones en las que el USPS no puede tocar la puerta para entregar el correo. Devuelve un solo carácter. |
dpvDrop |
Tipo:
string optional La marca indica que el correo se entrega en un solo receptáculo en un sitio. Devuelve un solo carácter. |
dpvEnhancedDeliveryCode |
Tipo:
string optional Indica que más de un código de devolución del DPV es válido para la dirección. Devuelve un solo carácter. |
dpvFootnote |
Tipo:
string optional Son las notas al pie de la validación del punto de entrega. Se pueden unir varias notas al pie en la misma cadena. |
dpvNonDeliveryDays |
Tipo:
string optional La marca indica que la entrega de correo no se realiza todos los días de la semana. Devuelve un solo carácter. |
dpvNonDeliveryDaysValues |
Tipo:
number optional Es un número entero que identifica los días de no entrega. Se puede consultar 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 |
dpvNoSecureLocation |
Tipo:
string optional La bandera indica que se puede acceder a la puerta, pero no se dejará el paquete por motivos de seguridad. Devuelve un solo carácter. |
dpvNoStat |
Tipo:
string optional Indica si la dirección 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 aquellas a las que el USPS no presta servicios. Devuelve un solo carácter. |
dpvNoStatReasonCode |
Tipo:
number optional Indica el tipo de NoStat. Devuelve un código de motivo como int. |
dpvPBSA |
Tipo:
string optional Indica que la dirección coincidió con un registro de PBSA. Devuelve un solo carácter. |
dpvThrowback |
Tipo:
string optional Indica que el correo no se entrega en la dirección. Devuelve un solo carácter. |
dpvVacant |
Tipo:
string optional Indica si la dirección está vacante. Devuelve un solo carácter. |
elotFlag |
Tipo:
string optional Marca de orden ascendente o descendente del eLOT (A/D). |
elotNumber |
Tipo:
string optional Número de Línea de Viaje Mejorada (eLOT). |
errorMessage |
Tipo:
string optional Es el mensaje de error para la recuperación de datos de USPS. Este campo se completa cuando se suspende el procesamiento de USPS debido a la detección de direcciones creadas de forma artificial. |
fipsCountyCode |
Tipo:
string optional Es el código FIPS del condado. |
hasDefaultAddress |
Tipo:
boolean Indicador de que se encontró una dirección predeterminada, pero existen direcciones más específicas. |
hasNoEWSMatch |
Tipo:
boolean La dirección de entrega coincide, pero el archivo EWS indica que pronto estará disponible una coincidencia exacta. |
lacsLinkIndicator |
Tipo:
string optional Es el indicador de LACSLink. |
lacsLinkReturnCode |
Tipo:
string optional Es el código de retorno de LACSLink. |
pmbDesignator |
Tipo:
string optional Designador de unidad de PMB (buzón privado). |
pmbNumber |
Tipo:
string optional Número de PMB (buzón privado). |
poBoxOnlyPostalCode |
Tipo:
boolean Es el código postal solo para apartados postales. |
postOfficeCity |
Tipo:
string optional Es la ciudad de la oficina de correos principal. |
postOfficeState |
Tipo:
string optional Estado de la oficina de correos principal. |
standardizedAddress |
Tipo:
USPSAddress optional Es la dirección estandarizada del USPS. |
suiteLinkFootnote |
Tipo:
string optional Notas al pie de página que surgen de la coincidencia de un registro de calle o edificio de gran altura con información de suite. Si se encuentra una coincidencia del nombre de la empresa, se devuelve el número secundario. |
Clase Verdict
Clase google.maps.addressValidation.Verdict
Representa la dirección procesada posteriormente para la dirección proporcionada.
Llama al const {Verdict} = await google.maps.importLibrary("addressValidation")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Propiedades | |
---|---|
addressComplete |
Tipo:
boolean La dirección se considera completa si no hay tokens sin resolver ni componentes de dirección inesperados o faltantes. Si no se configura, indica que el valor es false . Consulta los campos Address.missingComponentTypes , Address.unresolvedTokens o AddressComponent.unexpected para obtener más detalles. |
geocodeGranularity |
Tipo:
Granularity optional Es información sobre la granularidad del Geocode . Esto se puede entender como el significado semántico de qué tan aproximada o precisa es la ubicación geocodificada. |
hasInferredComponents |
Tipo:
boolean Se infirió (es decir, se agregó) al menos un componente de dirección que no estaba en la entrada. Consulta AddressComponent para obtener más detalles. |
hasReplacedComponents |
Tipo:
boolean optional Se reemplazó al menos un componente de dirección. Consulta AddressComponent para obtener más detalles. |
hasUnconfirmedComponents |
Tipo:
boolean Al menos un componente de dirección no se puede categorizar ni validar. Consulta AddressComponent para obtener más detalles. |
inputGranularity |
Tipo:
Granularity optional Es 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 validationGranularity . |
possibleNextAction |
Tipo:
PossibleNextAction optional Es una posible próxima acción que se puede realizar en función de otros campos de la respuesta de la API. Consulta PossibleNextAction para obtener información. |
validationGranularity |
Tipo:
Granularity optional Es el nivel de detalle con el que la API puede validar por completo la dirección. Por ejemplo, un validationGranularity de PREMISE indica que se pueden validar todos los componentes de dirección en el nivel de PREMISE y en niveles más amplios. |