Address Validation

Clase AddressValidation

clase google.maps.addressValidation.AddressValidation
biblioteca "addressValidation"

Es una clase estática para acceder a las APIs de AddressValidation.

const {AddressValidation} = await google.maps.importLibrary("addressValidation");

Métodos estáticos
fetchAddressValidation	fetchAddressValidation(request) Parámetros: request: AddressValidationRequest Valor de retorno: Promise<AddressValidation> Valida una dirección. Consulta https://developers.google.com/maps/documentation/javascript/address-validation/validate-address.

Propiedades
address readonly	Tipo: Address optional Información sobre la dirección en sí, en lugar del código geográfico.
geocode readonly	Tipo: Geocode optional Información sobre la ubicación y el lugar a los que se geocodificó la dirección.
metadata readonly	Tipo: AddressMetadata optional Otra información pertinente para la capacidad de 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 readonly	Tipo: string optional Es el UUID que identifica esta respuesta. Si es necesario volver a validar la dirección, este UUID debe acompañar la nueva solicitud.
uspsData readonly	Tipo: USPSData optional Son marcas de entrega adicionales que proporciona el USPS. Solo se proporciona en las regiones US y PR.
verdict readonly	Tipo: Verdict optional Marcas de veredicto general

Métodos
Heredado: toJSON

Interfaz AddressValidationRequest

interfaz google.maps.addressValidation.AddressValidationRequest

Es la interfaz de solicitud para AddressValidation.fetchAddressValidation.

Propiedades
address	Tipo: PostalAddressLiteral Es la dirección que se está validando. Las direcciones sin formato se deben enviar a través de PostalAddress.addressLines.
internalUsageAttributionIds opcional	Tipo: Iterable<string> optional Son identificadores que se usan para atribuir llamadas a paquetes específicos o bibliotecas de OSS.
placeAutocompleteElement opcional	Tipo: PlaceAutocompleteElement optional Si usas un PlaceAutocompleteElement, inclúyelo aquí para vincular las llamadas a la API de Address Validation con el token de sesión de autocompletado.
previousResponseId opcional	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 propagar este campo con el AddressValidation.responseId de la primera respuesta de la secuencia de validación.
sessionToken opcional	Tipo: AutocompleteSessionToken optional Es un token que identifica una sesión de Autocomplete para fines de facturación.
uspsCASSEnabled opcional	Tipo: boolean optional Habilita el modo compatible con USPS CASS. Esto afecta solo el campo AddressValidation.uspsData de AddressValidation. Nota: En el caso de las solicitudes habilitadas para CASS del USPS para direcciones en Puerto Rico, se debe proporcionar un PostalAddress.regionCode de address como "PR", o bien un PostalAddress.administrativeArea de address como "Puerto Rico" (no distingue mayúsculas de minúsculas) o "PR".

Clase Address

clase google.maps.addressValidation.Address
biblioteca "addressValidation"

Son los detalles de la dirección procesada posteriormente. El procesamiento posterior incluye corregir las partes de la dirección que están mal escritas, reemplazar las partes incorrectas y deducir las partes faltantes.

const {Address} = await google.maps.importLibrary("addressValidation");

Propiedades
components readonly	Tipo: Array<AddressComponent> Son los componentes individuales de la dirección con formato y corregida, junto con la información de validación. Esto proporciona información sobre el estado de validación de los componentes individuales.
formattedAddress readonly	Tipo: string optional Es la dirección procesada con posterioridad, con formato de dirección de una sola línea, según las reglas de formato de direcciones de la región en la que se encuentra la dirección.
missingComponentTypes readonly	Tipo: Array<string> Son los tipos de componentes que se esperaba que estuvieran presentes en una dirección de correo postal 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 formatted_address, postal_address ni address_components. 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í.
postalAddress readonly	Tipo: PostalAddress optional Es la dirección procesada posteriormente representada como una dirección postal.
unconfirmedComponentTypes readonly	Tipo: Array<string> Son los tipos de componentes que están presentes en el address_components, pero no se pudo confirmar que sean correctos. Este campo se proporciona por motivos de 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. La lista de tipos posibles se puede encontrar aquí.
unresolvedTokens readonly	Tipo: Array<string> Cualquier token en 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, en una entrada como "123235253253 Main St, San Francisco, CA, 94105", los tokens no resueltos pueden verse como ["123235253253"], ya que no parece un número de calle válido).

Métodos
Heredado: toJSON

Clase AddressComponent

clase google.maps.addressValidation.AddressComponent
biblioteca "addressValidation"

Representa un solo componente de una dirección (p. ej., nombre de la calle, ciudad).

const {AddressComponent} = await google.maps.importLibrary("addressValidation");

Propiedades
componentName readonly	Tipo: string optional Es el texto del nombre del componente. Por ejemplo, "5th Avenue" para el nombre de una calle o "1253" para el número de una calle
componentNameLanguageCode readonly	Tipo: string optional 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.
componentType readonly	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 readonly	Tipo: ConfirmationLevel optional Indica el nivel de certeza de que el componente es correcto.
inferred readonly	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 obtener una dirección completa.
replaced readonly	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; el componente de entrada se cambió por otro.
spellCorrected readonly	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 readonly	Tipo: boolean Si es verdadero, no se espera que este componente esté presente en una dirección postal de la región determinada. Se conservó solo porque formaba parte de la entrada.

Clase AddressMetadata

clase google.maps.addressValidation.AddressMetadata
biblioteca "addressValidation"

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.

const {AddressMetadata} = await google.maps.importLibrary("addressValidation");

Propiedades
business readonly	Tipo: boolean
poBox readonly	Tipo: boolean
residential readonly	Tipo: boolean

Métodos
Heredado: toJSON

Constantes de ConfirmationLevel

constantes google.maps.addressValidation.ConfirmationLevel
biblioteca "addressValidation"

Son los diferentes valores posibles que indican el nivel de certeza de que el componente es correcto.

Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo ConfirmationLevelString.

const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation");

Constantes
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Clase Geocode

clase google.maps.addressValidation.Geocode
biblioteca "addressValidation"

Contiene información sobre el lugar al que se geocodificó la entrada.

const {Geocode} = await google.maps.importLibrary("addressValidation");

Propiedades
bounds readonly	Tipo: LatLngBounds optional Son los límites del lugar geocodificado.
featureSizeMeters readonly	Tipo: number optional 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.
location readonly	Tipo: LatLngAltitude optional Es la ubicación geocodificada de la entrada.
placeId readonly	Tipo: string optional Es el ID de lugar del lugar geocodificado. Se prefiere el uso de Place en lugar de direcciones, coordenadas de latitud y longitud, o Plus Codes. Si usas coordenadas para calcular rutas o rutas en auto, el punto siempre se ajustará a la ruta más cercana a esas coordenadas. Es posible que esta no sea una ruta que 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 realiza la geocodificación inversa de una ubicación, no se garantiza que la dirección que se devuelva coincida con la original.
placeTypes readonly	Tipo: Array<string> Son los tipos de lugar a los 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 readonly	Tipo: PlusCode optional Es el Plus Code correspondiente al location.

Métodos
fetchPlace	fetchPlace() Parámetros: Ninguno Valor de retorno: Ninguno Devuelve una representación de Place de este Geocode. Para obtener todos los detalles del lugar, se debe realizar una llamada a place.fetchFields().
Heredado: toJSON

Constantes de Granularity

constantes google.maps.addressValidation.Granularity
biblioteca "addressValidation"

Son los distintos niveles de detalle que puede tener una dirección o una geocodificación. 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 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, el código geográfico que se devuelva podría ser de nivel de detalle LOCALITY, aunque la dirección sea más detallada.

Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo GranularityString.

const {Granularity} = await google.maps.importLibrary("addressValidation");

Constantes
BLOCK	La dirección o el geocódigo indican una manzana. Solo se usa en regiones que tienen direcciones a nivel de manzana, como Japón.
OTHER	Todas las demás granularidades, que se agrupan porque no son entregables.
PREMISE	Es el resultado a nivel del edificio.
PREMISE_PROXIMITY	Un código geográfico que se aproxima a la ubicación a nivel de edificio de la dirección.
ROUTE	El geocódigo o la dirección son detallados hasta el nivel de ruta, como una calle, una ruta o una autopista.
SUB_PREMISE	Resultado de nivel inferior al edificio, como un departamento.

Constantes de PossibleNextAction

constantes google.maps.addressValidation.PossibleNextAction
biblioteca "addressValidation"

Aviso: Solo está disponible en el canal beta.

Ofrece un resumen interpretativo de la respuesta de la API, con el objetivo de ayudar a determinar una posible acción posterior que se deba realizar. Este campo se deriva de otros campos de la respuesta de la API y no se debe considerar como una garantía de la exactitud o la capacidad de entrega de la dirección.

Estas constantes también se pueden usar como cadenas. En TypeScript, los literales de cadena se definen con el tipo PossibleNextActionString.

const {PossibleNextAction} = await google.maps.importLibrary("addressValidation");

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 posteriormente sin volver a solicitarle 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 enviar un mensaje 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 procesada, por ejemplo, el componente de dirección postal_code era replaced. Pedirle al cliente que revise la dirección podría ayudar a mejorar la calidad de la dirección.
CONFIRM_ADD_SUBPREMISES	La respuesta de la API indica que es posible que a la dirección procesada posteriormente le falte un sublocal. Pedirle al 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 procesada también puede tener otros problemas menores. Nota: Este valor de enumeración solo se puede devolver para direcciones de EE.UU.
FIX	Uno o más campos de la respuesta de la API indican un posible problema con la dirección procesada, por ejemplo, el verdict.validation_granularity es OTHER. Pedirle al cliente que edite la dirección podría ayudar a mejorar la calidad de la dirección.

Clase USPSAddress

clase google.maps.addressValidation.USPSAddress
biblioteca "addressValidation"

Representación del USPS de una dirección de EE.UU.

const {USPSAddress} = await google.maps.importLibrary("addressValidation");

Propiedades
city readonly	Tipo: string optional Es el nombre de la ciudad.
cityStateZipAddressLine readonly	Tipo: string optional Es la línea de dirección que contiene la ciudad, el estado y el código postal.
firm readonly	Tipo: string optional Es el nombre de la firma.
firstAddressLine readonly	Tipo: string optional Es la primera línea de la dirección.
secondAddressLine readonly	Tipo: string optional Es la segunda línea de la dirección.
state readonly	Tipo: string optional Es el código de estado de 2 letras.
urbanization readonly	Tipo: string optional Es el nombre de la urbanización puertorriqueña.
zipCode readonly	Tipo: string optional El código postal, p.ej., "10009".
zipCodeExtension readonly	Tipo: string optional Es la extensión de 4 dígitos del código postal, p.ej., "5023".

Métodos
Heredado: toJSON

Clase USPSData

clase google.maps.addressValidation.USPSData
biblioteca "addressValidation"

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 usas uspsData como la parte principal de la respuesta.

const {USPSData} = await google.maps.importLibrary("addressValidation");

Propiedades
abbreviatedCity readonly	Tipo: string optional Ciudad abreviada.
addressRecordType readonly	Tipo: string optional Es el tipo de registro de dirección que coincide con la dirección de entrada.
carrierRoute readonly	Tipo: string optional 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.
carrierRouteIndicator readonly	Tipo: string optional Indicador de ordenación de la tarifa de la ruta del transportista.
cassProcessed readonly	Tipo: boolean Indicador de que la solicitud se procesó con CASS.
county readonly	Tipo: string optional Es el nombre del condado.
deliveryPointCheckDigit readonly	Tipo: string optional Es el dígito de control del punto de entrega. Este número se agrega al final del delivery_point_barcode para el correo escaneado de forma mecánica. La suma de todos los dígitos de delivery_point_barcode, el dígito de control del punto de entrega, el código postal y el ZIP+4 debe dar como resultado un número divisible por 10.
deliveryPointCode readonly	Tipo: string optional Es el código de punto de entrega de 2 dígitos.
dpvCMRA readonly	Tipo: string optional Indica si la dirección es una CMRA (agencia comercial de recepción de correo), es decir, una empresa privada que recibe correo para los clientes. Devuelve un solo carácter.
dpvConfirmation readonly	Tipo: string optional Son los valores posibles para la confirmación de DPV. Devuelve un solo carácter o no devuelve ningún valor.
dpvDoorNotAccessible readonly	Tipo: string optional Este parámetro indica las direcciones en las que el USPS no puede tocar la puerta para entregar el correo. Devuelve un solo carácter.
dpvDrop readonly	Tipo: string optional La marca indica que el correo se entrega en un solo receptáculo de un sitio. Devuelve un solo carácter.
dpvEnhancedDeliveryCode readonly	Tipo: string optional Indica que más de un código de retorno de DPV es válido para la dirección. Devuelve un solo carácter.
dpvFootnote readonly	Tipo: string optional Son las notas al pie de la validación del punto de entrega. Se pueden encadenar varias notas al pie en la misma cadena.
dpvNonDeliveryDays readonly	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 readonly	Tipo: number optional Es un número entero que identifica los días en los que no se realizan entregas. Se puede consultar con marcas de bits: 0x40: El domingo no se realizan entregas 0x20: El lunes no se realizan entregas 0x10: El martes no se realizan entregas 0x08: El miércoles no se realizan entregas 0x04: El jueves no se realizan entregas 0x02: El viernes no se realizan entregas 0x01: El sábado no se realizan entregas
dpvNoSecureLocation readonly	Tipo: string optional La marca indica que se puede acceder a la puerta, pero no se dejará el paquete por motivos de seguridad. Devuelve un solo carácter.
dpvNoStat readonly	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 a las que el USPS no presta servicio. Devuelve un solo carácter.
dpvNoStatReasonCode readonly	Tipo: number optional Indica el tipo de NoStat. Devuelve un código de motivo como int.
dpvPBSA readonly	Tipo: string optional Indica que la dirección coincidió con un registro de PBSA. Devuelve un solo carácter.
dpvThrowback readonly	Tipo: string optional Indica que el correo no se entrega en la dirección. Devuelve un solo carácter.
dpvVacant readonly	Tipo: string optional Indica si la dirección está vacante. Devuelve un solo carácter.
elotFlag readonly	Tipo: string optional Indicador de orden ascendente o descendente de eLOT (A/D).
elotNumber readonly	Tipo: string optional Número de línea de viaje mejorada (eLOT)
errorMessage readonly	Tipo: string optional Mensaje de error para la recuperación de datos de USPS. Este campo se completa cuando se suspende el procesamiento del USPS debido a la detección de direcciones creadas de forma artificial.
fipsCountyCode readonly	Tipo: string optional Es el código FIPS del condado.
hasDefaultAddress readonly	Tipo: boolean Indica que se encontró una dirección predeterminada, pero existen direcciones más específicas.
hasNoEWSMatch readonly	Tipo: boolean La dirección de entrega se puede hacer coincidir, pero el archivo de EWS indica que pronto habrá una coincidencia exacta disponible.
lacsLinkIndicator readonly	Tipo: string optional Indicador de LACSLink.
lacsLinkReturnCode readonly	Tipo: string optional Código de retorno de LACSLink.
pmbDesignator readonly	Tipo: string optional Designador de unidad de PMB (casilla de correo privada).
pmbNumber readonly	Tipo: string optional Número de PMB (casilla de correo privada)
poBoxOnlyPostalCode readonly	Tipo: boolean Código postal solo para apartados de correos.
postOfficeCity readonly	Tipo: string optional Ciudad de la oficina de correos principal.
postOfficeState readonly	Tipo: string optional Es el estado de la oficina de correo principal.
standardizedAddress readonly	Tipo: USPSAddress optional Es la dirección estandarizada del USPS.
suiteLinkFootnote readonly	Tipo: string optional Notas al pie de página que se generan cuando se hace coincidir un registro de calle o edificio con la información de la suite. Si se encuentra una coincidencia con el nombre de la empresa, se devuelve el número secundario.

Métodos
Heredado: toJSON

Clase Verdict

clase google.maps.addressValidation.Verdict
biblioteca "addressValidation"

Representa la dirección procesada posteriormente para la dirección proporcionada.

const {Verdict} = await google.maps.importLibrary("addressValidation");

Propiedades
addressComplete readonly	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 establece, indica que el valor es false. Consulta los campos Address.missingComponentTypes, Address.unresolvedTokens o AddressComponent.unexpected para obtener más detalles.
geocodeGranularity readonly	Tipo: Granularity optional Información sobre el nivel de detalle de Geocode. Esto se puede entender como el significado semántico de qué tan aproximada o precisa es la ubicación geocodificada.
hasInferredComponents readonly	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 readonly	Tipo: boolean optional Se reemplazó al menos un componente de la dirección. Consulta AddressComponent para obtener más detalles.
hasUnconfirmedComponents readonly	Tipo: boolean Al menos un componente de la dirección no se puede categorizar ni validar. Consulta AddressComponent para obtener más detalles.
inputGranularity readonly	Tipo: Granularity optional Es el nivel de detalle de la dirección de entrada. Este es el resultado de analizar la dirección de entrada y no proporciona ningún indicador de validación. Para conocer los indicadores de validación, consulta validationGranularity.
possibleNextAction readonly	Aviso: Solo está disponible en el canal beta. Tipo: PossibleNextAction optional Es una posible 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 readonly	Tipo: Granularity optional Es el nivel de detalle con el que la API puede validar la dirección por completo. Por ejemplo, un validationGranularity de PREMISE indica que se pueden validar todos los componentes de la dirección en el nivel de PREMISE y más amplios.