Index
AddressValidation
(interface)Address
(message)AddressComponent
(message)AddressComponent.ConfirmationLevel
(enum)AddressMetadata
(message)ComponentName
(message)Geocode
(message)LanguageOptions
(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)
AddressValidation
Service de validation des adresses.
ProvideValidationFeedback |
---|
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. Ce message ne doit être envoyé qu'une seule fois pour la séquence de requêtes |
ValidateAddress |
---|
Valide une adresse. |
Adresse
Détails de l'adresse post-traitée. Le post-traitement comprend la correction des parties mal orthographiées de l'adresse, le remplacement des éléments incorrects et la déduction des éléments manquants.
Champs | |
---|---|
formatted_address |
Adresse post-traitée, présentée sous la forme d'une adresse sur une seule ligne, conformément aux règles de mise en forme de la région dans laquelle se trouve l'adresse. |
postal_address |
Adresse post-traitée représentée sous forme d'adresse postale. |
address_components[] |
Liste à puces. Les composants d'adresse individuelle 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 ordonnés d'une manière particulière. Ne faites aucune hypothèse concernant l'ordre des composants d'adresse dans la liste. |
missing_component_types[] |
Les types de composants qui étaient censés être présents dans une adresse postale correctement formatée, mais qui sont introuvables dans l'entrée ET qui n'ont pas pu être déduits. Les composants de ce type ne sont pas présents dans |
unconfirmed_component_types[] |
Types de composants présents dans le fichier |
unresolved_tokens[] |
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 comme "123235253253 Main St, San Francisco, CA, 94105"), les jetons non résolus peuvent ressembler à |
AddressComponent
Représente un composant d'adresse, tel qu'une rue, une ville ou un État.
Champs | |
---|---|
component_name |
Nom de ce composant. |
component_type |
Type du composant d'adresse. Pour obtenir la liste des types possibles, consultez le Tableau 2: Autres types renvoyés par le service Places. |
confirmation_level |
Indique le niveau de certitude dont nous disposons quant à l'exactitude du composant. |
inferred |
Indique que l'élément ne faisait pas partie de l'entrée, mais que nous l'avons déduit pour l'emplacement de l'adresse et que nous pensons qu'il doit être fourni pour une adresse complète. |
spell_corrected |
Indique la 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, comme lorsque vous remplacez "centre" par "centre". Par ailleurs, il ne signale pas toujours les fautes d'orthographe courantes, comme lorsque vous remplacez "Amphitheater Pkwy" par "Amphitheatre Pkwy". |
replaced |
Indique que le nom de l'élément a été remplacé par un nom complètement différent (par exemple, un code postal incorrect ayant été remplacé par un nom correspondant à l'adresse). Il ne s'agit pas d'une modification esthétique. Le composant d'entrée a été remplacé par un autre. |
unexpected |
Indique un composant d'adresse qui ne devrait pas être présent dans une adresse postale pour la région donnée. Nous ne l'avons conservé que parce qu'il faisait partie de l'entrée. |
ConfirmationLevel
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 par rapport au reste de l'adresse. |
UNCONFIRMED_BUT_PLAUSIBLE |
Ce composant n'a pas pu être confirmé, mais il est possible qu'il existe. Par exemple, il peut s'agir d'un numéro compris dans une plage de numéros valide et connue, pour une rue où des numéros de maison spécifiques ne sont pas connus. |
UNCONFIRMED_AND_SUSPICIOUS |
Ce composant n'a pas été confirmé et est probablement incorrect. (un quartier qui ne correspond pas au reste de l'adresse, par exemple). |
AddressMetadata
Métadonnées de l'adresse. Il n'est pas garanti que le champ 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 cette valeur n'est pas définie, cela signifie que la valeur est inconnue. |
po_box |
Indique l'adresse d'une boîte postale. Si cette valeur n'est pas définie, cela signifie que la valeur est inconnue. |
residential |
Indique qu'il s'agit de l'adresse d'une résidence. Si cette valeur n'est pas définie, cela signifie que la valeur est inconnue. |
ComponentName
Wrapper pour le 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. Ce champ est absent 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 dans lequel 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 ID de lieu plutôt que des adresses, des coordonnées de latitude/longitude ou des plus codes. Si vous utilisez des coordonnées lors d'un calcul d'itinéraire, le point est systématiquement aligné sur la route la plus proche de ces coordonnées. Il est possible qu'il ne s'agisse pas d'une route qui mène à la destination de manière rapide ou sûre, ni à proximité d'un point d'accès à la propriété. En outre, lorsqu'un lieu est géocodé inverse, 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 précision du lieu géocodé, mais en taille physique et non sémantique. |
place_id |
ID de lieu du lieu vers lequel cette entrée géocode. Pour en savoir plus sur les ID de lieu, cliquez ici. |
place_types[] |
Type(s) de lieu pour lequel l'entrée a été géocodée. Par exemple, |
LanguageOptions
Aperçu: cette fonctionnalité est en phase de preview (pré-DG). La compatibilité des fonctionnalités et produits pré-DG peut être limitée, et il se peut que les modifications apportées à ces fonctionnalités ou produits ne soient pas compatibles avec d'autres versions pré-DG. Les offres en pré-DG sont couvertes par les Conditions spécifiques du service Google Maps Platform. Pour en savoir plus, consultez les descriptions des étapes de lancement.
Permet à l'API Address Validation d'inclure des informations supplémentaires dans la réponse.
Champs | |
---|---|
return_english_latin_address |
Aperçu: renvoyez un |
PlusCode
Le Plus Code (http://plus.codes) est une référence de lieu sous deux formats: un code global qui définit un rectangle de 14 x 14 m (1/8 000e de degré) ou un rectangle plus petit, et un code composé, qui remplace le préfixe par un emplacement de référence.
Champs | |
---|---|
global_code |
Code global (complet) du lieu, tel que "9FWM33GV+HQ", représentant une zone de 1/8000 x 1/8000 degrés (environ 14 x 14 mètres). |
compound_code |
Code composé du lieu, tel que "33GV+HQ, Ramberg, Norvège ", contenant le suffixe du code global et le remplaçant par le nom formaté d'une entité de référence. |
ProvideValidationFeedbackRequest
Demande d'envoi des 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 concernée par ces commentaires. Il doit s'agir de la valeur [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] figurant dans la première réponse d'une série de tentatives de validation d'adresse. |
ValidationConclusion
Résultats finaux possibles de la séquence de demandes de validation d'adresse requises 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 qui a été saisie après la dernière tentative de validation, mais qui n'a pas été revalidé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
Ce type ne comporte aucun champ.
Réponse aux commentaires de validation.
La réponse est vide si les commentaires ont bien été envoyés.
UspsAddress
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 à quatre chiffres, par exemple 5023. |
UspsData
Données USPS pour l'adresse. Il n'est pas garanti que le champ uspsData
soit entièrement renseigné pour toutes les adresses aux États-Unis ou aux relations publiques envoyées à l'API Address Validation. Il est recommandé 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 du point de livraison à deux chiffres |
delivery_point_check_digit |
Chiffre de contrôle du point de livraison. Ce numéro est ajouté à la fin de "delivery_point_barcode" pour les messages scannés automatiquement. En additionnant tous les chiffres des valeurs "delivery_point_barcode", "delivery_point_check_digit", du code postal et du code ZIP+4, doit donner un nombre divisible par 10. |
dpv_confirmation |
Valeurs possibles pour la confirmation de la DPV. Renvoie un seul caractère ou ne renvoie aucune valeur.
|
dpv_footnote |
Notes de bas de page issues de la validation du point de livraison. Plusieurs notes de bas de page peuvent être regroupées dans la même chaîne.
|
dpv_cmra |
Indique si l'adresse est une agence de réception de courrier commercial (CMRA), c'est-à-dire une entreprise privée recevant du courrier pour ses clients. Renvoie un seul caractère.
|
dpv_vacant |
Ce lieu est-il vacant ? Renvoie un seul caractère.
|
dpv_no_stat |
S'agit-il d'une adresse inactive ou active ? Aucune adresse statistique n'est occupée en continu ou n'est pas une adresse non desservie par l'USPS. Renvoie un seul caractère.
|
dpv_no_stat_reason_code |
Indique le type NoStat. Renvoie un code de motif sous la forme d'un entier.
|
dpv_drop |
L'indicateur indique que le courrier est distribué à un seul destinataire sur un site. Renvoie un seul caractère.
|
dpv_throwback |
Indique que le courrier n'est pas distribué à l'adresse postale. Renvoie un seul caractère.
|
dpv_non_delivery_days |
L'indicateur indique que la distribution des e-mails n'est pas effectuée tous les jours de la semaine. Renvoie un seul caractère.
|
dpv_non_delivery_days_values |
Nombre entier identifiant les jours de non-diffusion. Elle peut être interrogée à l'aide d'indicateurs de bits: 0x40 – le dimanche est un jour de non-distribution 0x20 ; le lundi est un jour de non-livraison 0x10 ; le mardi est un jour de non-livraison 0x08 – le mercredi est un jour de non-distribution 0x04 ; le jeudi est un jour de non-livraison 0x02 – le vendredi est un jour de non-livraison 0x02 – le vendredi est un jour de non-livraison 0x02 |
dpv_no_secure_location |
Le drapeau indique que la porte est accessible, mais que le colis ne sera pas déposé pour des raisons de sécurité. Renvoie un seul caractère.
|
dpv_pbsa |
Indique que l'adresse a été mise en correspondance avec l'enregistrement PBSA. Renvoie un seul caractère.
|
dpv_door_not_accessible |
Un drapeau indique une adresse pour laquelle USPS ne peut pas frapper à la porte pour livrer du courrier. Renvoie un seul caractère.
|
dpv_enhanced_delivery_code |
Indique que plusieurs codes DPV sont valides pour l'adresse. Renvoie un seul caractère.
|
carrier_route |
Code d'acheminement du transporteur. Un code à quatre caractères composé d'un préfixe d'une lettre et d'un indicateur d'itinéraire à trois chiffres. Préfixes:
|
carrier_route_indicator |
Indicateur de tri du tarif de l'itinéraire du transporteur. |
ews_no_match |
Il est possible d'établir une correspondance pour l'adresse de livraison, mais le fichier EWS indique qu'une correspondance exacte sera bientôt disponible. |
post_office_city |
Bureau de poste principal. |
post_office_state |
État du bureau de poste principal. |
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 |
Boîte postale uniquement. |
suitelink_footnote |
Notes de bas de page permettant d'associer un enregistrement de rue ou de gratte-ciel à des informations sur l'appartement Si une correspondance est trouvée dans le nom de l'entreprise, le numéro secondaire est renvoyé.
|
pmb_designator |
Désignateur d'unité PMB (Private Mail Box). |
pmb_number |
Numéro de boîte postale privée |
address_record_type |
Type de l'enregistrement d'adresse correspondant à l'adresse saisie.
|
default_address |
Indicateur spécifiant 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 créées artificiellement. Il est possible que les champs de données USPS ne soient pas renseignés lorsque cette erreur se produit. |
cass_processed |
Indicateur spécifiant que la requête a été traitée CASS. |
ValidateAddressRequest
Requête de validation d'une adresse.
Champs | |
---|---|
address |
Obligatoire. Adresse en cours de validation. Les adresses sans mise en forme doivent être envoyées via La longueur totale des champs de cette entrée ne doit pas dépasser 280 caractères. Pour connaître les régions acceptées, cliquez ici. La valeur L'API Address Validation ignore les valeurs de |
previous_response_id |
Ce champ doit être vide pour la première requête de validation d'adresse. Si davantage de requêtes sont nécessaires pour valider entièrement une seule adresse (par exemple, si les modifications apportées par l'utilisateur après la validation initiale doivent être de nouveau validées), chaque demande de suivi doit renseigner ce champ avec l'attribut |
enable_usps_cass |
Active le mode compatible avec USPS CASS. Cela concerne uniquement le champ Nous vous recommandons d'utiliser une propriété |
language_options |
Facultatif. Aperçu: cette fonctionnalité est en phase de preview (pré-DG). La compatibilité des fonctionnalités et produits pré-DG peut être limitée, et il se peut que les modifications apportées à ces fonctionnalités ou produits ne soient pas compatibles avec d'autres versions pré-DG. Les offres en pré-DG sont couvertes par les Conditions spécifiques du service Google Maps Platform. Pour en savoir plus, consultez les descriptions des étapes de lancement. Permet à l'API Address Validation d'inclure des informations supplémentaires dans la réponse. |
ValidateAddressResponse
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 de nouveau validée, cet UUID doit accompagner la nouvelle demande. |
ValidationResult
Résultat de la validation d'une adresse.
Champs | |
---|---|
verdict |
Options de verdict global |
address |
Informations sur l'adresse elle-même, par opposition au géocode. |
geocode |
Informations sur le lieu et le lieu correspondant à l'adresse géocodée. |
metadata |
Autres informations pertinentes pour la livrable. Il n'est pas garanti que le champ |
usps_data |
Indicateurs de livraison supplémentaires fournis par USPS. Uniquement disponible dans les régions |
english_latin_address |
Aperçu: cette fonctionnalité est en phase de preview (pré-DG). La compatibilité des fonctionnalités et produits pré-DG peut être limitée, et il se peut que les modifications apportées à ces fonctionnalités ou produits ne soient pas compatibles avec d'autres versions pré-DG. Les offres en pré-DG sont couvertes par les Conditions spécifiques du service Google Maps Platform. Pour en savoir plus, consultez les descriptions des étapes de lancement. Adresse traduite en anglais. Si une partie de l'adresse n'est pas traduite en anglais, le service l'affiche dans une autre langue utilisant des caractères latins. Pour savoir comment l'autre langue est sélectionnée, cliquez ici. Si une partie de l'adresse ne comporte pas de traduction ni de translittération dans une langue utilisant l'alphabet latin, le service l'affiche dans la langue locale associée à l'adresse. Vous avez activé ce résultat à l'aide de l'option Remarque: Le champ |
Verdict
Vue d'ensemble du résultat de validation de l'adresse et du géocode.
Champs | |
---|---|
input_granularity |
Précision de l'adresse d'entrée. Il s'agit du résultat de l'analyse de l'adresse d'entrée et ne fournit aucun signal de validation. Pour en savoir plus sur les signaux de validation, consultez Par exemple, si l'adresse saisie inclut un numéro d'appartement spécifique, |
validation_granularity |
Niveau de précision auquel l'API peut entièrement validate l'adresse. Par exemple, un Le résultat de la validation de chaque composant d'adresse est disponible dans |
geocode_granularity |
Informations sur la précision de Il peut parfois être différent du |
address_complete |
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. Pour en savoir plus, consultez les champs |
has_unconfirmed_components |
Au moins un composant d'adresse ne peut être ni catégorisé, ni validé. Consultez |
has_inferred_components |
Au moins un composant d'adresse a été déduit (ajouté) qui ne figurait 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
Il s'agit des différents niveaux de précision 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 de l'adresse pour identifier une destination d'envoi. 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
. Toutefois, si nous ne parvenons pas à trouver le géocode du "123 Main Street" à Redwood City, il est possible que le géocode renvoyé soit avec une précision de LOCALITY
, même si l'adresse est plus précise.
Enums | |
---|---|
GRANULARITY_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
SUB_PREMISE |
Résultat situé en dessous du bâtiment, par exemple un appartement. |
PREMISE |
Résultat au niveau du bâtiment. |
PREMISE_PROXIMITY |
Géocode qui correspond approximativement à l'emplacement de l'adresse au niveau du bâtiment. |
BLOCK |
L'adresse ou le géocode indiquent un pâté de maisons. Utilisé uniquement dans les régions disposant d'adresses au niveau du bloc, telles que le Japon. |
ROUTE |
Le géocode ou l'adresse sont granulaires pour l'itinéraire, comme une rue, une route ou une autoroute. |
OTHER |
Toutes les autres niveaux de précision, qui sont regroupés puisqu'ils ne peuvent pas être livrés. |