Method: validateAddress

Valide une adresse.

Requête HTTP

POST https://addressvalidation.googleapis.com/v1:validateAddress

L'URL utilise la syntaxe de transcodage gRPC.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
Champs
address

object (PostalAddress)

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

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 languageCode dans l'adresse d'entrée est réservée à une utilisation future et est ignorée pour le moment. Le résultat de l'adresse validée sera renseigné en fonction de la langue préférée pour l'adresse donnée, telle qu'identifiée par le système.

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

string

Ce champ doit être vide pour la première demande 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 validées à nouveau), chaque requête de suivi doit renseigner ce champ avec l'responseId de la toute première réponse de la séquence de validation.
enableUspsCass

boolean

Active le mode compatible avec le système CASS de l'USPS. Cela ne concerne que le champ google.maps.addressvalidation.v1.ValidationResult.usps_data de google.maps.addressvalidation.v1.ValidationResult. Remarque: Pour les demandes d'adresses à Porto Rico compatibles avec le service CASS de l'USPS, vous devez indiquer "PR" comme google.type.PostalAddress.region_code de address ou "Puerto Rico" (sans distinction entre majuscules et minuscules) ou "PR" comme google.type.PostalAddress.administrative_area de address.

Nous vous recommandons d'utiliser un address modulaire ou de spécifier au moins deux google.type.PostalAddress.address_lines, la première ligne contenant le numéro et le nom de la rue, et la deuxième ligne contenant la ville, l'État et le code postal.
languageOptions

object (LanguageOptions)

Facultatif. Preview: cette fonctionnalité est en version 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 de validation d'adresses d'inclure des informations supplémentaires dans la réponse.
sessionToken

string

Facultatif. Chaîne qui identifie une session Autocomplete à des fins de facturation. Il doit s'agir d'une chaîne base64 sécurisée pour les URL et les noms de fichiers, qui ne doit pas comporter plus de 36 caractères ASCII. Sinon, une erreur INVALID_ARGUMENT est renvoyée.

La session commence lorsque l'utilisateur effectue une requête Autocomplete et se termine lorsqu'il sélectionne un lieu et qu'un appel à Place Details ou à Address Validation est effectué. Chaque session peut comporter plusieurs requêtes Autocomplete, suivies d'une requête Places Details ou de validation d'adresse. Les identifiants utilisés pour chaque requête d'une session doivent appartenir au même projet Google Cloud Console. Une fois la session terminée, le jeton n'est plus valide. Votre application doit générer un nouveau jeton pour chaque session. Si vous omettez le paramètre sessionToken ou si vous réutilisez un jeton de session, la session est facturée comme si aucun jeton n'était fourni (chaque requête est facturée séparément).

Remarque: La validation des adresses ne peut être utilisée que dans les sessions avec l'API Autocomplete (New), et non avec l'API Autocomplete. Pour en savoir plus, consultez la page https://developers.google.com/maps/documentation/places/web-service/session-pricing.

Corps de la réponse

Réponse à une demande de validation d'adresse.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Champs
result

object (ValidationResult)

Résultat de la validation de l'adresse.
responseId

string

UUID identifiant cette réponse. Si l'adresse doit être validée de nouveau, cet UUID doit accompagner la nouvelle demande.

PostalAddress

Représente une adresse postale (par exemple, pour les adresses de livraison ou de paiement). Les services postaux peuvent effectuer une livraison à cette adresse, boîte postale ou autre. Ce champ n'a pas vocation à modéliser des emplacements géographiques (routes, villes ou montagnes).

Généralement, une adresse est créée via une entrée utilisateur ou lors de l'importation de données existantes, en fonction du type de processus.

Conseils pour la saisie et la modification d'adresses : utilisez un widget d'adresse compatible internationalisation tel que https://github.com/google/libaddressinput. Les utilisateurs ne doivent pas voir les éléments d'interface utilisateur permettant de saisir ou de modifier les champs en dehors des pays dans lesquels ce champ est utilisé.

Pour en savoir plus sur l'utilisation de ce schéma, consultez https://support.google.com/business/answer/6397478.

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

integer

Révision du schéma de PostalAddress. Toute valeur autre que 0 entraîne l'affichage d'une erreur INVALID_ARGUMENT par l'API.
regionCode

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/supplemental/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 optimiser les performances, nous vous recommandons d'inclure le code de région si vous le connaissez. La présence de régions incohérentes ou répétées peut entraîner de mauvaises performances. Par exemple, si addressLines inclut déjà la région, ne fournissez pas à nouveau le code de région dans ce champ. Vous trouverez la liste des régions acceptées dans les questions fréquentes.
languageCode

string

Le code de langue de l'adresse de saisie est réservé à une utilisation ultérieure et est ignoré pour le moment. L'API renvoie l'adresse dans la langue appropriée pour l'emplacement de l'adresse.
postalCode

string

Facultatif. Code postal de l'adresse. Tous les pays n'utilisent pas ou n'exigent pas de codes postaux. Toutefois, s'ils sont en vigueur, cela peut entraîner une validation supplémentaire avec d'autres parties de l'adresse (par exemple, validation par État ou par code postal aux États-Unis).
sortingCode

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é, la valeur est une chaîne telle que "CEDEX", éventuellement suivie d'un nombre (par exemple, "CEDEX 7"), ou un nombre seul, représentant le "code de secteur" (Jamaïque), l'"indicateur de zone de livraison" (Malawi) ou l'"indicateur de bureau de poste" (Côte d'Ivoire).
administrativeArea

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. 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, en Suisse, ce champ doit rester vide.
locality

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 locality vide et utilisez addressLines.
sublocality

string

Facultatif. Sous-localité de l'adresse. Il peut s'agir, par exemple, d'un quartier, d'un arrondissement ou d'un district.
addressLines[]

string

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

Étant donné que les valeurs dans "addressLines" ne contiennent pas d'informations de type et peuvent parfois comprendre plusieurs valeurs dans un seul champ (par exemple, "Austin, TX"), il est important que l'ordre des lignes soit bien 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 pour 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.

La création d'une adresse contenant uniquement addressLines, puis le géocodage est la méthode recommandée pour gérer les adresses complètement déstructurées (plutôt que de deviner quelles parties de l'adresse sont des localités ou des régions administratives).
recipients[]

string

Veuillez éviter de définir ce champ. L'API Address Validation ne l'utilise pas actuellement. Bien que l'API n'accepte pas actuellement les requêtes avec ce champ défini, les informations seront supprimées et ne seront pas renvoyées dans la réponse.
organization

string

Veuillez éviter de définir ce champ. L'API Address Validation ne l'utilise pas actuellement. Bien que l'API n'ignore pas actuellement les requêtes pour lesquelles ce champ est défini, les informations seront supprimées et ne seront pas renvoyées dans la réponse.

LanguageOptions

Preview: cette fonctionnalité est en version 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 de validation d'adresses d'inclure des informations supplémentaires dans la réponse.

Représentation JSON 
{
  "returnEnglishLatinAddress": boolean
}
Champs
returnEnglishLatinAddress

boolean

Aperçu: renvoie un google.maps.addressvalidation.v1.Address en anglais. Pour en savoir plus, consultez google.maps.addressvalidation.v1.ValidationResult.english_latin_address.

ValidationResult

Résultat de la validation d'une adresse.

Représentation JSON 
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
Champs
verdict

object (Verdict)

Options d'évaluation globale
address

object (Address)

Informations sur l'adresse elle-même, par opposition au code géographique.
geocode

object (Geocode)

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

object (AddressMetadata)

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

object (UspsData)

Indicateurs de distribution supplémentaires fournis par USPS. Fourni uniquement dans les régions US et PR.
englishLatinAddress

object (Address)

Preview: cette fonctionnalité est en version 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.

Les adresses traduites ne peuvent pas être réutilisées comme entrée de l'API. Le service les fournit afin que l'utilisateur puisse confirmer ou refuser la validation de l'adresse fournie à l'origine dans sa langue maternelle.

Si une partie de l'adresse n'a pas de traduction en anglais, le service renvoie cette partie dans une autre langue utilisant un script latin. Cliquez ici pour découvrir comment la langue alternative est sélectionnée. Si une partie de l'adresse n'a pas de traduction ni de translittération dans une langue utilisant un alphabet latin, le service renvoie cette partie dans la langue locale associée à l'adresse.

Activez cette sortie à l'aide de l'option google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Remarque: Les champs google.maps.addressvalidation.v1.Address.unconfirmed_component_types dans englishLatinAddress et google.maps.addressvalidation.v1.AddressComponent.confirmation_level dans englishLatinAddress.address_components ne sont pas renseignés.

Verdict

Présentation générale du résultat de la validation de l'adresse et du géocode

Représentation JSON 
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Champs
inputGranularity

enum (Granularity)

Précision de l'adresse saisie. Il s'agit du résultat de l'analyse de l'adresse d'entrée et ne fournit aucun signal de validation. Pour les signaux de validation, consultez validationGranularity ci-dessous.

Par exemple, si l'adresse saisie inclut un numéro d'appartement spécifique, inputGranularity sera SUB_PREMISE. Si nous ne parvenons pas à faire correspondre le numéro d'appartement dans les bases de données ou s'il est incorrect, validationGranularity sera probablement PREMISE ou pire.
validationGranularity

enum (Granularity)

Niveau de précision auquel l'API peut valider complètement l'adresse. Par exemple, une valeur validationGranularity de PREMISE indique que tous les composants d'adresse au niveau de PREMISE ou plus grossier peuvent être validés.

Les résultats de validation par composant d'adresse sont disponibles dans google.maps.addressvalidation.v1.Address.address_components.
geocodeGranularity

enum (Granularity)

Informations sur la précision de l'geocode. Il s'agit de la signification sémantique de la précision de l'emplacement géocodé.

Il peut parfois différer de validationGranularity ci-dessus. Par exemple, notre base de données peut enregistrer l'existence d'un numéro d'appartement, mais ne pas connaître l'emplacement exact de l'appartement dans un grand immeuble. Dans ce cas, validationGranularity sera SUB_PREMISE, mais geocodeGranularity sera PREMISE.
addressComplete

boolean

L'adresse est considérée comme complète si aucun jeton n'est non résolu, et si aucun élément d'adresse inattendu ou manquant n'est présent. Si elle n'est pas définie, indique que la valeur est false. Pour en savoir plus, consultez les champs missingComponentTypes, unresolvedTokens ou unexpected.
hasUnconfirmedComponents

boolean

Au moins un composant d'adresse ne peut pas être catégorisé ni validé. Pour en savoir plus, consultez google.maps.addressvalidation.v1.Address.address_components.
hasInferredComponents

boolean

Au moins un composant d'adresse qui n'était pas dans l'entrée a été inféré (ajouté). Pour en savoir plus, consultez google.maps.addressvalidation.v1.Address.address_components.
hasReplacedComponents

boolean

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 précisions qu'une adresse ou un géocode peuvent avoir. Lorsqu'elles sont utilisées pour indiquer la précision d'une adresse, ces valeurs indiquent avec quelle précision l'adresse identifie une destination de diffusion. 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 trouvons pas de géocode pour "123 Main Street" à Redwood City, le géocode renvoyé peut être de granularité 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 au niveau inférieur à un bâtiment, comme un appartement.
PREMISE Résultat au niveau du bâtiment.
PREMISE_PROXIMITY Géocode approximatif de l'adresse au niveau du bâtiment.
BLOCK L'adresse ou le géocode indique un bloc. Utilisé uniquement dans les régions qui utilisent l'adressage au niveau du bloc, comme le Japon.
ROUTE Le code géographique ou l'adresse est précis au niveau de l'itinéraire, comme une rue, une route ou une autoroute.
OTHER Toutes les autres granularités, qui sont regroupées, car elles ne peuvent pas être diffusées.

Adresse

Détails de l'adresse post-traitée. Le post-traitement consiste à corriger les parties mal orthographiées de l'adresse, à remplacer les parties incorrectes et à inférer les parties manquantes.

Représentation JSON 
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Champs
formattedAddress

string

Adresse post-traitée, mise en forme sur une seule ligne conformément aux règles de mise en forme de la région où elle se trouve.

Remarque: Le format de cette adresse peut ne pas correspondre à celui de l'adresse du champ postalAddress. Par exemple, le postalAddress représente toujours le pays sous la forme d'un regionCode à deux lettres, comme "US" ou "NZ". En revanche, ce champ utilise une forme plus longue du nom du pays, par exemple "États-Unis" ou "Nouvelle-Zélande".
postalAddress

object (PostalAddress)

Adresse post-traitée représentée sous forme d'adresse postale.
addressComponents[]

object (AddressComponent)

Liste non ordonnée. Les composants individuels de l'adresse formatée et corrigée, ainsi que des informations de validation. Cela fournit des informations sur l'état de validation de chaque composant.

Les composants de l'adresse ne sont pas organisés de manière particulière. Ne faites aucune hypothèse sur l'ordre des composants de l'adresse dans la liste.
missingComponentTypes[]

string

Types de composants qui devaient être présents dans une adresse postale correctement formatée, mais qui n'ont pas été trouvés dans la saisie ET qui n'ont pas pu être inférés. Par exemple, ['street_number', 'route'] pour une entrée telle que "Boulder, Colorado, 80301, États-Unis". Vous trouverez la liste des types possibles sur cette page.

Remarque: Un type de composant peut s'afficher comme manquant alors que vous pensez l'avoir déjà fourni. Par exemple, cela peut se produire lorsque l'adresse saisie contient le nom du bâtiment, mais pas le numéro de l'établissement. Dans l'adresse "渋谷区渋谷３丁目　Shibuya Stream", le nom du bâtiment "Shibuya Stream" a le type de composant premise, mais le numéro d'établissement est manquant. missingComponentTypes contiendra donc premise.
unconfirmedComponentTypes[]

string

Types des composants présents dans addressComponents, mais dont l'exactitude n'a pas pu être confirmée. Ce champ est fourni pour plus de commodité: son contenu équivaut à une itération dans addressComponents pour trouver les types de tous les composants où confirmationLevel n'est pas CONFIRMED ou où l'indicateur inferred n'est pas défini sur true. Vous trouverez la liste des types possibles sur cette page.
unresolvedTokens[]

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 faisant partie d'une adresse valide. Par exemple, pour une entrée telle que "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", les jetons non résolus peuvent ressembler à ["Parcel", "0000123123", "&", "0000456456"].

AddressComponent

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

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

object (ComponentName)

Nom de ce composant.
componentType

string

Type du composant d'adresse. Pour obtenir la liste des types possibles, consultez le tableau 2: Autres types renvoyés par le service Places.
confirmationLevel

enum (ConfirmationLevel)

Indique le niveau de certitude que nous avons que le composant est correct.
inferred

boolean

Indique que le composant ne faisait pas partie de la saisie, 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.
spellCorrected

boolean

Indique une correction d'une faute de frappe dans le nom du composant. L'API ne signale pas toujours les modifications d'une variante d'orthographe à une autre, par exemple lorsque vous remplacez "centre" par "center". Il ne signale pas toujours les fautes d'orthographe courantes, par exemple lorsque vous remplacez "Amphitheater Pkwy" par "Amphitheater Pkwy".
replaced

boolean

Indique que le nom du composant a été remplacé par un autre complètement différent, 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 de saisie a été remplacé par un autre.
unexpected

boolean

Indique un composant d'adresse qui ne devrait pas figurer dans une adresse postale pour la région donnée. Nous l'avons conservée uniquement parce qu'elle faisait partie de la requête.

ComponentName

Enveloppe du nom du composant.

Représentation JSON 
{
  "text": string,
  "languageCode": string
}
Champs
text

string

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

string

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

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 cohérent avec le reste de l'adresse.
UNCONFIRMED_BUT_PLAUSIBLE Nous n'avons pas pu confirmer l'existence de ce composant, mais il est plausible qu'il existe. Par exemple, un numéro de rue compris dans une plage de numéros valides connue pour une rue dont les numéros de maison spécifiques ne sont pas connus.
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.

Géocoder

Contient des informations sur le lieu auquel la valeur a été géocodée.

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

object (LatLng)

Emplacement géocodé de l'entrée.

Nous vous recommandons d'utiliser des ID de lieu plutôt que des adresses, des coordonnées de latitude/longitude ou des plus codes. Lorsque vous utilisez des coordonnées pour calculer un itinéraire ou des itinéraires routiers, le point est toujours aligné sur la route la plus proche de ces coordonnées. Il se peut que cette route ne mène pas rapidement ni de manière sécurisée à la destination, et qu'elle ne se trouve pas à proximité d'un point d'accès à la propriété. De plus, lorsque vous géocodez une adresse à l'envers, il n'est pas garanti que l'adresse renvoyée corresponde à l'adresse d'origine.
plusCode

object (PlusCode)

Plus Code correspondant à location.
bounds

object (Viewport)

Limites du lieu géocodé.
featureSizeMeters

number

Taille 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 termes de taille physique plutôt que de signification sémantique.
placeId

string

ID de lieu auquel cette entrée est géocodée.

Pour en savoir plus sur les ID de lieu, cliquez ici.
placeTypes[]

string

Type(s) de lieu auquel la valeur d'entrée a été géocodée. Par exemple, ['locality', 'political']. Pour obtenir la liste complète des types, cliquez ici.

LatLng

Objet représentant une paire latitude/longitude. Cette valeur est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.

Représentation JSON 
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

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

number

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

PlusCode

Un Plus Code (http://plus.codes) est une référence de lieu qui se présente sous deux formats: un code global qui définit un rectangle de 14 m x 14 m (1/8000e de degré) ou moins, et un code composé, qui remplace le préfixe par un lieu de référence.

Représentation JSON 
{
  "globalCode": string,
  "compoundCode": string
}
Champs
globalCode

string

Code global (complet) du lieu, par exemple "9FWM33GV+HQ", représentant une zone de 1/8 000e de degré par 1/8 000e de degré (environ 14 m x 14 m).
compoundCode

string

Code composé du lieu, par exemple "33GV+HQ, Ramberg, Norway ", contenant le suffixe du code global et remplaçant le préfixe par le nom mis en forme d'une entité de référence.

Fenêtre d'affichage

Fenêtre d'affichage de latitude-longitude, représentée par deux points low et high diagonalement opposés. Une fenêtre d'affichage est considérée comme une région fermée, c'est-à-dire qu'elle inclut sa limite. Les limites de latitude doivent être comprises entre -90 et 90 degrés, inclus, et les limites de longitude entre -180 et 180 degrés, inclus. Voici quelques exemples:

  • Si low = high, la fenêtre d'affichage ne comprend qu'un seul point.

  • Si low.longitude > high.longitude, la plage de longitude est inversée (la fenêtre d'affichage croise la ligne de longitude de 180 degrés).

  • Si low.longitude est égal à -180 degrés et high.longitude à 180 degrés, la fenêtre d'affichage inclut toutes les longitudes.

  • Si low.longitude est défini sur 180 degrés et high.longitude sur -180 degrés, la plage de longitudes est vide.

  • Si low.latitude > high.latitude, la plage de latitude est vide.

low et high doivent être renseignés, et la zone représentée ne doit pas être vide (comme indiqué dans les définitions ci-dessus). Un viewport vide entraînera une erreur.

Par exemple, ce viewport englobe entièrement la ville de New York:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Représentation JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Champs
low

object (LatLng)

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

object (LatLng)

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

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.

Représentation JSON 
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Champs
business

boolean

Indique qu'il s'agit de l'adresse d'une entreprise. Si cette valeur n'est pas définie, cela signifie que la valeur est inconnue.
poBox

boolean

Indique que l'adresse est une boîte postale. Si cette valeur n'est pas définie, cela signifie que la valeur est inconnue.
residential

boolean

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.

UspsData

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.

Représentation JSON 
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": 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
}
Champs
standardizedAddress

object (UspsAddress)

Adresse standardisée USPS.
deliveryPointCode

string

Code à deux chiffres du lieu de livraison
deliveryPointCheckDigit

string

Chiffre de contrôle du point de livraison. Ce numéro est ajouté à la fin du code-barres du point de livraison pour les envois scannés mécaniquement. L'addition de tous les chiffres de delivery_point_barcode, deliveryPointCheckDigit, postal_code et ZIP+4 doit donner un nombre divisible par 10.
dpvConfirmation

string

Valeurs possibles pour la confirmation de la DPV. Renvoie un seul caractère ou aucune valeur.

  • N: la confirmation de la DPV a échoué pour les numéros principal et secondaire.
  • D: l'adresse a été confirmée par DPV pour le numéro principal uniquement, et les informations sur le numéro secondaire étaient manquantes.
  • S: L'adresse a été confirmée par DPV pour le numéro principal uniquement, et les informations du numéro secondaire étaient présentes, mais non confirmées.
  • Y: L'adresse a été confirmée par DPV pour le numéro principal et tous les numéros secondaires.
  • Vide: si la réponse ne contient pas de valeur dpvConfirmation, l'adresse n'a pas été envoyée pour confirmation de la validation par adresse postale.
dpvFootnote

string

Notes de bas de page de la validation du point de livraison. Plusieurs notes de bas de page peuvent être associées dans la même chaîne.

  • AA: adresse saisie correspondant au fichier ZIP+4
  • A1: l'adresse saisie ne correspond pas au fichier ZIP+4
  • BB: Correspond à la valeur DPV (tous les composants)
  • CC: numéro secondaire non associé et non obligatoire
  • C1: Numéro secondaire non associé, mais obligatoire
  • N1: numéro secondaire manquant pour une adresse de bâtiment
  • M1: Numéro principal manquant
  • M3: numéro principal non valide
  • P1: Numéro de boîte postale, de route rurale ou de case postale manquant dans l'adresse de saisie
  • P3: Numéro de boîte postale, de route rurale ou de centre de distribution incorrect
  • F1: adresse saisie correspondant à une adresse militaire
  • G1: adresse saisie correspondant à une adresse de distribution générale
  • U1: adresse saisie correspondant à un code postal unique
  • PB: adresse saisie correspondant à l'enregistrement PBSA
  • RR: adresse confirmée par le DPV avec des informations sur le PMB
  • R1: adresse confirmée par le DPV sans informations sur le PMB
  • R7: enregistrement R777 ou R779 de la route du transporteur
  • IA: adresse informée identifiée
  • TA: numéro principal correspondant en supprimant l'alpha à la fin
dpvCmra

string

Indique si l'adresse est une agence de réception du courrier commercial (CMRA, Commercial Mail Receiving Agency), c'est-à-dire une entreprise privée qui reçoit le courrier de ses clients. Renvoie un seul caractère.

  • Y: l'adresse est une adresse de CMRA
  • N: l'adresse n'est pas une adresse CMRA
dpvVacant

string

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

  • Y: l'adresse est vacante
  • N: l'adresse n'est pas vacante
dpvNoStat

string

S\'agit-il d\'une adresse sans statistiques ou d\'une adresse active ? Les adresses sans statistiques sont celles qui ne sont pas occupées en permanence ou celles que le service postal américain ne dessert pas. Renvoie un seul caractère.

  • Y: l'adresse n'est pas active
  • N: l'adresse est active
dpvNoStatReasonCode

integer

Indique le type NoStat. Renvoie un code de raison au format int.

  • 1 : adresse de dépôt interne (IDA, Internal Drop Address) : adresse qui ne reçoit pas de courrier directement de la part de l'USPS, mais qui est livrée à une adresse de dépôt qui la dessert.
  • 2: CDS (adresses non encore livrables) Par exemple, une nouvelle subdivision où les lots et les numéros principaux ont été déterminés, mais où aucune structure n'existe encore pour l'occupation.
  • 3 : Collision : adresses qui ne sont pas confirmées par DPV.
  • 4 : CMZ (College, Military and Other Types) : code postal + 4 enregistrements que l'USPS a intégrés aux données.
  • 5 : Standard : indique les adresses qui ne sont pas livrées et qui ne sont pas comptabilisées comme des livraisons possibles.
  • 6 : Informations secondaires requises : l'adresse nécessite des informations secondaires.
dpvDrop

string

Ce flag indique que le courrier est distribué à une seule boîte aux lettres sur un site. Renvoie un seul caractère.

  • Y: le courrier est distribué dans un seul bac de réception sur un site.
  • N: le courrier n'est pas distribué dans un seul bac de réception sur un site.
dpvThrowback

string

Indique que le courrier n'est pas distribué à l'adresse postale. Renvoie un seul caractère.

  • Y: le courrier n'est pas distribué à l'adresse postale.
  • N: le courrier est distribué à l'adresse postale.
dpvNonDeliveryDays

string

Ce flag indique que la distribution du courrier n'est pas effectuée tous les jours de la semaine. Renvoie un seul caractère.

  • Y: la distribution du courrier n'est pas effectuée tous les jours de la semaine.
  • N: aucune indication que la distribution du courrier n'est pas effectuée tous les jours de la semaine.
dpvNonDeliveryDaysValues

integer

Entier identifiant les jours de non-diffusion. Il peut être interrogé à l'aide d'indicateurs de bits : 0x40 : le dimanche est un jour sans livraison 0x20 : le lundi est un jour sans livraison 0x10 : le mardi est un jour sans livraison 0x08 : le mercredi est un jour sans livraison 0x04 : le jeudi est un jour sans livraison 0x02 : le vendredi est un jour sans livraison 0x01 : le samedi est un jour sans livraison
dpvNoSecureLocation

string

L'indicateur indique que la porte est accessible, mais le colis ne sera pas laissé pour des raisons de sécurité. Renvoie un seul caractère.

  • Y: le package ne sera pas conservé pour des raisons de sécurité.
  • N: aucune indication que le package ne sera pas laissé pour des raisons de sécurité.
dpvPbsa

string

Indique que l'adresse a été mise en correspondance avec l'enregistrement PBSA. Renvoie un seul caractère.

  • Y: l'adresse a été mise en correspondance avec l'enregistrement PBSA.
  • N: l'adresse n'a pas été mise en correspondance avec l'enregistrement PBSA.
dpvDoorNotAccessible

string

Ce code indique les adresses où le service postal américain ne peut pas frapper à la porte pour distribuer le courrier. Renvoie un seul caractère.

  • Y: la porte n'est pas accessible.
  • N: aucune indication que la porte n'est pas accessible.
dpvEnhancedDeliveryCode

string

Indique qu'un ou plusieurs codes de retour DPV sont valides pour l'adresse. Renvoie un seul caractère.

  • Y: L'adresse a été confirmée par DPV pour le numéro principal et tous les numéros secondaires.
  • N: la confirmation de la validation par DPV a échoué pour les numéros principal et secondaire.
  • S: l'adresse a été confirmée par DPV pour le numéro principal uniquement, et les informations sur le numéro secondaire étaient présentes, mais non confirmées, ou un seul caractère alpha à la fin d'un numéro principal a été supprimé pour permettre une correspondance DPV et des informations secondaires étaient requises.
  • D: l'adresse a été confirmée par DPV pour le numéro principal uniquement, et les informations sur le numéro secondaire étaient manquantes.
  • R: L'adresse a été confirmée, mais elle est attribuée à des rues fantômes (R777 et R779). La livraison par USPS n'est pas disponible.
carrierRoute

string

Code de l'itinéraire du transporteur. Code à quatre caractères composé d'un préfixe à une lettre et d'un indicateur de route à trois chiffres.

Préfixes:

  • C: ligne de l'opérateur (ou ligne urbaine)
  • R: route rurale
  • H: Route de contrat autoroutier
  • B: section de la boîte postale
  • G: unité de distribution générale
carrierRouteIndicator

string

Indicateur de tri des tarifs de la ligne du transporteur.
ewsNoMatch

boolean

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

string

Ville du bureau de poste principal.
postOfficeState

string

État du bureau de poste principal.
abbreviatedCity

string

Ville abrégée.
fipsCountyCode

string

Code de comté FIPS.
county

string

Nom du comté.
elotNumber

string

Numéro de la ligne de circulation améliorée (eLOT, Enhanced Line of Travel).
elotFlag

string

Indicateur de montée/descente (A/D) de l'eLOT.
poBoxOnlyPostalCode

boolean

Code postal de la boîte postale uniquement.
pmbDesignator

string

Indicateur d'unité PMB (Private Mail Box)
pmbNumber

string

Numéro de boîte postale privée
addressRecordType

string

Type de l'enregistrement d'adresse correspondant à l'adresse saisie.

  • F: FIRM. Il s'agit d'une correspondance avec un enregistrement d'entreprise, qui est le niveau de correspondance le plus précis disponible pour une adresse.
  • G: LIVRAISON GÉNÉRALE. Il s'agit d'une correspondance avec un enregistrement de distribution générale.
  • H: BÂTIMENT / APPARTEMENT Il s'agit d'une correspondance avec un enregistrement d'immeuble ou d'appartement.
  • P: BOÎTE POSTALE. Il s'agit d'une correspondance avec une boîte postale.
  • R: RURAL ROUTE ou HIGHWAY CONTRACT: il s'agit d'une correspondance avec un enregistrement de route rurale ou de contrat autoroutier, qui peuvent tous deux être associés à des plages de numéros de boîte.
  • S: enregistrement de rue: correspondance avec un enregistrement de rue contenant une plage de numéros principaux valide.
defaultAddress

boolean

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

string

Message d'erreur pour la récupération des données USPS. Ce champ est renseigné lorsque le traitement par l'USPS est suspendu en raison de la détection d'adresses créées artificiellement.

Les champs de données USPS peuvent ne pas être renseignés lorsque cette erreur se produit.
cassProcessed

boolean

Indique que la requête a été traitée par le système CASS.

UspsAddress

Représentation USPS d'une adresse aux États-Unis.

Représentation JSON 
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
Champs
firstAddressLine

string

Première ligne de l'adresse.
firm

string

Nom de l'entreprise.
secondAddressLine

string

Deuxième ligne d'adresse.
urbanization

string

Nom de l'urbanisation portoricaine.
cityStateZipAddressLine

string

Ville + État + code postal
city

string

Nom de la ville.
state

string

Code de l'État à deux lettres.
zipCode

string

Code postal (par exemple, 10009)
zipCodeExtension

string

Extension à quatre chiffres du code postal (par exemple, 5023)