Package google.maps.addressvalidation.v1

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Index

Validation de l'adresse

Service de validation des adresses.

FournirValidationFeedback

rpc ProvideValidationFeedback(ProvideValidationFeedbackRequest) returns (ProvideValidationFeedbackResponse)

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 ValidateAddress requêtes nécessaires à la validation complète d'une adresse.

Valider l'adresse

rpc ValidateAddress(ValidateAddressRequest) returns (ValidateAddressResponse)

Valide une adresse.

Adresse

Détails de l'adresse analysée à partir de l'entrée.

Champs
formatted_address

string

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

PostalAddress

Adresse validée représentée sous la forme d'une adresse postale.

address_components[]

AddressComponent

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[]

string

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 formatted_address, postal_address ou address_components. Voici un exemple : ['street_number', 'route'] pour une entrée telle que "Boulder, Colorado, 80301, USA". Pour consulter la liste des types possibles, cliquez ici.

unconfirmed_component_types[]

string

Types des composants présents dans address_components, mais dont la validité n'a pas pu être confirmée. Ce champ est fourni dans un souci de commodité: son contenu équivaut à itérer via address_components pour rechercher les types de tous les composants où confirmation_level n'est pas CONFIRMED ou si l'option inferred n'est pas définie sur true. Pour consulter la liste des types possibles, cliquez ici.

unresolved_tokens[]

string

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 à ["123235253253"], car ce n'est pas un numéro de rue valide.

Composant AddressAddress

Représente un composant d'adresse, comme une rue, une ville ou une région.

Champs
component_name

ComponentName

Nom de ce composant.

component_type

string

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

ConfirmationLevel

Indique le niveau de certitude selon lequel le composant est correct.

inferred

bool

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

bool

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

bool

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

bool

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

bool

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

bool

Indique l'adresse d'une boîte postale. Si ce champ n'est pas spécifié, indique que la valeur est inconnue.

residential

bool

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

string

Texte du nom. Par exemple, "5e avenue" pour un nom de rue ou "1253" pour un numéro de rue.

language_code

string

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

LatLng

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

PlusCode

Plus code correspondant à location.

bounds

Viewport

Limites du lieu géocodé.

feature_size_meters

float

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

string

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[]

string

Type(s) de lieu vers lequel l'entrée a été géocodée. Par exemple, ['locality', 'political']. La liste complète des types est disponible sur cette page.

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

string

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

string

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

ValidationConclusion

Obligatoire. Résultat de la séquence de tentatives de validation.

Si ce champ est défini sur VALIDATION_CONCLUSION_UNSPECIFIED, une erreur INVALID_ARGUMENT est renvoyée.

response_id

string

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

string

Première ligne d'adresse.

firm

string

Nom de la société.

second_address_line

string

Deuxième ligne d'adresse.

urbanization

string

Nom de l'urbanisation portoricaine.

city_state_zip_address_line

string

Ville + État + Code postal

city

string

Nom de la ville.

state

string

Code d'état à deux lettres.

zip_code

string

Code postal, par exemple 10009.

zip_code_extension

string

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

UspsAddress

Adresse standardisée USPS.

delivery_point_code

string

Code à deux chiffres du point de livraison

delivery_point_check_digit

string

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

string

Valeurs possibles pour la confirmation DPV. Renvoie un seul caractère.

  • Y : l'adresse a été confirmée pour le DPV pour les numéros principaux et secondaires.
  • N : échec de la saisie du numéro principal et des informations relatives aux numéros secondaires qui ont été envoyées au DPV.
  • S : l'adresse a été confirmée via le DPV uniquement pour le numéro principal, mais pas le numéro secondaire.
  • D: l'adresse a été confirmée via le DPV uniquement pour le numéro principal, mais pas le numéro secondaire.
dpv_footnote

string

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.

  • AA : adresse saisie correspondant au fichier ZIP +4
  • A1: l'adresse d'entrée ne correspond pas au fichier ZIP +4.
  • BB: mis en correspondance avec le DPV (tous les composants)
  • CC: le numéro secondaire n'est pas mis en correspondance (présent, mais non valide)
  • N1 : gratte-ciel sans numéro secondaire
  • M1: numéro principal manquant
  • M3 : numéro principal non valide
  • P1 : adresse RR ou numéro de zone du centre d'aide manquante
  • P3 : le bon de commande, le numéro RR ou l'adresse du centre d'aide est incorrect.
  • F1 : adresse saisie correspondant à une adresse militaire
  • G1 : adresse saisie correspondant à une adresse de livraison générale
  • U1 : adresse saisie correspondant à un code postal unique
  • PB: adresse saisie correspondant à l'enregistrement PBSA
  • RR: adresse DPV confirmée avec les informations du PMB
  • R1: adresse DPV confirmée sans informations sur le PMB
  • R7 : enregistrement des itinéraires R777 ou R779 de l'opérateur
dpv_cmra

string

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.

  • Y: l'adresse est un CMRA.
  • N: l'adresse n'est pas une instance CMRA.
dpv_vacant

string

Ce lieu est-il inoccupé ? Renvoie un seul caractère.

  • Y : l'adresse est vacante.
  • N : l'adresse n'est pas vide
dpv_no_stat

string

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.

  • Y : l'adresse n'est pas active.
  • N: l'adresse est active
carrier_route

string

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:

  • C : route de transporteur (ou ligne de ville)
  • R : route de campagne
  • H : itinéraire automobile
  • B : section "Boîte postale"
  • G: unité de livraison générale
carrier_route_indicator

string

Indicateur de tri du tarif de l'itinéraire de l'opérateur.

ews_no_match

bool

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

string

Ville du bureau de poste principal.

post_office_state

string

État principal du bureau de poste.

abbreviated_city

string

Ville abrégée.

fips_county_code

string

Code de comté FIPS.

county

string

Nom du comté.

elot_number

string

Numéro de ligne de transport amélioré (eLOT).

elot_flag

string

Indicateur ELOT croissant/décroissant (A/D)

po_box_only_postal_code

bool

Code postal uniquement.

pmb_designator

string

Décodeur d'unités PMB (Private Mail Box).

pmb_number

string

Numéro PMB (Private Mail Box)

address_record_type

string

Type d'enregistrement d'adresse correspondant à l'adresse d'entrée.

  • F : FIRM. Il s'agit d'une correspondance avec un dossier d'enregistrement, le niveau de correspondance le plus précis disponible pour une adresse.
  • G: DIFFUSION GÉNÉRALE. Il s'agit d'une correspondance avec un enregistrement de livraison générale.
  • H: ÉTABLISSEMENT / PARTENAIRE Il s'agit d'une correspondance avec un enregistrement de bâtiment ou d'appartement.
  • P: POST OFFICE BOX. Cela correspond à une boîte postale.
  • R: ROUTAL ROUTAL ou HIGHWAY CONTRACT: il s'agit d'une correspondance avec un itinéraire rural ou un contrat d'autoroute. Ces deux champs peuvent être associés à une plage de numéros.
  • S : STREET RECORD: ceci correspond à un enregistrement Street View contenant une plage de numéros principaux valide.
default_address

bool

Indique qu'une adresse par défaut a été trouvée, mais qu'il existe des adresses plus spécifiques.

error_message

string

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

bool

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

PostalAddress

Obligatoire. Adresse en cours de validation. Les adresses non formatées doivent être envoyées via address_lines.

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 language_code dans l'adresse d'entrée est réservée pour des utilisations futures et est ignorée aujourd'hui. Le résultat de l'adresse validée sera renseigné en fonction de la langue préférée de l'adresse donnée, telle qu'identifiée par le système.

L'API Address Validation ignore les valeurs recipients et organization. Toutes les valeurs de ces champs seront supprimées et non renvoyées. Veuillez ne pas les définir.

previous_response_id

string

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 response_id dans la première réponse de la séquence de validation.

enable_usps_cass

bool

Active le mode de compatibilité USPS CASS. Cela concerne uniquement le champ google.maps.addressvalidation.v1.ValidationResult.usps_data de google.maps.addressvalidation.v1.ValidationResult. Remarque: Pour les demandes d'adresses autorisées à l'USPS CASS pour Porto Rico, un google.type.PostalAddress.region_code de address doit être défini en tant que "PR", ou un google.type.PostalAddress.administrative_area de address en tant que "Porto Rico" (non sensible à la casse) ou "PR".

Nous vous recommandons d'utiliser un élément address individuel, ou au moins deux éléments google.type.PostalAddress.address_lines, où la première ligne contient le numéro et le nom de la rue, et la seconde la ville, l'État et le code postal.

ValiderAdresseRéponse

Réponse à une requête de validation d'adresse.

Champs
result

ValidationResult

Résultat de la validation de l'adresse.

response_id

string

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

Verdict

Indicateurs généraux de verdict

address

Address

Informations sur l'adresse proprement dite, par opposition au géocode.

geocode

Geocode

Informations sur le lieu et le lieu auxquels l'adresse a été géocodée.

metadata

AddressMetadata

Autres informations relatives à la délivrabilité Il n'est pas garanti que metadata soit entièrement renseigné pour chaque adresse envoyée à l'API Address Validation.

usps_data

UspsData

Indicateurs de livraison supplémentaires fournis par USPS. Uniquement disponible dans les régions US et PR.

Verdict

Vue d'ensemble du résultat de la validation de l'adresse et du géocode

Champs
input_granularity

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 à validation_granularity ci-dessous.

Par exemple, si l'adresse de saisie inclut un numéro d'appartement spécifique, input_granularity sera alors SUB_PREMISE. Si nous ne pouvons pas faire correspondre le numéro d'appartement dans les bases de données ou s'il n'est pas valide, le validation_granularity sera probablement PREMISE ou inférieur.

validation_granularity

Granularity

Niveau de précision avec lequel l'API peut valider entièrement l'adresse. Par exemple, un validation_granularity de PREMISE indique que tous les composants d'adresse de niveau PREMISE ou plus approximatif peuvent être validés.

Le résultat de la validation du composant "Par adresse" est disponible dans google.maps.addressvalidation.v1.Address.address_components.

geocode_granularity

Granularity

Informations sur le niveau de précision de geocode. Cela peut être compris comme la signification sémantique de la précision ou de la précision de la localisation géocodée.

Ce nom peut parfois différer du validation_granularity ci-dessus. Par exemple, notre base de données peut enregistrer l'existence d'un numéro d'appartement, mais n'a pas d'emplacement précis dans un grand complexe. Dans ce cas, validation_granularity sera SUB_PREMISE, mais geocode_granularity sera PREMISE.

address_complete

bool

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 missing_component_types, unresolved_tokens ou unexpected.

has_unconfirmed_components

bool

Impossible de classer ou de valider au moins un composant d'adresse. Pour en savoir plus, consultez google.maps.addressvalidation.v1.Address.address_components.

has_inferred_components

bool

Au moins un composant d'adresse a été déduit (ajouté) et ne figure pas dans l'entrée. Pour en savoir plus, consultez google.maps.addressvalidation.v1.Address.address_components.

has_replaced_components

bool

Au moins un composant d'adresse a été remplacé. Pour en savoir plus, consultez google.maps.addressvalidation.v1.Address.address_components.

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