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 consulter la liste des régions couvertes, cliquez ici.

La valeur languageCode de l'adresse d'entrée est réservée pour de futures utilisations et est ignorée aujourd'hui. Le résultat validé est renseigné en fonction de la langue préférée pour l'adresse donnée, telle qu'elle est identifiée par le système.

L'API Address Validation ignore les valeurs dans recipients et organization. Toutes 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 davantage de requêtes sont nécessaires pour valider complètement une adresse unique (par exemple, si les modifications apportées par l'utilisateur après la validation initiale doivent être revalidées), chaque demande 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 USPS CASS. Cela n'affecte que le champ google.maps.addressvalidation.v1.ValidationResult.usps_data de google.maps.addressvalidation.v1.ValidationResult. Remarque: Pour les requêtes utilisant USPS CASS pour des adresses à Porto Rico, le champ google.type.PostalAddress.region_code de l'address doit être indiqué en tant que "PR", ou le champ google.type.PostalAddress.administrative_area du champ address doit être indiqué en tant que "Porto Rico". (non sensible à la casse) ou "PR".

Nous vous recommandons d'utiliser une propriété address composée de composants ou de spécifier au moins deux valeurs 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.
languageOptions

object (LanguageOptions)

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

string

Facultatif. Chaîne identifiant une session Autocomplete à des fins de facturation. Doit être une chaîne au format base64 sans risque pour les URL et les noms de fichiers, avec une longueur maximale de 36 caractères ASCII. Sinon, une erreur INVALID_ARGUMENT est renvoyée.

La session commence lorsque l'utilisateur effectue une requête Autocomplete. Elle 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 Place Details ou Address Validation. Les identifiants utilisés pour chaque requête au sein d'une session doivent appartenir au même projet dans la console Google Cloud. 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 le paramètre sessionToken est omis 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: Address Validation ne peut être utilisé que dans les sessions avec l'API Autocomplete (nouvelle), et non 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 qui identifie cette réponse. Si l'adresse doit être à nouveau validée, cet UUID doit accompagner la nouvelle demande.

PostalAddress

Représente une adresse postale, telles que des 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 saisie utilisateur ou lors de l'importation de données existantes, en fonction du type de processus.

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

Pour en savoir plus sur l'utilisation de ce schéma, consultez la page 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 obligera l'API à renvoyer une erreur INVALID_ARGUMENT.
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 des performances optimales, nous vous recommandons d'inclure le code de région si vous le connaissez. Si les régions sont incohérentes ou répétées, les performances peuvent être médiocres. Par exemple, si addressLines inclut déjà la région, ne saisissez pas à nouveau le code de région dans ce champ. Pour en savoir plus sur les régions concernées, consultez les questions fréquentes.
languageCode

string

Le code de langue de l'adresse de saisie est réservé pour une utilisation future et est ignoré aujourd'hui. L'API renvoie l'adresse dans la langue correspondant à celle-ci.
postalCode

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).
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é, 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).
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. 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.
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 le champ de localité vide et utilisez addressLines.
sublocality

string

Facultatif. Sous-localité de l'adresse. Il peut s'agir, par exemple, de quartiers, d'arrondissements ou de districts.
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 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 comprend 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 de le géocoder pour gérer les adresses complètement non structurées (plutôt que de deviner quelles parties de l'adresse correspondent à des localités ou des régions administratives).
recipients[]

string

Veuillez ne pas définir ce champ. L'API Address Validation ne l'utilise pas actuellement. À l'heure actuelle, l'API ne refuse pas les requêtes pour lesquelles ce champ est défini, mais les informations sont ignorées et ne sont pas renvoyées dans la réponse.
organization

string

Veuillez ne pas définir ce champ. L'API Address Validation ne l'utilise pas actuellement. À l'heure actuelle, l'API ne rejette pas les requêtes pour lesquelles ce champ est défini, mais les informations sont ignorées et ne sont pas renvoyées dans la réponse.

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.

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

boolean

Aperçu: Renvoyez 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 de verdict globales
address

object (Address)

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

object (Geocode)

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

object (AddressMetadata)

Autres informations pertinentes sur la délivrabilité. 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)

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.

Les adresses traduites ne sont pas réutilisables en tant qu'entrées API. Le service les fournit afin que l'utilisateur puisse utiliser sa langue maternelle pour confirmer ou refuser la validation de l'adresse fournie à l'origine.

Si une partie de l'adresse n'est pas traduite en anglais, le service la renvoie dans une autre langue utilisant l'alphabet latin. Pour savoir comment l'autre langue est sélectionnée, cliquez ici. Si une partie de l'adresse n'est pas traduite ni translittérée dans une langue utilisant l'alphabet latin, le service la renvoie 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: Le champ google.maps.addressvalidation.v1.Address.unconfirmed_component_types dans englishLatinAddress et les champs google.maps.addressvalidation.v1.AddressComponent.confirmation_level dans englishLatinAddress.address_components ne sont pas renseignés.

Verdict

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

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 input. Ceci est le résultat de l'analyse de l'adresse d'entrée et ne fournit aucun signal de validation. Pour connaître les signaux de validation, consultez validationGranularity ci-dessous.

Par exemple, si l'adresse d'entrée inclut un numéro d'appartement spécifique, inputGranularity sera SUB_PREMISE. Si nous ne pouvons pas faire correspondre le numéro d'appartement dans les bases de données ou si ce numéro n'est pas valide, la valeur validationGranularity sera probablement PREMISE ou inférieure.
validationGranularity

enum (Granularity)

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

Le résultat de la validation par composant d'adresse est disponible dans google.maps.addressvalidation.v1.Address.address_components.
geocodeGranularity

enum (Granularity)

Informations sur le niveau de précision de geocode. Cela peut être interprété comme la signification sémantique du degré de précision ou de grossièreté du lieu géocodé.

Elle peut parfois différer de la valeur validationGranularity ci-dessus. Par exemple, notre base de données peut enregistrer l'existence d'un numéro d'appartement, mais ne pas avoir d'emplacement précis pour l'appartement dans un grand immeuble d'habitation. Dans ce cas, validationGranularity sera SUB_PREMISE, mais geocodeGranularity sera PREMISE.
addressComplete

boolean

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. Si cette règle n'est pas configurée, elle 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 être ni classé, ni validé. Consultez google.maps.addressvalidation.v1.Address.address_components pour en savoir plus.
hasInferredComponents

boolean

Au moins un composant d'adresse a été déduit (ajouté) qui ne figurait pas dans l'entrée. 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é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 niveau de précision auquel l'adresse identifie une destination postale. Par exemple, une adresse telle que "123 Main Street, Redwood City, CA, 94061" identifie un PREMISE alors que quelque chose comme "Redwood City, CA, 94061" identifie un LOCALITY. Toutefois, si nous ne trouvons pas de géocode pour "123 Main Street" à Redwood City, le geocoding renvoyé peut être de niveau 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 sous le bâtiment (appartement, par exemple).
PREMISE Résultat au niveau du bâtiment.
PREMISE_PROXIMITY Géocode approximative de l'emplacement 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 disposent d'adresses au niveau du bloc, telles que le Japon.
ROUTE Le géocode ou l'adresse sont précis(e)s concernant l'itinéraire (par exemple, une rue, une route ou une autoroute).
OTHER Toutes les autres granularités, qui sont regroupées dans des ensembles puisqu'elles ne sont pas livrables.

Adresse

Détails de l'adresse post-traitée. Le post-traitement consiste à corriger les parties mal orthographiées de l'adresse, à remplacer les pièces incorrectes et à déduire 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, formatée comme une adresse sur une seule ligne suivant les règles de mise en forme des adresses de la région où se trouve l'adresse.
postalAddress

object (PostalAddress)

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

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 ordonnés d'une manière particulière. Ne faites aucune hypothèse concernant l'ordre des composants d'adresse dans la liste.
missingComponentTypes[]

string

Les types de composants qui étaient censés être présents dans une adresse postale au bon format, mais qui n'ont pas été trouvés dans l'entrée ET qui n'ont pas pu être déduits. Les composants de ce type ne sont pas présents dans formattedAddress, postalAddress ni addressComponents. Exemple : ['street_number', 'route'] pour une entrée telle que "Boulder, Colorado, 80301, USA". Pour consulter la liste des types possibles, cliquez ici.
unconfirmedComponentTypes[]

string

Types de composants présents dans addressComponents, mais dont l'exactitude n'a pas pu être confirmée. Ce champ est fourni à titre indicatif: son contenu équivaut à une itération via addressComponents pour trouver les types de tous les composants pour lesquels confirmationLevel n'est pas CONFIRMED ou pour lequel l'option inferred n'est pas définie sur true. Pour consulter la liste des types possibles, cliquez ici.
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 une partie valide d'une adresse (par exemple, dans une entrée telle que "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.

AddressComponent

Représente un élément d'adresse, tel qu'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 de composant de l'adresse. Consultez le Tableau 2: Autres types renvoyés par le service Places pour obtenir la liste des types possibles.
confirmationLevel

enum (ConfirmationLevel)

Indique le degré de certitude que le composant est correct.
inferred

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

boolean

Indique une correction d'une faute d'orthographe dans le nom du composant. L'API ne signale pas toujours les changements d'orthographe d'une variante orthographique à une autre, par exemple lorsque vous modifiez "centre". et "center". De plus, il ne signale pas toujours les fautes d'orthographe courantes (par exemple, "Amphitheatre Pkwy"). à "Amphitheatre Pkwy".
replaced

boolean

Indique que le nom de l'élément a été remplacé par un autre nom (par exemple, un code postal incorrect a été remplacé par un code 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

boolean

Indique un composant d'adresse qui ne devrait pas être présent dans une adresse postale pour la région donnée. Nous l'avons conservé uniquement parce qu'il faisait partie de l'entrée.

ComponentName

Wrapper du nom du composant.

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

string

Texte du nom. 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 ne sera pas présent si le nom de l'élément n'est associé à aucune langue, telle qu'un numéro de rue.

ConfirmationLevel

Les 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 est logique dans le contexte du reste de l'adresse.
UNCONFIRMED_BUT_PLAUSIBLE Impossible de confirmer ce composant, mais il est possible qu'il existe. Il peut s'agir, par exemple, d'un numéro de rue compris dans une plage valide connue de numéros dans une rue, lorsque le numéro de rue spécifique n'est pas connu.
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 sur lequel l'entrée 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.

Il est préférable d'utiliser des ID de lieu plutôt que d'utiliser des adresses, des coordonnées de latitude/longitude ou des codes plus codes. Lorsque vous utilisez des coordonnées lors du calcul d'un itinéraire ou d'un itinéraire en voiture, le point est toujours aligné sur la route la plus proche de ces coordonnées. Il est possible qu'elle ne permette pas d'accéder rapidement ou en toute sécurité à la destination, et qu'elle ne soit pas située à proximité d'un point d'accès à la propriété. De plus, lorsqu'un établissement est géocodé à l'envers, il n'est pas garanti que l'adresse renvoyée corresponde à l'adresse d'origine.
plusCode

object (PlusCode)

Plus code correspondant à l'élément location.
bounds

object (Viewport)

Limites du lieu géocodé.
featureSizeMeters

number

Taille du lieu géocodé, en mètres. Il s'agit là d'une autre mesure du caractère grossière du lieu géocodé, mais en termes de taille physique plutôt que sémantique.
placeId

string

PlaceID du lieu géocodé par cette entrée.

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

string

Type(s) de lieu géocodé(s) par l'entrée. Par exemple, ['locality', 'political']. Pour consulter la liste complète des types, cliquez ici.

LatLng

Objet représentant une paire latitude/longitude. Elle 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

Le Plus Code (http://plus.codes) est une référence d'emplacement sous deux formats: le code global définissant un rectangle de 14mx14m (1/8000e de degré) ou plus petit, et le 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", qui représente une zone de 1/8000 x 1/8000 degré (environ 14 x 14 mètres).
compoundCode

string

Code composé du lieu, tel que "33GV+HQ, Ramberg, Norvège", contenant le suffixe du code global et le remplacement du 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 opposés en diagonale. Une fenêtre d'affichage est considérée comme une région fermée (elle inclut ses limites). 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 différents cas de figure:

  • Si low = high, la fenêtre d'affichage est constituée de ce seul point.

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

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

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

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

Les champs low et high doivent tous les deux être renseignés, et la zone représentée ne peut pas être vide (comme spécifié dans les définitions ci-dessus). Si la fenêtre d'affichage est vide, cela génère une erreur.

Par exemple, cette fenêtre d'affichage englobe entièrement 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 haut 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 règle n'est pas configurée, elle indique que la valeur est inconnue.
poBox

boolean

Indique l'adresse d'une boîte postale. Si cette règle n'est pas configurée, elle indique que la valeur est inconnue.
residential

boolean

Indique qu'il s'agit de l'adresse d'une résidence. Si cette règle n'est pas configurée, elle indique que la valeur est inconnue.

UspsData

Données USPS pour l'adresse. Il n'est pas garanti que le champ uspsData soit entièrement rempli pour chaque adresse aux États-Unis ou à un RP envoyée à 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.

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 normalisée USPS.
deliveryPointCode

string

Code de point de livraison à deux chiffres
deliveryPointCheckDigit

string

Chiffre de contrôle du point de livraison. Ce nombre est ajouté à la fin de la valeur delivery_point_barcode pour les e-mails scannés manuellement. En ajoutant tous les chiffres de delivery_point_barcode, deliveryPointCheckDigit, code postal et ZIP+4, vous devez obtenir 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 validation de la DPV a échoué pour le numéro principal et les informations secondaires.
  • D: l'adresse a été confirmée pour le numéro principal uniquement, et le numéro secondaire était manquant.
  • S: l'adresse a été confirmée pour le numéro principal uniquement. Les informations du numéro secondaire étaient présentes, mais pas confirmées.
  • Y: l'adresse a été confirmée pour le numéro principal et les numéros secondaires.
  • Vide: si la réponse ne contient pas de valeur dpvConfirmation, cela signifie que l'adresse n'a pas été envoyée pour la confirmation de la DPV.
dpvFootnote

string

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

  • AA: adresse d'entrée mise en correspondance avec le fichier ZIP+4
  • A1: l'adresse d'entrée ne correspond pas au fichier ZIP+4.
  • BB: mis en correspondance avec la DPV (tous les composants)
  • CC: numéro secondaire sans correspondance et non requis
  • C1: numéro secondaire requis, mais sans correspondance
  • N1: numéro secondaire manquant dans un gratte-ciel
  • M1: numéro principal manquant
  • M3: numéro principal non valide
  • P1: adresse d'entrée PO, RR ou numéro de boîte du centre d'aide manquant
  • P3: numéro de bon de commande, numéro de demande d'enregistrement ou numéro de boîte du centre d'aide de l'adresse de saisie non valide
  • F1: adresse d'entrée associée à une adresse militaire
  • G1: adresse saisie correspondant à une adresse de livraison générale
  • U1: adresse saisie associée à un code postal unique
  • PB: adresse d'entrée mise en correspondance avec l'enregistrement PBSA
  • RR: adresse confirmée avec les informations du PMB
  • R1: adresse confirmée par la DPV, sans les informations du PMB
  • R7: enregistrement Route R777 ou R779 de l'opérateur
  • IA: adresse éclairée identifiée
  • TA: numéro principal mis en correspondance en supprimant une valeur alpha à la fin.
dpvCmra

string

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

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

string

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

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

string

S'agit-il d'une adresse active ou sans statistiques ? Les adresses statistiques ne sont pas occupées en permanence ou ne sont pas desservies par l'USPS. Renvoie un seul caractère.

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

integer

Indique le type de valeur NoStat. Renvoie un code de motif sous la forme d'un entier.

  • 1 : IDA (Internal Drop Address) (adresse de dépôt interne) : adresses qui ne reçoivent pas de courrier directement de l'USPS, mais qui sont distribuées à une adresse de dépôt qui les dessert.
  • 2: CDS – Adresses qui ne sont pas encore livrables. Par exemple, une nouvelle subdivision dans laquelle les lots et les numéros principaux ont été déterminés, mais où il n'existe pas encore de structure pour le nombre de personnes.
  • 3: collision (adresses qui ne sont pas confirmées par la DPV).
  • 4: CMZ (College, Military and Other Types) – ZIP + 4 enregistrements USPS incorporés dans les données.
  • 5 : standard : les adresses ne reçoivent pas de livraison et ne sont pas comptabilisées comme des livraisons possibles.
  • 6: adresse e-mail secondaire obligatoire.
dpvDrop

string

L'indicateur indique que le courrier est distribué à un seul destinataire sur un site. Renvoie un seul caractère.

  • Y: le courrier est distribué à un destinataire unique sur un site.
  • N: le courrier n'est pas distribué à un destinataire unique 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

L'indicateur indique que l'envoi d'e-mails n'est pas effectué tous les jours de la semaine. Renvoie un seul caractère.

  • Y: le courrier n'est pas distribué tous les jours.
  • N: aucune indication que l'envoi du courrier n'est pas effectué 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 de non-livraison 0x02 – Le lundi est un jour de non-livraison 0x02 – 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-livraison 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 – Le vendredi est un jour de non-livraison 0x02
dpvNoSecureLocation

string

L'indicateur 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.

  • Y: le colis ne sera pas conservé en raison de problèmes de sécurité.
  • N: aucune indication que le colis ne sera pas déposé en raison de problèmes de sécurité.
dpvPbsa

string

Indique que l'adresse a été mise en correspondance avec un 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

L'indicateur indique les adresses pour lesquelles USPS ne peut pas frapper à la porte pour distribuer du 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 que plusieurs codes DPV renvoyés sont valides pour l'adresse. Renvoie un seul caractère.

  • Y: l'adresse a été confirmée pour le numéro principal et les numéros secondaires.
  • N: la validation de la DPV a échoué pour le numéro principal et les informations secondaires.
  • S: l'adresse a été confirmée pour le numéro principal uniquement, et les informations du numéro secondaire étaient présentes, mais pas confirmées, ou un seul alpha à la fin d'un numéro principal a été supprimé pour établir une correspondance avec la DPV et fournir des informations secondaires.
  • D: l'adresse a été confirmée pour le numéro principal uniquement, et le numéro secondaire était manquant.
  • R: l'adresse confirmée, mais attribuée à la route fantôme R777, R779 et USPS n'est pas fournie.
carrierRoute

string

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

Préfixes:

  • C: itinéraire de la compagnie (ou de la ville)
  • R: route rurale
  • H: itinéraire du contrat autoroutier
  • B: section "Boîte postale"
  • G: unité de diffusion générale
carrierRouteIndicator

string

Indicateur de tri du tarif de routage du transporteur.
ewsNoMatch

boolean

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

string

Ville du bureau de poste principal.
postOfficeState

string

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 eLOT (Enhanced Line of Travel).
elotFlag

string

Indicateur eLOT croissant/décroissant (A/D).
poBoxOnlyPostalCode

boolean

Code postal de la boîte postale uniquement.
pmbDesignator

string

Désignation de la boîte aux lettres privée (PMB)
pmbNumber

string

Numéro de boîte aux lettres privée (PMB)
addressRecordType

string

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

  • F: FIRM. Il s'agit d'une correspondance avec un enregistrement d'entreprise, qui constitue 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: Bâtiment / Appartement. Il s'agit d'une correspondance avec un enregistrement de bâtiment ou d'appartement.
  • P: POST OFFICE BOX. Il s'agit d'une correspondance avec une boîte postale.
  • R: RURAL ROUTE ou HIGHWAY CONTRACT: correspond à un enregistrement de route rurale ou de contrat d'autoroute, qui peuvent tous deux être associés à des plages de numéros de boîte aux lettres.
  • S (STREET RECORD) : correspondance avec un enregistrement de rue contenant une plage de numéros principal valide.
defaultAddress

boolean

Indicateur spécifiant 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 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.
cassProcessed

boolean

Indicateur spécifiant que la requête a été traitée 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 d'adresse.
firm

string

Nom de l'entreprise.
secondAddressLine

string

Deuxième ligne d'adresse.
urbanization

string

Nom d'urbanisation portoricain
cityStateZipAddressLine

string

Ville + État + code postal.
city

string

Nom de la ville.
state

string

Code d'État à deux lettres.
zipCode

string

Code postal, par exemple 10009.
zipCodeExtension

string

Extension de code postal à quatre chiffres (ex. : 5023.