Index
AddressValidation
(interface)Address
(message)AddressComponent
(message)AddressComponent.ConfirmationLevel
(enum)AddressMetadata
(message)ComponentName
(message)Geocode
(message)PlusCode
(message)ProvideValidationFeedbackRequest
(message)ProvideValidationFeedbackRequest.ValidationConclusion
(enum)ProvideValidationFeedbackResponse
(message)UspsAddress
(message)UspsData
(message)ValidateAddressRequest
(message)ValidateAddressResponse
(message)ValidationResult
(message)Verdict
(message)Verdict.Granularity
(enum)
Validation de l'adresse
Service de validation des adresses.
FournirValidationFeedback |
---|
Commentaires sur le résultat de la séquence de tentatives de validation. Il doit s'agir du dernier appel effectué après une séquence d'appels de validation pour la même adresse. Il doit être appelé une fois la transaction terminée. Cet e-mail ne doit être envoyé qu'une seule fois pour la séquence de |
Valider l'adresse |
---|
Valide une adresse. |
Adresse
Détails de l'adresse analysée à partir de l'entrée.
Champs | |
---|---|
formatted_address |
Adresse corrigée, au format d'une ligne unique, conformément aux règles de mise en forme de la région où se trouve l'adresse. |
postal_address |
Adresse validée représentée sous la forme d'une adresse postale. |
address_components[] |
Liste à puces. Composants individuels de l'adresse formatée et corrigée, ainsi que les informations de validation Vous obtenez ainsi des informations sur l'état de validation de chaque composant. Les composants d'adresse ne sont pas organisés d'une certaine manière. Ne faites aucune hypothèse concernant l'ordre des composants d'adresse dans la liste. |
missing_component_types[] |
Types de composants censés être présents dans une adresse postale correcte, mais introuvables dans l'entrée ET n'ayant pas pu être déduits. Les composants de ce type ne sont pas présents dans |
unconfirmed_component_types[] |
Types des composants présents dans |
unresolved_tokens[] |
Tous les jetons de l'entrée qui n'ont pas pu être résolus. Il peut s'agir d'une entrée non reconnue comme une partie valide d'une adresse (par exemple, "123235253253 Main St, San Francisco, CA, 94105"), les jetons non résolus peuvent ressembler à |
Composant AddressAddress
Représente un composant d'adresse, comme une rue, une ville ou une région.
Champs | |
---|---|
component_name |
Nom de ce composant. |
component_type |
Type du composant d'adresse. Reportez-vous au Tableau 2: Types supplémentaires renvoyés par le service Places pour obtenir la liste des types possibles. |
confirmation_level |
Indique le niveau de certitude selon lequel le composant est correct. |
inferred |
Indique que le composant ne faisait pas partie de l'entrée, mais que nous l'avons déduit pour l'emplacement de l'adresse et pensons qu'il devrait être fourni pour une adresse complète. |
spell_corrected |
Indique que le nom du composant a été mal corrigé et a été modifié de façon mineure (par exemple, en remplaçant deux caractères dans le mauvais ordre). Cela indique un changement esthétique. |
replaced |
Indique que le nom du composant a été remplacé par un autre, par exemple un code postal incorrect remplacé 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. |
unexpected |
Indique un composant d'adresse qui n'est pas censé être présent dans une adresse postale pour la région donnée. Nous l'avons conservée uniquement parce qu'elle faisait partie de l'entrée. |
Niveau de confirmation
Différentes valeurs possibles pour les niveaux de confirmation.
Enums | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
CONFIRMED |
Nous avons pu vérifier que ce composant existe et qu'il est pertinent dans le contexte de l'adresse. |
UNCONFIRMED_BUT_PLAUSIBLE |
Impossible de confirmer ce composant, mais il est plausible qu'il existe. (par exemple, un numéro de rue compris dans une plage connue valide). |
UNCONFIRMED_AND_SUSPICIOUS |
Ce composant n'a pas été confirmé et est probablement incorrect. (par exemple, un quartier qui ne correspond pas au reste de l'adresse). |
AddressMetadata
Métadonnées de l'adresse. Il n'est pas garanti que metadata
soit entièrement renseigné pour chaque adresse envoyée à l'API Address Validation.
Champs | |
---|---|
business |
Indique qu'il s'agit de l'adresse d'un établissement. Si ce champ n'est pas spécifié, indique que la valeur est inconnue. |
po_box |
Indique l'adresse d'une boîte postale. Si ce champ n'est pas spécifié, indique que la valeur est inconnue. |
residential |
Indique qu'il s'agit de l'adresse d'une résidence. Si ce champ n'est pas spécifié, indique que la valeur est inconnue. |
Nom du composant
Wrapper du nom du composant.
Champs | |
---|---|
text |
Texte du nom. Par exemple, "5e avenue" pour un nom de rue ou "1253" pour un numéro de rue. |
language_code |
Code de langue BCP-47. Cette valeur n'est pas présente si le nom du composant n'est pas associé à une langue, comme un numéro de rue. |
Géocoder
Contient des informations sur le lieu auquel l'entrée a été géocodée.
Champs | |
---|---|
location |
Emplacement géocodé de l'entrée. Il est préférable d'utiliser des identifiants de lieu plutôt que des adresses, des coordonnées de latitude/longitude ou des codes plus code. Lorsque vous utilisez des coordonnées lorsque vous calculez un itinéraire routier ou que vous calculez un itinéraire, le point d'accès est toujours aligné sur la route la plus proche de ces coordonnées. Il peut s'agir d'une route qui débouche rapidement ou de façon sécurisée sur la destination, et qui peut se trouver à proximité d'un point d'accès à l'établissement. De plus, lorsqu'une position géographique est géocodée de manière inversée, rien ne garantit que l'adresse renvoyée correspondra à l'adresse d'origine. |
plus_code |
Plus code correspondant à |
bounds |
Limites du lieu géocodé. |
feature_size_meters |
Taille du lieu géocodé, en mètres. Il s'agit d'une autre mesure de l'imprécision de la localisation géocodée, mais en termes de taille physique plutôt que sémantique. |
place_id |
ID de lieu du lieu vers lequel cette entrée est géocodée. Pour en savoir plus sur les ID de lieu, cliquez ici. |
place_types[] |
Type(s) de lieu vers lequel l'entrée a été géocodée. Par exemple, |
PlusCode
Le plus code (http://plus.codes) est une référence de lieu comportant deux formats: le code global définissant un rectangle de 14mx14m (1/8000e de degré) ou un plus petit rectangle, et un code composé remplaçant le préfixe par un emplacement de référence.
Champs | |
---|---|
global_code |
Code global (par exemple, "9FWM33GV+HQ") qui représente une zone de 1/8000 par 1/8000 degré (environ 14 par 14 mètres). |
compound_code |
Code composé d'un lieu, tel que "33GV+HQ, Ramberg, Norvège", contenant le suffixe du code global et remplaçant le préfixe par le nom formaté d'une entité de référence. |
ProvideValidationFeedbackRequest
Requête d'envoi de commentaires de validation.
Champs | |
---|---|
conclusion |
Obligatoire. Résultat de la séquence de tentatives de validation. Si ce champ est défini sur |
response_id |
Obligatoire. ID de la réponse à laquelle ce commentaire est destiné. Il doit s'agir du champ [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] de la première réponse d'une série de tentatives de validation de l'adresse. |
Conclusion de la validation
Résultats finaux possibles de la séquence de requêtes de validation d'adresse nécessaires pour valider une adresse.
Enums | |
---|---|
VALIDATION_CONCLUSION_UNSPECIFIED |
Cette valeur n'est pas utilisée. Si le champ ProvideValidationFeedbackRequest.conclusion est défini sur VALIDATION_CONCLUSION_UNSPECIFIED , une erreur INVALID_ARGUMENT est renvoyée. |
VALIDATED_VERSION_USED |
La version de l'adresse renvoyée par l'API Address Validation a été utilisée pour la transaction. |
USER_VERSION_USED |
La version de l'adresse fournie par l'utilisateur a été utilisée pour la transaction |
UNVALIDATED_VERSION_USED |
Une version de l'adresse saisie après la dernière tentative de validation, mais qui n'a pas été à nouveau validée, a été utilisée pour la transaction. |
UNUSED |
La transaction a été abandonnée et l'adresse n'a pas été utilisée. |
ProvideValidationFeedbackResponse
Réponse pour les commentaires de validation.
La réponse est vide si les commentaires ont bien été envoyés.
Adresse USB
Représentation USPS d'une adresse aux États-Unis
Champs | |
---|---|
first_address_line |
Première ligne d'adresse. |
firm |
Nom de la société. |
second_address_line |
Deuxième ligne d'adresse. |
urbanization |
Nom de l'urbanisation portoricaine. |
city_state_zip_address_line |
Ville + État + Code postal |
city |
Nom de la ville. |
state |
Code d'état à deux lettres. |
zip_code |
Code postal, par exemple 10009. |
zip_code_extension |
Extension de code postal à 4 chiffres (5023, par exemple) |
Données USB
Données USPS de l'adresse. Il n'est pas garanti que uspsData
soit entièrement renseigné pour chaque adresse des États-Unis ou des relations publiques envoyées à 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.
Champs | |
---|---|
standardized_address |
Adresse standardisée USPS. |
delivery_point_code |
Code à deux chiffres du point de livraison |
delivery_point_check_digit |
Le chiffre de contrôle du point de livraison. Ce numéro est ajouté à la fin du code-barres "delivery_point_bar" pour les messages scannés automatiquement. Si vous additionnez tous les chiffres du code_barres_de_livraison, du chiffre_check_point_de_livraison, du code postal et du code postal +4, vous devez obtenir un nombre divisible par 10. |
dpv_confirmation |
Valeurs possibles pour la confirmation DPV. Renvoie un seul caractère.
|
dpv_footnote |
Notes de bas de page issues de la validation du point de livraison Plusieurs notes de bas de page peuvent être liées dans la même chaîne.
|
dpv_cmra |
Indique s'il s'agit d'une agence de réception de courrier commercial, c'est-à-dire une entreprise privée recevant des messages pour ses clients. Renvoie un seul caractère.
|
dpv_vacant |
Ce lieu est-il inoccupé ? Renvoie un seul caractère.
|
dpv_no_stat |
S'agit-il d'une adresse non statistique ou active ? Aucune adresse statistique n'est occupée de manière continue ou n'est pas prise en charge par l'USPS. Renvoie un seul caractère.
|
carrier_route |
Code d'itinéraire de l'opérateur. Code composé de quatre caractères, composé d'un préfixe à une lettre et d'un outil de désignation de route à trois chiffres. Préfixes:
|
carrier_route_indicator |
Indicateur de tri du tarif de l'itinéraire de l'opérateur. |
ews_no_match |
L'adresse de livraison peut être mise en correspondance, mais le fichier EWS indique qu'une correspondance exacte sera bientôt disponible. |
post_office_city |
Ville du bureau de poste principal. |
post_office_state |
État principal du bureau de poste. |
abbreviated_city |
Ville abrégée. |
fips_county_code |
Code de comté FIPS. |
county |
Nom du comté. |
elot_number |
Numéro de ligne de transport amélioré (eLOT). |
elot_flag |
Indicateur ELOT croissant/décroissant (A/D) |
lacs_link_return_code |
Code de retour LACSLink. |
lacs_link_indicator |
Indicateur LACSLink. |
po_box_only_postal_code |
Code postal uniquement. |
suitelink_footnote |
Les notes de bas de page ne doivent pas faire correspondre les informations concernant une rue ou un gratte-ciel avec les informations sur la suite. Si une correspondance est trouvée pour le nom de l'entreprise, le numéro secondaire est renvoyé.
|
pmb_designator |
Décodeur d'unités PMB (Private Mail Box). |
pmb_number |
Numéro PMB (Private Mail Box) |
address_record_type |
Type d'enregistrement d'adresse correspondant à l'adresse d'entrée.
|
default_address |
Indique qu'une adresse par défaut a été trouvée, mais qu'il existe des adresses plus spécifiques. |
error_message |
Message 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 artificiellement créées. Les champs de données USPS peuvent ne pas être renseignés lorsque cette erreur se produit. |
cass_processed |
Indique que la requête a été traitée par CASS. |
Demande de validation d'adresse
Requête de validation d'une adresse.
Champs | |
---|---|
address |
Obligatoire. Adresse en cours de validation. Les adresses non formatées doivent être envoyées via La longueur totale des champs de cette entrée ne doit pas dépasser 280 caractères. Les régions compatibles sont indiquées dans les questions fréquentes. La valeur L'API Address Validation ignore les valeurs |
previous_response_id |
Ce champ doit être vide pour la première requête de validation d'adresse. Si d'autres requêtes sont nécessaires pour valider complètement une adresse (par exemple, si les modifications apportées par l'utilisateur après la validation initiale doivent être revalidées), chaque requête de suivi doit renseigner le champ |
enable_usps_cass |
Active le mode de compatibilité USPS CASS. Cela concerne uniquement le champ Nous vous recommandons d'utiliser un élément |
ValiderAdresseRéponse
Réponse à une requête de validation d'adresse.
Champs | |
---|---|
result |
Résultat de la validation de l'adresse. |
response_id |
UUID qui identifie cette réponse. Si l'adresse doit être à nouveau validée, cet UUID doit accompagner la nouvelle requête. |
ValidationResult
Résultat de la validation d'une adresse.
Champs | |
---|---|
verdict |
Indicateurs généraux de verdict |
address |
Informations sur l'adresse proprement dite, par opposition au géocode. |
geocode |
Informations sur le lieu et le lieu auxquels l'adresse a été géocodée. |
metadata |
Autres informations relatives à la délivrabilité Il n'est pas garanti que |
usps_data |
Indicateurs de livraison supplémentaires fournis par USPS. Uniquement disponible dans les régions |
Verdict
Vue d'ensemble du résultat de la validation de l'adresse et du géocode
Champs | |
---|---|
input_granularity |
Précision de l'adresse input. Il s'agit du résultat de l'analyse de l'adresse d'entrée et ne donne aucun signal de validation. Pour les signaux de validation, reportez-vous à Par exemple, si l'adresse de saisie inclut un numéro d'appartement spécifique, |
validation_granularity |
Niveau de précision avec lequel l'API peut valider entièrement l'adresse. Par exemple, un Le résultat de la validation du composant "Par adresse" est disponible dans |
geocode_granularity |
Informations sur le niveau de précision de Ce nom peut parfois différer du |
address_complete |
L'adresse est considérée comme terminée s'il n'y a aucun jeton non résolu, aucun composant d'adresse inattendu ou manquant. Pour en savoir plus, consultez les champs |
has_unconfirmed_components |
Impossible de classer ou de valider au moins un composant d'adresse. Pour en savoir plus, consultez |
has_inferred_components |
Au moins un composant d'adresse a été déduit (ajouté) et ne figure pas dans l'entrée. Pour en savoir plus, consultez |
has_replaced_components |
Au moins un composant d'adresse a été remplacé. Pour en savoir plus, consultez |
Précision
Les différentes caractéristiques d'une adresse ou d'un géocode. Lorsqu'elles sont utilisées pour indiquer le niveau de précision d'une adresse, ces valeurs indiquent le degré de précision auquel une adresse est envoyée via une adresse postale. Par exemple, une adresse telle que "123 Main Street, Redwood City, CA, 94061" identifie un PREMISE
, tandis que "Redwood City, CA 94061" identifie un LOCALITY
. Cependant, si nous ne parvenons pas à trouver de géocode pour "123 Main Street" à Redwood City, il se peut que le code géographique renvoyé soit précis LOCALITY
, bien que l'adresse soit plus précise.
Enums | |
---|---|
GRANULARITY_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
SUB_PREMISE |
Résultat en dessous du bâtiment, un appartement par exemple. |
PREMISE |
Résultat au niveau du bâtiment. |
PREMISE_PROXIMITY |
Un géocode qui doit se trouver à proximité de l'emplacement de l'adresse au niveau du bâtiment. Utilisé uniquement pour les géocodes, et non pour les adresses. |
BLOCK |
L'adresse ou le geocode indique un bloc. Utilisé uniquement dans les régions disposant d'un adressage au niveau du bloc, comme le Japon. |
ROUTE |
Le geocode ou l'adresse est précis avec un itinéraire, comme une rue, une route ou une autoroute. |
OTHER |
Toutes les autres granularités, qui sont regroupées, car elles ne sont pas livrables |