Classe AddressValidation
Classe google.maps.addressValidation.AddressValidation
library "addressValidation"
Classe statique permettant d'accéder aux API AddressValidation.
const {AddressValidation} = await google.maps.importLibrary("addressValidation");
Méthodes statiques | |
|---|---|
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. |
Propriétés | |
|---|---|
address
readonly |
Type :
Address optionalInformations sur l'adresse elle-même, par opposition au géocode. |
geocode
readonly |
Type :
Geocode optionalInformations sur l'emplacement et le lieu auxquels l'adresse a été géocodée. |
metadata
readonly |
Type :
AddressMetadata optionalAutres informations pertinentes 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
readonly |
Type :
string optionalUUID qui identifie cette réponse. Si l'adresse doit être revalidée, cet UUID doit accompagner la nouvelle requête. |
uspsData
readonly |
Type :
USPSData optionalIndicateurs de distribution supplémentaires fournis par USPS. Fourni uniquement dans les régions US et PR. |
verdict
readonly |
Type :
Verdict optionalOptions d'évaluation globale |
Méthodes | |
|---|---|
Hérité :
toJSON
|
Interface AddressValidationRequest
google.maps.addressValidation.AddressValidationRequest
interface
Interface de requête pour AddressValidation.fetchAddressValidation.
Propriétés | |
|---|---|
address |
Type :
PostalAddressLiteralAdresse en cours de validation. Les adresses non formatées doivent être envoyées via PostalAddress.addressLines. |
placeAutocompleteElement
facultatif |
Type :
PlaceAutocompleteElement optionalSi vous utilisez un PlaceAutocompleteElement, incluez-le ici pour associer les appels d'API AddressValidation au jeton de session de saisie semi-automatique. |
previousResponseId
facultatif |
Type :
string optionalCe champ ne doit pas être défini pour la première requête de validation d'adresse. Si d'autres requêtes 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 validées à nouveau), chaque requête de suivi doit renseigner ce champ avec le AddressValidation.responseId de la toute première réponse de la séquence de validation. |
sessionToken
facultatif |
Type :
AutocompleteSessionToken optionalJeton qui identifie une session Autocomplete à des fins de facturation. |
uspsCASSEnabled
facultatif |
Type :
boolean optionalActive le mode compatible USPS CASS. Cela n'affecte que le champ AddressValidation.uspsData de AddressValidation. Remarque : Pour les requêtes USPS CASS concernant des adresses à Porto Rico, un PostalAddress.regionCode de address doit être fourni sous la forme "PR", ou un PostalAddress.administrativeArea de address doit être fourni sous la forme "Puerto Rico" (non sensible à la casse) ou "PR". |
Classe Address
Classe google.maps.addressValidation.Address
library "addressValidation"
Détails de l'adresse post-traitée. Le post-traitement inclut la correction des parties mal orthographiées de l'adresse, le remplacement des parties incorrectes et l'inférence des parties manquantes.
const {Address} = await google.maps.importLibrary("addressValidation");
Propriétés | |
|---|---|
components
readonly |
Type :
Array<AddressComponent>Composants d'adresse individuels de l'adresse mise en forme et corrigée, ainsi que les informations de validation. Cela fournit des informations sur l'état de validation des différents composants. |
formattedAddress
readonly |
Type :
string optionalAdresse 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ù se trouve l'adresse. |
missingComponentTypes
readonly |
Type :
Array<string>Types de composants qui auraient dû être présents dans une adresse postale correctement formatée, 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 ou address_components. Par exemple, ['street_number', 'route'] pour une entrée telle que "Boulder, Colorado, 80301, USA". La liste des types possibles est disponible ici. |
postalAddress
readonly |
Type :
PostalAddress optionalAdresse post-traitée représentée sous forme d'adresse postale. |
unconfirmedComponentTypes
readonly |
Type :
Array<string>Types des composants présents dans le address_components, mais dont l'exactitude n'a pas pu être confirmée. Ce champ est fourni pour des raisons de commodité : son contenu équivaut à parcourir 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. La liste des types possibles est disponible ici. |
unresolvedTokens
readonly |
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. |
Méthodes | |
|---|---|
Hérité :
toJSON
|
Classe AddressComponent
Classe google.maps.addressValidation.AddressComponent
library "addressValidation"
Représente un seul composant d'une adresse (par exemple, le nom de la rue ou la ville).
const {AddressComponent} = await google.maps.importLibrary("addressValidation");
Propriétés | |
|---|---|
componentName
readonly |
Type :
string optionalTexte du nom du composant. Par exemple, "5th Avenue" pour un nom de rue ou "1253" pour un numéro de rue. |
componentNameLanguageCode
readonly |
Type :
string optionalCode de langue BCP-47. Ce champ n'est pas présent si le nom du composant n'est pas associé à une langue (par exemple, un numéro de rue). |
componentType
readonly |
Type :
string optionalType du composant d'adresse. Consultez le Tableau 2 : Autres types renvoyés par le service Places pour obtenir la liste des types possibles. |
confirmationLevel
readonly |
Type :
ConfirmationLevel optionalIndique le niveau de certitude que le composant est correct. |
inferred
readonly |
Type :
booleanSi la valeur est "true", ce composant ne faisait pas partie de l'entrée, mais a été déduit pour l'emplacement de l'adresse. Il est recommandé d'inclure ce composant pour obtenir une adresse complète. |
replaced
readonly |
Type :
booleanIndique que le nom du composant a été remplacé par un nom complètement différent. Par exemple, remplacer un code postal incorrect par un code postal correct 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
readonly |
Type :
booleanIndique 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 de "centre" à "center". |
unexpected
readonly |
Type :
booleanSi la valeur est "true", ce composant n'est pas censé être présent dans une adresse postale pour la région donnée. Il n'a été conservé que parce qu'il faisait partie de l'entrée. |
Classe AddressMetadata
Classe google.maps.addressValidation.AddressMetadata
library "addressValidation"
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.
const {AddressMetadata} = await google.maps.importLibrary("addressValidation");
Propriétés | |
|---|---|
business
readonly |
Type :
boolean |
poBox
readonly |
Type :
boolean |
residential
readonly |
Type :
boolean |
Méthodes | |
|---|---|
Hérité :
toJSON
|
Constantes ConfirmationLevel
google.maps.addressValidation.ConfirmationLevel
Bibliothèque de constantes
"addressValidation"
Différentes valeurs possibles indiquant le niveau de certitude que le composant est correct.
Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type ConfirmationLevelString.
const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation");
Constantes | |
|---|---|
CONFIRMED |
|
UNCONFIRMED_AND_SUSPICIOUS |
|
UNCONFIRMED_BUT_PLAUSIBLE |
|
Classe Geocode
Classe google.maps.addressValidation.Geocode
library "addressValidation"
Contient des informations sur le lieu où l'entrée a été géocodée.
const {Geocode} = await google.maps.importLibrary("addressValidation");
Propriétés | |
|---|---|
bounds
readonly |
Type :
LatLngBounds optionalLimites du lieu géocodé. |
featureSizeMeters
readonly |
Type :
number optionalTaille 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 taille physique plutôt qu'en signification sémantique. |
location
readonly |
Type :
LatLngAltitude optionalEmplacement géocodé de l'entrée. |
placeId
readonly |
Type :
string optionalID de lieu 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 calculer un itinéraire ou un itinéraire routier, le point sera toujours aligné sur la route la plus proche de ces coordonnées. Il est possible que cette route ne mène pas rapidement ou en toute sécurité à la destination, et qu'elle ne soit pas à proximité d'un point d'accès à la propriété. De plus, lorsqu'un lieu est géocodé de manière inversée, il n'est pas garanti que l'adresse renvoyée corresponde à l'adresse d'origine. |
placeTypes
readonly |
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
readonly |
Type :
PlusCode optionalPlus Code correspondant à location. |
Méthodes | |
|---|---|
fetchPlace |
fetchPlace()Paramètres : aucun
Valeur renvoyée : aucune
Renvoie une représentation Place de ce Geocode. Pour obtenir des détails complets sur un lieu, vous devez appeler place.fetchFields(). |
Hérité :
toJSON
| |
Constantes de granularité
google.maps.addressValidation.Granularity
Bibliothèque de constantes
"addressValidation"
Les différents niveaux de précision qu'une adresse ou un code géographique 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 postale. 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 un code géographique pour "123 Main Street" à Redwood City, le code géographique renvoyé peut être de précision LOCALITY, même si l'adresse est plus précise.
Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type GranularityString.
const {Granularity} = await google.maps.importLibrary("addressValidation");
Constantes | |
|---|---|
BLOCK |
L'adresse ou le code géographique indique un pâté de maisons. Utilisé uniquement dans les régions qui utilisent l'adressage au niveau du bloc, comme le Japon. |
OTHER |
Toutes les autres granularités, qui sont regroupées, car elles ne sont pas diffusables. |
PREMISE |
Résultat au niveau du bâtiment. |
PREMISE_PROXIMITY |
Un code géographique qui correspond approximativement à l'emplacement de l'adresse au niveau du bâtiment. |
ROUTE |
Le code géographique ou l'adresse est précis au niveau de la route (rue, route ou autoroute, par exemple). |
SUB_PREMISE |
Résultat au niveau d'un bâtiment, comme un appartement. |
PossibleNextAction
google.maps.addressValidation.PossibleNextAction
Bibliothèque de constantes
"addressValidation"
Fournit un résumé interprétatif de la réponse de l'API, destiné à aider à déterminer une éventuelle action ultérieure à entreprendre. Ce champ est dérivé d'autres champs de la réponse de l'API et ne doit pas être considéré comme une garantie de l'exactitude ou de la distribution de l'adresse.
Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type PossibleNextActionString.
const {PossibleNextAction} = await google.maps.importLibrary("addressValidation");
Constantes | |
|---|---|
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 d'autres informations à votre client, même si cela ne garantit pas que l'adresse est valide et qu'elle peut encore contenir des corrections. Il vous incombe de déterminer si vous devez inviter votre client à agir et comment, 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. Inviter votre client à vérifier l'adresse peut vous aider à améliorer la qualité de l'adresse. |
CONFIRM_ADD_SUBPREMISES |
La réponse de l'API indique qu'il manque peut-être un sous-bâtiment dans l'adresse post-traitée. Inviter votre client à vérifier l'adresse et à envisager d'ajouter un numéro d'appartement 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 OTHER. Inviter votre client à modifier l'adresse peut vous aider à améliorer la qualité de l'adresse. |
Classe USPSAddress
Classe google.maps.addressValidation.USPSAddress
library "addressValidation"
Représentation USPS d'une adresse aux États-Unis.
const {USPSAddress} = await google.maps.importLibrary("addressValidation");
Propriétés | |
|---|---|
city
readonly |
Type :
string optionalNom de la ville. |
cityStateZipAddressLine
readonly |
Type :
string optionalLigne d'adresse contenant la ville, l'État et le code postal. |
firm
readonly |
Type :
string optionalNom de l'entreprise. |
firstAddressLine
readonly |
Type :
string optionalPremière ligne de l'adresse. |
secondAddressLine
readonly |
Type :
string optionalDeuxième ligne de l'adresse. |
state
readonly |
Type :
string optionalCode d'État à deux lettres. |
urbanization
readonly |
Type :
string optionalNom de l'urbanisation portoricaine. |
zipCode
readonly |
Type :
string optionalCode postal, par exemple "10009". |
zipCodeExtension
readonly |
Type :
string optionalExtension de code postal à quatre chiffres, par exemple "5023". |
Méthodes | |
|---|---|
Hérité :
toJSON
|
Classe USPSData
Classe google.maps.addressValidation.USPSData
library "addressValidation"
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 secours dans la réponse si vous utilisez uspsData comme partie principale de la réponse.
const {USPSData} = await google.maps.importLibrary("addressValidation");
Propriétés | |
|---|---|
abbreviatedCity
readonly |
Type :
string optionalVille abrégée. |
addressRecordType
readonly |
Type :
string optionalType de l'enregistrement d'adresse qui correspond à l'adresse d'entrée. |
carrierRoute
readonly |
Type :
string optionalCode de l'itinéraire du transporteur. Code à quatre caractères composé d'un préfixe d'une lettre et d'un indicateur d'itinéraire à trois chiffres. |
carrierRouteIndicator
readonly |
Type :
string optionalIndicateur de tri des tarifs par itinéraire de transporteur. |
cassProcessed
readonly |
Type :
booleanIndique que la demande a été traitée par le CASS. |
county
readonly |
Type :
string optionalNom du comté. |
deliveryPointCheckDigit
readonly |
Type :
string optionalChiffre de contrôle du point de livraison. Ce numéro est ajouté à la fin du delivery_point_barcode pour le courrier scanné mécaniquement. L'addition de tous les chiffres de delivery_point_barcode, delivery_point_check_digit, postal code et ZIP+4 doit donner un nombre divisible par 10. |
deliveryPointCode
readonly |
Type :
string optionalCode de point de livraison à deux chiffres. |
dpvCMRA
readonly |
Type :
string optionalIndique 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
readonly |
Type :
string optionalValeurs possibles pour la confirmation DPV. Renvoie un seul caractère ou ne renvoie aucune valeur. |
dpvDoorNotAccessible
readonly |
Type :
string optionalIndique les adresses où l'USPS ne peut pas frapper à la porte pour distribuer le courrier. Renvoie un seul caractère. |
dpvDrop
readonly |
Type :
string optionalLe drapeau indique que le courrier est distribué dans un seul réceptacle sur un site. Renvoie un seul caractère. |
dpvEnhancedDeliveryCode
readonly |
Type :
string optionalIndique que plusieurs codes de retour DPV sont valides pour l'adresse. Renvoie un seul caractère. |
dpvFootnote
readonly |
Type :
string optionalNotes de bas de page de la validation du point de livraison. Plusieurs notes de bas de page peuvent être regroupées dans la même chaîne. |
dpvNonDeliveryDays
readonly |
Type :
string optionalIndique que le courrier n'est pas distribué tous les jours de la semaine. Renvoie un seul caractère. |
dpvNonDeliveryDaysValues
readonly |
Type :
number optionalEntier identifiant les jours de non-livraison. Il peut être interrogé à l'aide d'indicateurs de bits : 0x40 – Dimanche est un jour sans livraison 0x20 – Lundi est un jour sans livraison 0x10 – Mardi est un jour sans livraison 0x08 – Mercredi est un jour sans livraison 0x04 – Jeudi est un jour sans livraison 0x02 – Vendredi est un jour sans livraison 0x01 – Samedi est un jour sans livraison |
dpvNoSecureLocation
readonly |
Type :
string optionalLe drapeau indique que la porte est accessible, mais que le colis ne sera pas laissé en raison de problèmes de sécurité. Renvoie un seul caractère. |
dpvNoStat
readonly |
Type :
string optionalIndique si l'adresse est une adresse sans statistiques ou une adresse active. Les adresses "No stat" sont des adresses qui ne sont pas occupées en permanence ou des adresses qui ne sont pas desservies par l'USPS. Renvoie un seul caractère. |
dpvNoStatReasonCode
readonly |
Type :
number optionalIndique le type NoStat. Renvoie un code de motif sous forme d'entier. |
dpvPBSA
readonly |
Type :
string optionalIndique que l'adresse correspond à un enregistrement PBSA. Renvoie un seul caractère. |
dpvThrowback
readonly |
Type :
string optionalIndique que le courrier n'est pas distribué à l'adresse postale. Renvoie un seul caractère. |
dpvVacant
readonly |
Type :
string optionalIndique si l'adresse est vacante. Renvoie un seul caractère. |
elotFlag
readonly |
Type :
string optionalIndicateur d'ordre croissant/décroissant eLOT (A/D). |
elotNumber
readonly |
Type :
string optionalNuméro eLOT (Enhanced Line of Travel). |
errorMessage
readonly |
Type :
string optionalMessage d'erreur pour 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
readonly |
Type :
string optionalCode FIPS du comté. |
hasDefaultAddress
readonly |
Type :
booleanIndicateur qu'une adresse par défaut a été trouvée, mais qu'il existe des adresses plus spécifiques. |
hasNoEWSMatch
readonly |
Type :
booleanL'adresse de livraison est compatible, mais le fichier EWS indique qu'une correspondance exacte sera bientôt disponible. |
lacsLinkIndicator
readonly |
Type :
string optionalIndicateur LACSLink. |
lacsLinkReturnCode
readonly |
Type :
string optionalCode renvoyé par LACSLink. |
pmbDesignator
readonly |
Type :
string optionalDésignation de l'unité PMB (Private Mail Box). |
pmbNumber
readonly |
Type :
string optionalNuméro de boîte postale privée (PMB, Private Mail Box). |
poBoxOnlyPostalCode
readonly |
Type :
booleanCode postal de boîte postale uniquement. |
postOfficeCity
readonly |
Type :
string optionalVille du bureau de poste principal. |
postOfficeState
readonly |
Type :
string optionalÉtat du bureau de poste principal. |
standardizedAddress
readonly |
Type :
USPSAddress optionalAdresse standardisée USPS. |
suiteLinkFootnote
readonly |
Type :
string optionalNotes de bas de page issues de la mise en correspondance d'un enregistrement de rue ou d'immeuble avec des informations sur la suite. Si une correspondance est trouvée avec le nom de l'entreprise, le numéro secondaire est renvoyé. |
Méthodes | |
|---|---|
Hérité :
toJSON
|
Classe Verdict
Classe google.maps.addressValidation.Verdict
library "addressValidation"
Représente l'adresse post-traitée pour l'adresse fournie.
const {Verdict} = await google.maps.importLibrary("addressValidation");
Propriétés | |
|---|---|
addressComplete
readonly |
Type :
booleanL'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, cela indique que la valeur est false. Pour en savoir plus, consultez les champs Address.missingComponentTypes, Address.unresolvedTokens ou AddressComponent.unexpected. |
geocodeGranularity
readonly |
Type :
Granularity optionalInformations sur la précision de Geocode. Cela peut être compris comme la signification sémantique de la précision de la localisation géocodée. |
hasInferredComponents
readonly |
Type :
booleanAu moins un composant d'adresse a été déduit (c'est-à-dire ajouté) alors qu'il n'était pas présent dans l'entrée. Pour en savoir plus, consultez AddressComponent. |
hasReplacedComponents
readonly |
Type :
boolean optionalAu moins un composant d'adresse a été remplacé. Pour en savoir plus, consultez AddressComponent. |
hasUnconfirmedComponents
readonly |
Type :
booleanAu moins un composant d'adresse ne peut pas être catégorisé ni validé. Pour en savoir plus, consultez AddressComponent. |
inputGranularity
readonly |
Type :
Granularity optionalPrécision de l'adresse d'entrée. Il s'agit du résultat de l'analyse de l'adresse d'entrée, qui ne fournit aucun signal de validation. Pour en savoir plus sur les signaux de validation, consultez validationGranularity. |
readonly |
Type :
PossibleNextAction optionalAction suivante possible à effectuer en fonction d'autres champs de la réponse de l'API. Pour en savoir plus, consultez PossibleNextAction. |
validationGranularity
readonly |
Type :
Granularity optionalNiveau de précision auquel l'API peut valider entièrement l'adresse. Par exemple, une valeur validationGranularity de PREMISE indique que tous les composants d'adresse au niveau de PREMISE et au-dessus peuvent être validés. |