Address Validation (beta)

Classe AddressValidation

Classe google.maps.addressValidation.AddressValidation

Classe statique permettant d'accéder aux API Address Validation.

Accédez-y en appelant le const {AddressValidation} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
fetchAddressValidation
fetchAddressValidation(request)
Paramètres :
Valeur renvoyée : Promise<AddressValidation>
Valide une adresse. Consultez https://developers.google.com/maps/documentation/javascript/address-validation/validate-address.
address
Type : Address optional
Informations sur l'adresse elle-même, par opposition au géocode.
geocode
Type : Geocode optional
Informations sur l'emplacement et le lieu auxquels l'adresse a été géocodée.
metadata
Type : AddressMetadata optional
Autres informations utiles concernant la délivrabilité. Il n'est pas garanti que metadata soit entièrement renseigné pour chaque adresse envoyée à l'API Address Validation.
responseId
Type : string optional
UUID qui identifie cette réponse. Si l'adresse doit être validée de nouveau, cet UUID doit accompagner la nouvelle demande.
uspsData
Type : USPSData optional
Indicateurs de distribution supplémentaires fournis par USPS. Fourni uniquement dans les régions US et PR.
verdict
Type : Verdict optional
Indicateurs de verdict global
toJSON
toJSON()
Paramètres : aucun
Valeur renvoyée : Object
Convertit la classe AddressValidation en objet JSON avec les mêmes propriétés.

Interface AddressValidationRequest

Interface google.maps.addressValidation.AddressValidationRequest

Interface de requête pour AddressValidation.fetchAddressValidation.
address
Adresse en cours de validation. Les adresses non mises en forme doivent être envoyées via PostalAddress.addressLines.
placeAutocompleteElement optional
Type : PlaceAutocompleteElement optional
Si vous utilisez un élément PlaceAutocompleteElement, incluez-le ici pour associer les appels de l'API Address Validation au jeton de session de saisie semi-automatique.
previousResponseId optional
Type : string optional
Ce champ ne doit pas être défini pour la première demande de validation d'adresse. Si plusieurs demandes sont nécessaires pour valider complètement une seule adresse (par exemple, si les modifications apportées par l'utilisateur après la validation initiale doivent être revalidées), chaque demande de suivi doit remplir ce champ avec le AddressValidation.responseId de la toute première réponse de la séquence de validation.
sessionToken optional
Type : AutocompleteSessionToken optional
Jeton qui identifie une session Autocomplete à des fins de facturation.
uspsCASSEnabled optional
Type : boolean optional
Active le mode compatible USPS CASS. Cela n'affecte que le champ AddressValidation.uspsData de AddressValidation. Remarque : Pour les demandes compatibles USPS CASS concernant des adresses à Porto Rico, un PostalAddress.regionCode du address doit être indiqué comme "PR", ou un PostalAddress.administrativeArea du address doit être indiqué comme "Porto Rico" (sans tenir compte de la casse) ou "PR".

Classe Address

Classe google.maps.addressValidation.Address

Détails de l'adresse post-traitée. Le post-traitement consiste à corriger les parties mal orthographiées de l'adresse, à remplacer les parties incorrectes et à déduire les parties manquantes.

Accédez-y en appelant le const {Address} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
components
Composants individuels de l'adresse mise en forme et corrigée, ainsi que des informations de validation. Vous y trouverez des informations sur l'état de validation des différents composants.
formattedAddress
Type : string optional
Adresse post-traitée, mise en forme sur une seule ligne selon les règles de mise en forme des adresses de la région où elle se trouve.
missingComponentTypes
Type : Array<string>
Types de composants qui devaient être présents dans une adresse postale au format correct, mais qui n'ont pas été trouvés dans l'entrée ET n'ont pas pu être déduits. Les composants de ce type ne sont pas présents dans formatted_address, postal_address ni address_components. Par exemple, ['street_number', 'route'] pour une entrée telle que "Boulder, Colorado, 80301, États-Unis". Pour consulter la liste des types possibles, cliquez ici.
postalAddress
Type : PostalAddress optional
Adresse post-traitée représentée sous forme d'adresse postale.
unconfirmedComponentTypes
Type : Array<string>
Types des composants présents dans address_components, mais dont l'exactitude n'a pas pu être confirmée. Ce champ est fourni pour des raisons pratiques : son contenu équivaut à une itération dans address_components pour trouver les types de tous les composants où AddressComponent.confirmationLevel n'est pas ConfirmationLevel.CONFIRMED ou l'indicateur AddressComponent.inferred n'est pas défini sur true. Pour consulter la liste des types possibles, cliquez ici.
unresolvedTokens
Type : Array<string>
Tous les jetons de l'entrée qui n'ont pas pu être résolus. Il peut s'agir d'une entrée qui n'a pas été reconnue comme une partie valide d'une adresse. Par exemple, dans une entrée telle que "123235253253 Main St, San Francisco, CA, 94105", les jetons non résolus peuvent ressembler à ["123235253253"], car cela ne ressemble pas à un numéro de rue valide.

Classe AddressComponent

Classe google.maps.addressValidation.AddressComponent

Représente un seul composant d'une adresse (par exemple, le nom de la rue ou la ville).

Accédez-y en appelant le const {AddressComponent} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
componentName
Type : string optional
Texte du nom du composant. Par exemple, "5e Avenue" pour un nom de rue ou "1253" pour un numéro de rue.
componentNameLanguageCode
Type : string optional
Code de langue BCP-47. Cette valeur ne sera pas présente si le nom du composant n'est pas associé à une langue, comme un numéro de rue.
componentType
Type : string optional
Type du composant d'adresse. Pour obtenir la liste des types possibles, consultez le Tableau 2 : Autres types renvoyés par le service Places.
confirmationLevel
Type : ConfirmationLevel optional
Indique le degré de certitude que le composant est correct.
inferred
Type : boolean
Si la valeur est "true", cela signifie que ce composant ne faisait pas partie de l'entrée, mais qu'il a été déduit pour l'adresse. Il est recommandé d'inclure ce composant pour une adresse complète.
replaced
Type : boolean
Indique que le nom du composant a été remplacé par un nom complètement différent. Par exemple, remplacer un code postal incorrect par le bon code postal pour l'adresse. Il ne s'agit pas d'un changement esthétique. Le composant d'entrée a été remplacé par un autre.
spellCorrected
Type : boolean
Indique une correction d'une faute d'orthographe dans le nom du composant. L'API ne signale pas toujours les changements d'une variante orthographique à une autre, par exemple "centre" à "center".
unexpected
Type : boolean
Si la valeur est "true", ce composant ne doit pas être présent dans une adresse postale pour la région concernée. Il n'a été conservé que parce qu'il faisait partie de l'entrée.

Classe AddressMetadata

Classe google.maps.addressValidation.AddressMetadata

Métadonnées de l'adresse. Il n'est pas garanti que AddressMetadata soit entièrement renseigné pour chaque adresse envoyée à l'API Address Validation.

Accédez-y en appelant le const {AddressMetadata} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
business
Type : boolean
poBox
Type : boolean
residential
Type : boolean

Constantes ConfirmationLevel

google.maps.addressValidation.ConfirmationLevel constantes

Les différentes valeurs possibles indiquant le niveau de certitude que le composant est correct.

Accédez-y en appelant le const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Geocode class

Classe google.maps.addressValidation.Geocode

Contient des informations sur le lieu auquel l'entrée a été géocodée.

Accédez-y en appelant le const {Geocode} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
bounds
Type : LatLngBounds optional
Limites du lieu géocodé.
featureSizeMeters
Type : number optional
Taille du lieu géocodé, en mètres. Il s'agit d'une autre mesure de la précision de l'emplacement géocodé, mais en termes de taille physique plutôt que de signification sémantique.
location
Type : LatLngAltitude optional
Emplacement géocodé de l'entrée.
placeId
Type : string optional
ID du lieu géocodé. Il est préférable d'utiliser Place plutôt que des adresses, des coordonnées de latitude/longitude ou des plus codes. Si vous utilisez des coordonnées pour le routage ou pour calculer des itinéraires, le point sera toujours associé à la route la plus proche de ces coordonnées. Il peut s'agir d'une route qui ne mène pas rapidement ni en toute sécurité à la destination, et qui peut ne pas se trouver à proximité d'un point d'accès à la propriété. De plus, lorsqu'un emplacement est géocodé à l'inverse, il n'est pas garanti que l'adresse renvoyée corresponde à l'adresse d'origine.
placeTypes
Type : Array<string>
Type(s) de lieu auquel l'entrée a été géocodée. Par exemple, ['locality', 'political']. La liste complète des types est disponible dans la documentation de l'API Geocoding.
plusCode
Type : PlusCode optional
Plus Code correspondant à location.
fetchPlace
fetchPlace()
Paramètres : aucun
Valeur renvoyée : aucune
Renvoie une représentation Place de ce code géographique. Pour obtenir des informations complètes sur un lieu, vous devez appeler place.fetchFields().

Constantes de précision

google.maps.addressValidation.Granularity constantes

Les différentes granularités qu'une adresse ou un géocode peuvent avoir. Lorsqu'elles sont utilisées pour indiquer la précision d'une adresse, ces valeurs indiquent la précision avec laquelle l'adresse identifie une destination d'envoi. Par exemple, une adresse telle que "123 Main Street, Redwood City, CA, 94061" identifie un PREMISE, tandis qu'une adresse telle que "Redwood City, CA, 94061" identifie un LOCALITY. Toutefois, si nous ne parvenons pas à trouver de géocode pour "123 Main Street" à Redwood City, le géocode renvoyé peut être de granularité LOCALITY, même si l'adresse est plus précise.

Accédez-y en appelant le const {Granularity} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
BLOCK L'adresse ou le géocode indiquent un bloc. Utilisé uniquement dans les régions où l'adressage est effectué au niveau des blocs, comme au Japon.
OTHER Toutes les autres granularités, qui sont regroupées, car elles ne peuvent pas être diffusées.
PREMISE Résultat au niveau du bâtiment.
PREMISE_PROXIMITY Un géocode qui correspond approximativement à l'emplacement de l'adresse au niveau du bâtiment.
ROUTE Le géocode ou l'adresse sont précis au niveau de l'itinéraire, comme une rue, une route ou une autoroute.
SUB_PREMISE Résultat au niveau inférieur à celui du bâtiment, tel qu'un appartement.

Constantes PossibleNextAction

google.maps.addressValidation.PossibleNextAction constantes

Fournit un résumé interprétatif de la réponse de l'API, destiné à aider à déterminer une action ultérieure potentielle à entreprendre. Ce champ est dérivé d'autres champs de la réponse de l'API. Il ne doit pas être considéré comme une garantie de l'exactitude ou de la distribution de l'adresse.

Accédez-y en appelant le const {PossibleNextAction} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
ACCEPT La réponse de l'API ne contient pas de signaux justifiant l'une des autres valeurs PossibleNextAction. Vous pouvez envisager d'utiliser l'adresse post-traitée sans demander plus d'informations à votre client. Toutefois, cela ne garantit pas que l'adresse est valide et qu'elle ne contient pas encore de corrections. Il vous incombe de déterminer si et comment inviter votre client à effectuer une authentification, en fonction de votre propre évaluation des risques.
CONFIRM Un ou plusieurs champs de la réponse de l'API indiquent des problèmes mineurs potentiels avec l'adresse post-traitée (par exemple, le composant d'adresse postal_code était replaced). Demander à votre client de vérifier l'adresse peut contribuer à améliorer sa qualité.
CONFIRM_ADD_SUBPREMISES La réponse de l'API indique que l'adresse post-traitée peut ne pas comporter de sous-lieu. Demander à votre client de vérifier l'adresse et d'envisager d'ajouter un numéro de bâtiment peut contribuer à améliorer la qualité de l'adresse. L'adresse post-traitée peut également présenter d'autres problèmes mineurs. Remarque : Cette valeur d'énumération ne peut être renvoyée que pour les adresses aux États-Unis.
FIX Un ou plusieurs champs de la réponse de l'API indiquent un problème potentiel avec l'adresse post-traitée (par exemple, verdict.validation_granularity est défini sur OTHER). Inviter votre client à modifier l'adresse peut vous aider à améliorer sa qualité.

Classe USPSAddress

Classe google.maps.addressValidation.USPSAddress

Représentation USPS d'une adresse aux États-Unis.

Accédez-y en appelant le const {USPSAddress} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
city
Type : string optional
Nom de la ville.
cityStateZipAddressLine
Type : string optional
Ligne d'adresse contenant la ville, l'État et le code postal.
firm
Type : string optional
Nom de l'entreprise.
firstAddressLine
Type : string optional
Première ligne de l'adresse.
secondAddressLine
Type : string optional
Deuxième ligne de l'adresse.
state
Type : string optional
Code d'État à deux lettres.
urbanization
Type : string optional
Nom de l'urbanisation portoricaine.
zipCode
Type : string optional
Le code postal, par exemple "10009".
zipCodeExtension
Type : string optional
Extension à quatre chiffres du code postal, par exemple "5023".

Classe USPSData

Classe google.maps.addressValidation.USPSData

Données USPS pour l'adresse. Il n'est pas garanti que USPSData soit entièrement renseigné pour chaque adresse aux États-Unis ou à Porto Rico envoyée à l'API Address Validation. Nous vous recommandons d'intégrer les champs d'adresse de sauvegarde dans la réponse si vous utilisez uspsData comme partie principale de la réponse.

Accédez-y en appelant le const {USPSData} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
abbreviatedCity
Type : string optional
Ville abrégée.
addressRecordType
Type : string optional
Type d'enregistrement d'adresse correspondant à l'adresse saisie.
carrierRoute
Type : string optional
Code de la tournée du transporteur. Code à quatre caractères composé d'un préfixe d'une lettre et d'un numéro de route à trois chiffres.
carrierRouteIndicator
Type : string optional
Indicateur de tri des tarifs des itinéraires de transporteur.
cassProcessed
Type : boolean
Indicateur indiquant que la demande a été traitée par CASS.
county
Type : string optional
Nom du comté.
deliveryPointCheckDigit
Type : string optional
Chiffre de contrôle du point de livraison. Ce nombre est ajouté à la fin du code-barres du point de livraison pour le courrier scanné mécaniquement. La somme de tous les chiffres de delivery_point_barcode, delivery_point_check_digit, du code postal et de ZIP+4 doit être divisible par 10.
deliveryPointCode
Type : string optional
Code à deux chiffres du point de livraison.
dpvCMRA
Type : string optional
Indique si l'adresse est une CMRA (Commercial Mail Receiving Agency), c'est-à-dire une entreprise privée qui reçoit du courrier pour ses clients. Renvoie un seul caractère.
dpvConfirmation
Type : string optional
Valeurs possibles pour la confirmation de la DPV. Renvoie un seul caractère ou aucune valeur.
dpvDoorNotAccessible
Type : string optional
Indique les adresses où l'USPS ne peut pas frapper à la porte pour distribuer le courrier. Renvoie un seul caractère.
dpvDrop
Type : string optional
Le drapeau indique que le courrier est distribué dans un seul réceptacle sur un site. Renvoie un seul caractère.
dpvEnhancedDeliveryCode
Type : string optional
Indique que plusieurs codes de retour DPV sont valides pour l'adresse. Renvoie un seul caractère.
dpvFootnote
Type : string optional
Notes de bas de page issues de la validation des points de livraison. Plusieurs notes de bas de page peuvent être regroupées dans la même chaîne.
dpvNonDeliveryDays
Type : string optional
Indique que la distribution du courrier n'est pas effectuée tous les jours de la semaine. Renvoie un seul caractère.
dpvNonDeliveryDaysValues
Type : number optional
Entier identifiant les jours de non-diffusion. Il peut être interrogé à l'aide d'indicateurs binaires : 0x40 – Le dimanche est un jour sans livraison 0x20 – Le lundi est un jour sans livraison 0x10 – Le mardi est un jour sans livraison 0x08 – Le mercredi est un jour sans livraison 0x04 – Le jeudi est un jour sans livraison 0x02 – Le vendredi est un jour sans livraison 0x01 – Le samedi est un jour sans livraison
dpvNoSecureLocation
Type : string optional
Le drapeau indique que la porte est accessible, mais le colis ne sera pas déposé en raison de problèmes de sécurité. Renvoie un seul caractère.
dpvNoStat
Type : string optional
Indique si l'adresse est une adresse sans numéro ou une adresse active. Les adresses sans numéro de rue sont celles qui ne sont pas occupées en permanence ou celles que l'USPS ne dessert pas. Renvoie un seul caractère.
dpvNoStatReasonCode
Type : number optional
Indique le type NoStat. Renvoie un code de motif sous forme d'entier.
dpvPBSA
Type : string optional
Indique que l'adresse correspond à un enregistrement PBSA. Renvoie un seul caractère.
dpvThrowback
Type : string optional
Indique que le courrier n'est pas distribué à l'adresse postale. Renvoie un seul caractère.
dpvVacant
Type : string optional
Indique si l'adresse est vacante. Renvoie un seul caractère.
elotFlag
Type : string optional
Indicateur de l'eLOT croissant/décroissant (A/D).
elotNumber
Type : string optional
Numéro eLOT (Enhanced Line of Travel).
errorMessage
Type : string optional
Message d'erreur lors de la récupération des données USPS. Ce champ est renseigné lorsque le traitement USPS est suspendu en raison de la détection d'adresses créées artificiellement.
fipsCountyCode
Type : string optional
Code FIPS du comté.
hasDefaultAddress
Type : boolean
Indique qu'une adresse par défaut a été trouvée, mais que des adresses plus spécifiques existent.
hasNoEWSMatch
Type : boolean
L'adresse de livraison peut être mise en correspondance, mais le fichier EWS indique qu'une correspondance exacte sera bientôt disponible.
lacsLinkIndicator
Type : string optional
Indicateur LACSLink.
lacsLinkReturnCode
Type : string optional
Code de retour LACSLink.
pmbDesignator
Type : string optional
Indicateur de conception de l'unité PMB (Private Mail Box).
pmbNumber
Type : string optional
Numéro de boîte postale privée (PMB, Private Mail Box).
poBoxOnlyPostalCode
Type : boolean
Code postal de boîte postale uniquement.
postOfficeCity
Type : string optional
Ville du bureau de poste principal.
postOfficeState
Type : string optional
État du bureau de poste principal.
standardizedAddress
Type : USPSAddress optional
Adresse standardisée USPS.
suiteLinkFootnote
Type : string optional
Notes de bas de page indiquant qu'un enregistrement de rue ou d'immeuble correspond à des informations sur un appartement. Si une correspondance est trouvée pour le nom de l'établissement, le numéro secondaire est renvoyé.

Classe Verdict

Classe google.maps.addressValidation.Verdict

Représente l'adresse post-traitée pour l'adresse fournie.

Accédez-y en appelant le const {Verdict} = await google.maps.importLibrary("addressValidation").
 Consultez Bibliothèques de l'API Maps JavaScript.
addressComplete
Type : boolean
L'adresse est considérée comme complète s'il n'y a pas de jetons non résolus, ni de composants d'adresse inattendus ou manquants. Si elle n'est pas définie, indique que la valeur est false. Pour en savoir plus, consultez les champs Address.missingComponentTypes, Address.unresolvedTokens ou AddressComponent.unexpected.
geocodeGranularity
Type : Granularity optional
Informations sur la précision de Geocode. Cela peut être interprété comme la signification sémantique de la précision de l'emplacement géocodé.
hasInferredComponents
Type : boolean
Au moins un composant d'adresse a été inféré (c'est-à-dire ajouté) et ne figurait pas dans l'entrée. Pour en savoir plus, consultez AddressComponent.
hasReplacedComponents
Type : boolean optional
Au moins un composant d'adresse a été remplacé. Pour en savoir plus, consultez AddressComponent.
hasUnconfirmedComponents
Type : boolean
Au moins un composant d'adresse ne peut pas être classé ni validé. Pour en savoir plus, consultez AddressComponent.
inputGranularity
Type : Granularity optional
Précision de l'adresse input. Il s'agit du résultat de l'analyse de l'adresse saisie. Il ne fournit aucun signal de validation. Pour les signaux de validation, consultez validationGranularity.
possibleNextAction
Type : PossibleNextAction optional
Action suivante possible à effectuer en fonction d'autres champs de la réponse de l'API. Pour en savoir plus, consultez PossibleNextAction.
validationGranularity
Type : Granularity optional
Niveau de précision auquel l'API peut valider l'adresse. Par exemple, un validationGranularity de PREMISE indique que tous les composants d'adresse au niveau de PREMISE et au-delà peuvent être validés.