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

L'API Address Validation ignore les valeurs de recipients et organization. Les valeurs de ces champs seront ignoré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 demandes sont nécessaires pour valider entièrement une seule adresse (par exemple, si les modifications apportées par l'utilisateur après la validation initiale doivent être revalidées), chaque demande de suivi doit renseigner ce champ avec la valeur responseId de la toute première réponse de la séquence de validation.

enableUspsCass

boolean

Active le mode compatible USPS CASS. 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 dans lesquelles USPS CASS est activé, un google.type.PostalAddress.region_code du address doit être indiqué sous la forme "PR", ou un google.type.PostalAddress.administrative_area de address doit être indiqué sous la forme "Portto Rico" (non sensible à la casse) ou "PR".

Nous vous recommandons d'utiliser un address composé de composants ou de spécifier au moins deux google.type.PostalAddress.address_lines : 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 qui identifie une session de saisie semi-automatique à des fins de facturation. Il doit s'agir d'une chaîne en base64 avec nom de fichier et URL ne dépassant pas 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 Place Details ou Address Validation. Les identifiants utilisés pour chaque requête au cours d'une session doivent appartenir au même projet de 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é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 requête 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 validée à nouveau, 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 / modification des adresses : utilisez un widget d'adresse adapté à l'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 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 entraîne le renvoi 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 régional 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. Des régions incohérentes ou répétées peuvent nuire aux performances. Par exemple, si addressLines inclut déjà la région, ne fournissez plus le code régional dans ce champ. Consultez les questions fréquentes pour connaître les régions acceptées.

languageCode

string

Le code de langue de l'adresse d'entrée est réservé pour une utilisation future et est ignoré aujourd'hui. L'API renvoie l'adresse dans la langue correspondant à son emplacement.

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 correspond à toutes les informations placées dans addressLines. Si aucun élément regionCode n'est fourni, la région est déduite des lignes d'adresse.

Créer une adresse ne contenant que addressLines, puis le geocoding est la méthode recommandée pour traiter des adresses totalement non structurées (plutôt que de deviner quelles parties de l'adresse doivent correspondre à 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. Bien que, pour le moment, l'API ne rejette pas les requêtes comportant ce champ, les informations qu'elle contient seront ignorées et ne seront 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. Bien que, pour le moment, l'API ne rejette pas les requêtes comportant ce champ, les informations qu'elle contient seront ignorées et ne seront 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 d'évaluation globale

address

object (Address)

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

geocode

object (Geocode)

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

metadata

object (AddressMetadata)

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

uspsData

object (UspsData)

Indicateurs de livraison supplémentaires fournis par USPS. Uniquement disponible 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. Si une partie de l'adresse n'est pas traduite en anglais, le service la renvoie dans une autre langue utilisant des caractères latins. Pour savoir comment l'autre langue est sélectionnée, cliquez ici. Si une partie de l'adresse ne comporte pas de traduction ni de translittération dans une langue utilisant l'alphabet latin, le service renvoie cette partie dans la langue locale associée à l'adresse.

Vous avez activé 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 le champ 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 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 d'entrée. Il s'agit du résultat de l'analyse de l'adresse d'entrée et ne fournit aucun signal de validation. Pour les signaux de validation, reportez-vous à validationGranularity ci-dessous.

Par exemple, si l'adresse saisie inclut un numéro d'appartement spécifique, inputGranularity sera ici SUB_PREMISE. Si nous ne pouvons pas établir de correspondance avec le numéro d'appartement dans les bases de données ou si le numéro d'appartement n'est pas valide, le champ validationGranularity sera probablement PREMISE ou inférieur.

validationGranularity

enum (Granularity)

Niveau de précision auquel l'API peut entièrement validate l'adresse. Par exemple, un validationGranularity de PREMISE indique que tous les composants d'adresse au niveau PREMISE ou plus grossier 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 la précision de geocode. Cela peut être compris comme la signification sémantique du degré de grossièreté ou de précision de la position géocodée.

Cette valeur peut parfois être différente des 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 pour l'appartement dans un grand complexe d'appartements. 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. 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é. Consultez google.maps.addressvalidation.v1.Address.address_components pour en savoir plus.

hasInferredComponents

boolean

Nous avons déduit au moins un composant d'adresse 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

Il s'agit des différents niveaux de précision d'une adresse ou d'un géocode. Lorsqu'elles sont utilisées pour indiquer le niveau de précision d'une adresse, ces valeurs indiquent le degré de précision avec lequel l'adresse peut identifier une destination postale. Par exemple, une adresse telle que "123 Main Street, Redwood City, CA 94061" identifie un PREMISE, tandis qu'une adresse du type "Redwood City, CA, 94061" identifie un LOCALITY. Toutefois, si nous ne trouvons pas de géocode pour le "123 Main Street" à Redwood City, le géocode renvoyé peut être de précision 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 d'un niveau inférieur au bâtiment, tel qu'un appartement.
PREMISE Résultat au niveau du bâtiment.
PREMISE_PROXIMITY Géocode indiquant approximativement l'emplacement au niveau du bâtiment de l'adresse.
BLOCK L'adresse ou le géocode indique un bloc. Utilisé uniquement dans les régions qui disposent d'un adressage au niveau du bloc, comme le Japon.
ROUTE Le géocode ou l'adresse sont granulaires pour l'itinéraire, comme une rue, une route ou une autoroute.
OTHER Toutes les autres niveaux de précision, qui sont regroupés, car ils ne peuvent pas être diffusés.

Adresse

Détails de l'adresse post-traitée. Le post-traitement consiste à corriger les parties mal orthographiées de l'adresse, à remplacer les éléments incorrects 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, qui prend la forme d'une adresse sur une seule ligne, conformément aux règles de mise en forme applicables à 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. Les composants d'adresse individuels de l'adresse mise en forme 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

Types de composants qui étaient censés être présents dans une adresse postale valide, mais qui étaient introuvables dans l'entrée ET n'ont pas pu être déduits. Les composants de ce type ne sont pas présents dans formattedAddress, postalAddress ou 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 le addressComponents, mais dont l'exactitude n'a pas pu être confirmée. Ce champ est fourni par souci de commodité: son contenu équivaut à une itération via addressComponents pour trouver les types de tous les composants pour lesquels confirmationLevel n'est pas CONFIRMED ou que 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 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 il ne s'agit pas d'un numéro de rue valide.

AddressComponent

Représente un composant 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 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 degré de certitude quant à l'exactitude du composant.

inferred

boolean

Indique que l'élément ne faisait pas partie de l'entrée, mais que nous l'avons déduit pour l'emplacement de l'adresse et que nous pensons qu'il doit être fourni pour une adresse complète.

spellCorrected

boolean

Indique la 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, comme lors du passage de "centre" à "centre". Par ailleurs, il ne signale pas toujours les fautes d'orthographe courantes, telles que le remplacement de "Amphitheatre Pkwy" par "Amphitheatre Pkwy".

replaced

boolean

Indique que le nom de l'élément a été remplacé par un nom complètement différent (par exemple, le remplacement d'un code postal incorrect 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 de la région donnée. Nous ne l'avons conservé que parce qu'il faisait partie de l'entrée.

ComponentName

Wrapper pour le 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. Cet attribut n'est pas indiqué si le nom du composant n'est pas associé à une langue, comme 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 cet élément existe et qu'il est logique dans le contexte du reste de l'adresse.
UNCONFIRMED_BUT_PLAUSIBLE Ce composant n'a pas pu être confirmé, mais il est possible qu'il existe. Par exemple, un numéro de rue compris dans une plage de numéros valide dans une rue où des numéros de rue spécifiques ne sont pas connus.
UNCONFIRMED_AND_SUSPICIOUS Ce composant n'a pas été confirmé et est probablement incorrect. (un quartier qui ne correspond pas au reste de l'adresse, par exemple).

Géocoder

Contient des informations sur le lieu dans 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)

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

Il est préférable d'utiliser des ID de lieu plutôt que des adresses, des coordonnées de latitude/longitude ou des codes plus code. Si vous utilisez des coordonnées pour calculer ou calculer un itinéraire, le point sera toujours ancré à la route la plus proche de ces coordonnées. Il ne s'agit peut-être pas d'une route qui conduira rapidement ou de manière sûre à la destination, et peut ne pas se trouver à proximité d'un point d'accès à la propriété. En outre, lorsqu'un établissement fait l'objet d'un geocoding inversé, il n'y a aucune garantie que l'adresse renvoyée corresponde à l'adresse d'origine.

plusCode

object (PlusCode)

Plus code correspondant au location.

bounds

object (Viewport)

Les limites du lieu géocodé.

featureSizeMeters

number

Taille du lieu géocodé, en mètres. Il s'agit d'une autre mesure du caractère grossier du lieu géocodé, mais en taille physique et non sémantique.

placeId

string

PlaceID du lieu vers lequel est géocodé cette entrée.

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

placeTypes[]

string

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

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

Les plus codes (http://plus.codes) sont des références de lieu disponibles en deux formats: un code global définissant un rectangle de 14 x 14 m (1/8 000 degrés) ou un rectangle plus petit, et un code composé, qui remplace le préfixe par un emplacement de référence.

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

string

Code global (complet) du lieu, tel que "9FWM33GV+HQ", représentant une zone de 1/8 000 x 1/8 000 degrés (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 remplacé par le nom formaté d'une entité de référence.

Fenêtre d'affichage

Une 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 zone fermée, c'est-à-dire qu'elle inclut ses limites. Les limites de latitude doivent être comprises entre -90 et 90 degrés inclus, et les limites de longitude doivent être comprises entre -180 et 180 degrés inclus. Différents cas sont possibles:

  • Si low = high, la fenêtre d'affichage se compose de ce point unique.

  • 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 longitude est vide.

  • Si low.latitude > high.latitude, la plage de latitudes 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 indiqué dans les définitions ci-dessus). Une fenêtre d'affichage vide génère une erreur.

Par exemple, la fenêtre d'affichage suivante inclut 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 le champ 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, la valeur est inconnue.

poBox

boolean

Indique l'adresse d'une boîte postale. Si cette règle n'est pas configurée, 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, la valeur est inconnue.

UspsData

Données USPS pour l'adresse. Il n'est pas garanti que le champ uspsData soit entièrement renseigné pour toutes les adresses américaines ou publiques envoyées à l'API Address Validation. Il est recommandé d'intégrer les champs d'adresse de secours dans la réponse si vous utilisez uspsData comme partie principale de la réponse.

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 de point de livraison à deux chiffres

deliveryPointCheckDigit

string

Chiffre de contrôle du point de livraison. Ce numéro est ajouté à la fin de "delivery_point_barcode" pour les courriers scannés mécaniquement. En additionnant tous les chiffres de l'élément delivery_point_barcode, deliveryPointCheckDigit, du code postal et du ZIP+4, vous devriez obtenir un nombre divisible par 10.

dpvConfirmation

string

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

  • N: la confirmation du DPV n'a pas abouti à toutes les informations du numéro principal et des numéros secondaires.
  • D: l'adresse a été confirmée par la DPV uniquement pour le numéro principal, et il manquait le numéro secondaire.
  • S: l'adresse a été confirmée par la DPV uniquement pour le numéro principal, et les informations sur le numéro secondaire étaient présentes, mais n'ont pas été confirmées.
  • Y: l'adresse a été confirmée par la DPV pour le numéro principal et les numéros secondaires.
  • Vide: si la réponse ne contient pas de valeur dpvConfirmation, 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 regroupées au sein d'une même chaîne.

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

string

Indique si l'adresse est une agence de réception de courrier commercial (CMRA), c'est-à-dire une entreprise privée recevant du courrier pour des clients. Renvoie un seul caractère.

  • Y: il s'agit d'une adresse CMRA
  • N: l'adresse n'est pas une CMRA
dpvVacant

string

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

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

string

S'agit-il d'une adresse inactive ou active ? Aucune adresse statistique n'est occupée en continu ou n'est pas desservie 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 NoStat. Renvoie un code de motif sous la forme d'un entier.

  • 1 : IDA (adresse de dépôt interne) : adresses qui ne reçoivent pas de courrier directement de l'USPS, mais qui sont livrées à une adresse de dépôt qui les dessert.
  • 2: CDS - Adresses qui ne sont pas encore livrables Par exemple, une nouvelle subdivision où les lots et les numéros principaux ont été déterminés, mais qu'il n'existe pas encore de structure pour l'occupation.
  • 3: Collision – Adresses qui ne confirment pas réellement la DPV.
  • 4 : CMZ (College, Military and Other Types) : code postal et 4 enregistrements que l'USPS a intégrés aux données.
  • 5 : Normal : indique que les adresses ne reçoivent pas de livraison et qu'elles ne sont pas comptabilisées comme des livraisons possibles.
  • 6: Secondaire obligatoire - L'adresse nécessite des informations secondaires.
dpvDrop

string

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

  • Y: le message est distribué à un seul destinataire sur un site.
  • N: le message n'est pas distribué à un seul destinataire 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 la distribution des e-mails 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 n'indique 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 de non-livraison 0x20 – Lundi est un jour de non-livraison 0x10 – Mardi est un jour de non-livraison 0x08 – Mercredi est un jour de non-livraison 0x04 – Le jeudi est un jour de non-livraison 0x02 – Samedi est un jour de non-livraison 0x02 – Samedi est un jour de non-livraison 0x02

dpvNoSecureLocation

string

Le drapeau indique que la porte est accessible, mais qu'aucun colis ne sera déposé 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 n'indique 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

Un drapeau indique une adresse où USPS ne peut pas frapper à la porte pour livrer du courrier. Renvoie un seul caractère.

  • Y: la porte n'est pas accessible.
  • N: rien n'indique que la porte n'est pas accessible.
dpvEnhancedDeliveryCode

string

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

  • Y: l'adresse a été confirmée par la DPV pour le numéro principal et les numéros secondaires.
  • N: la confirmation du DPV n'a pas abouti à toutes les informations du numéro principal et des numéros secondaires.
  • S: l'adresse a été confirmée par la DPV uniquement pour le numéro principal, et les informations sur le numéro secondaire étaient présentes via non confirmé, ou une seule valeur alpha finale à la fin d'un numéro principal a été supprimée afin de rendre une correspondance DPV et des informations secondaires requises.
  • D: l'adresse a été confirmée par la DPV uniquement pour le numéro principal, et il manquait le numéro secondaire.
  • R: adresse confirmée, mais attribuée aux routes fantômes R777 et R779, et la livraison USPS n'est pas fournie.
carrierRoute

string

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

Préfixes:

  • C: itinéraire du transporteur (ou itinéraire en ville)
  • R: route rurale
  • H: voie sous contrat
  • B: section des boîtes postales
  • G: unité de diffusion générale
carrierRouteIndicator

string

Indicateur de tri des tarifs d'itinéraire 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 ligne de transport amélioré (eLOT).

elotFlag

string

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

poBoxOnlyPostalCode

boolean

Code postal de la boîte postale uniquement.

pmbDesignator

string

Indicateur de boîte aux lettres privée.

pmbNumber

string

Numéro de boîte aux lettres privée (PMB, Private Mail Box)

addressRecordType

string

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

  • F: FIRM. Il s'agit d'une correspondance avec un enregistrement ferme, 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 diffusion générale.
  • H: Bâtiment / Appartement Il s'agit d'une correspondance avec la fiche d'un bâtiment ou d'un appartement.
  • P: POSTE BUREAU. Il s'agit d'une correspondance avec une boîte postale.
  • R: ITINÉRAIRE RURAL ou CONTRAT DE ROUTE: il s'agit d'une correspondance avec un enregistrement de route rurale ou de contrat d'autoroute, qui peuvent tous deux être associés à des plages de numéros de carton.
  • S: STREET RECORD: il s'agit d'une correspondance avec un dossier Street Record contenant une plage de numéros principaux valides.
defaultAddress

boolean

Indicateur indiquant 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 confirmant que la demande a été traitée par 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 de l'urbanisation portoricaine.

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, par exemple 5023