Method: validateAddress

{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}

integer

Révision du schéma de PostalAddress. Toute valeur autre que 0 entraînera l'erreur INVALID_ARGUMENT.

string

Facultatif. Code pays/région CLDR de l'adresse. Pour en savoir plus, consultez les pages https://cldr.unicode.org/ et https://www.unicode.org/cldr/charts/30/additional/territory_information.html. Exemple : "CH" pour la Suisse. Si le code de région n'est pas fourni, il sera déduit de l'adresse. Pour de meilleures performances, nous vous recommandons d'inclure le code de région si vous le connaissez. Des régions incohérentes ou répétées peuvent entraîner de mauvaises performances. Par exemple, si addressLines inclut déjà la région, ne fournissez pas de nouveau le code de la région dans ce champ. Les régions compatibles sont indiquées dans les questions fréquentes.

string

Le code de langue de l'adresse de saisie est réservé pour une utilisation ultérieure et est ignoré aujourd'hui. L'API renvoie l'adresse dans la langue appropriée.

string

Facultatif. Code postal de l'adresse. Tous les pays n'utilisent pas ou n'exigent pas de codes postaux, mais lorsqu'ils s'en servent, ils peuvent déclencher une validation supplémentaire avec d'autres parties de l'adresse (par exemple, validation par État/code postal aux États-Unis).

string

Facultatif. Code de tri supplémentaire, spécifique à chaque pays. La plupart des régions ne s'en servent pas. Lorsqu'il est utilisé, sa valeur comprend une chaîne de type CEDEX, éventuellement suivie d'un numéro (par exemple CEDEX 7), ou tout simplement un nombre représentant un "code de secteur" (Jamaïque), un "indicateur de zone de livraison" (Malawi) ou un "indicateur postal" (Côte d'Ivoire, par exemple).

string

Facultatif. Plus haute subdivision administrative utilisée pour les adresses postales d'un pays ou d'une région. Par exemple, il peut s'agir d'un État, d'une province, d'un oblast ou d'une préfecture. Plus précisément, pour l'Espagne, il s'agit de la province et non de la communauté autonome (par exemple, "Barcelone" et non "Catalogne"). De nombreux pays n'utilisent pas de région administrative dans leurs adresses postales. Par exemple, ce champ doit rester vide en Suisse.

string

Facultatif. Fait généralement référence à la ville de l'adresse. Exemples : une "city" aux États-Unis, une "comune" en Italie, une "post town" au Royaume-Uni. Dans les régions du monde où les localités ne sont pas bien définies ou ne s'intègrent pas bien dans cette structure, laissez le champ de localité vide et utilisez addressLines.

string

Facultatif. Sous-localité de l'adresse. Il peut s'agir, par exemple, de quartiers, d'arrondissements ou de districts.

string

Obligatoire. Lignes d'adresse non structurées décrivant les niveaux inférieurs d'une adresse.

Les valeurs dans "addressLines" n'ont pas d'informations de type et peuvent parfois contenir plusieurs valeurs dans un seul champ (par exemple, "Austin, TX"), il est important que l'ordre des lignes soit clair. L'ordre des lignes d'adresse doit correspondre à l'ordre suivi sur les enveloppes pour le pays/la région de l'adresse.

La représentation structurelle minimale autorisée d'une adresse consiste en toutes les informations placées dans addressLines. Si aucun regionCode n'est fourni, la région est déduite des lignes d'adresse.

Il est recommandé de créer une adresse contenant uniquement addressLines, puis d'utiliser le géocodage pour gérer les adresses complètement déstructurées (plutôt que de deviner quelles parties de l'adresse doivent être des localités ou des régions administratives).

string

Veuillez éviter de définir ce champ. L'API de validation d'adresse ne l'utilise pas. Bien que, pour le moment, l'API ne refuse pas les requêtes pour lesquelles ce champ est défini, les informations sont supprimées et ne sont pas renvoyées dans la réponse.

string

Veuillez éviter de définir ce champ. L'API de validation d'adresse ne l'utilise pas. Bien que, pour le moment, l'API ne refuse pas les requêtes pour lesquelles ce champ est défini, les informations sont supprimées et ne sont pas renvoyées dans la réponse.

{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  }
}

object (Verdict)

Indicateurs généraux de verdict

object (Address)

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

object (Geocode)

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

object (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.

object (UspsData)

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

{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}

enum (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 à validationGranularity ci-dessous.

Par exemple, si l'adresse de saisie inclut un numéro d'appartement spécifique, inputGranularity 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 validationGranularity sera probablement PREMISE ou inférieur.

enum (Granularity)

Niveau de précision avec lequel l'API peut valider entièrement l'adresse. Par exemple, un validationGranularity 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.

enum (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 validationGranularity 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, validationGranularity sera SUB_PREMISE, mais geocodeGranularity sera PREMISE.

boolean

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 missingComponentTypes, unresolvedTokens ou unexpected.

boolean

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

boolean

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.

boolean

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

{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}

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.

object (PostalAddress)

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

object (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.

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 formattedAddress, postalAddress ou addressComponents. 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.

string

Types des composants présents dans addressComponents, 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 addressComponents pour rechercher les types de tous les composants où confirmationLevel 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.

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.

{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}

object (ComponentName)

Nom de ce composant.

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.

enum (ConfirmationLevel)

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

boolean

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.

boolean

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.

boolean

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.

boolean

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.

{
  "text": string,
  "languageCode": string
}

string

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

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.

{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}

object (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.

object (PlusCode)

Plus code correspondant à location.

object (Viewport)

Limites du lieu géocodé.

number

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.

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.

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.

{
  "latitude": number,
  "longitude": number
}

number

Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0].

number

Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0].

{
  "globalCode": string,
  "compoundCode": string
}

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).

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.

{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}

object (LatLng)

Obligatoire. Point le plus bas de la fenêtre d'affichage.

object (LatLng)

Obligatoire. Point culminant de la fenêtre d'affichage.

{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}

boolean

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.

boolean

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

boolean

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.

{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}

object (UspsAddress)

Adresse standardisée USPS.

string

Code à deux chiffres du point de livraison

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. L'ajout de tous les chiffres du code delivery_point_barcode, deliveryPointCheckDigit, postal code et ZIP+4 doit générer un nombre divisible par 10.

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.

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

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.

string

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

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

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

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

string

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

boolean

L'adresse de livraison peut être mise en correspondance, mais le fichier EWS indique qu'une correspondance exacte sera bientôt disponible.

string

Ville du bureau de poste principal.

string

État principal du bureau de poste.

string

Ville abrégée.

string

Code de comté FIPS.

string

Nom du comté.

string

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

string

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

string

Code de retour LACSLink.

string

Indicateur LACSLink.

boolean

Code postal uniquement.

string

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é.

• A : la correspondance avec l'enregistrement SuiteLink et l'adresse de l'établissement ont été améliorées.
• 00: aucune correspondance, car l'adresse de l'établissement n'a pas été améliorée.

string

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

string

Numéro PMB (Private Mail Box)

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.

boolean

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

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.

boolean

Indique que la requête a été traitée par CASS.

{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}

string

Première ligne d'adresse.

string

Nom de la société.

string

Deuxième ligne d'adresse.

string

Nom de l'urbanisation portoricaine.

string

Ville + État + Code postal

string

Nom de la ville.

string

Code d'état à deux lettres.

string

Code postal, par exemple 10009.

string

Extension de code postal à 4 chiffres (5023, par exemple)