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)
  }
}
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 sera 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 requête de validation d'adresse. Si davantage de requêtes sont nécessaires pour valider entièrement une seule adresse (par exemple, si les modifications apportées par l'utilisateur après la validation initiale doivent être de nouveau validées), chaque demande de suivi doit renseigner ce champ avec l'attribut responseId dès la première réponse de la séquence de validation.

enableUspsCass

boolean

Active le mode compatible avec USPS CASS. Cela concerne uniquement le champ google.maps.addressvalidation.v1.ValidationResult.usps_data de google.maps.addressvalidation.v1.ValidationResult. Remarque: Pour les demandes pour des adresses à Porto Rico utilisant USPS CASS, un google.type.PostalAddress.region_code de address doit être indiqué en tant que "PR", ou un google.type.PostalAddress.administrative_area de address doit être fourni avec "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 google.type.PostalAddress.address_lines où la première ligne contient le numéro et le nom de la rue, et la deuxième ligne la ville, l'État et le code postal.

languageOptions

object (LanguageOptions)

Facultatif. Aperçu: cette fonctionnalité est en phase de preview (pré-DG). La prise en charge des fonctionnalités et produits pré-DG peut être limitée, et il est possible que les modifications apportées à ces fonctionnalités et 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.

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 de 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 et la modification d'adresses : utilisez un widget d'adresse compatible avec l'internationalisation, tel que https://github.com/google/libaddressinput. Les éléments d'interface utilisateur ne doivent pas leur être présentés pour saisir ou 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înera 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 régional 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 pas à nouveau le code de la région dans ce champ. Pour en savoir plus sur les régions acceptées, consultez les questions fréquentes.

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" ne contiennent pas d'informations de type et peuvent parfois contenir plusieurs valeurs dans un même 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 est constituée de toutes les informations placées dans le addressLines. Si aucun élément regionCode n'est fourni, la région est déduite des lignes d'adresse.

La création d'une adresse contenant uniquement addressLines, suivie du geocoding, est la méthode recommandée pour gérer 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 éviter de définir ce champ. L'API Address Validation ne l'utilise pas actuellement. Bien qu'à ce stade, l'API ne refuse pas les requêtes avec ce champ défini, les informations seront ignoré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 qu'à ce stade, l'API ne refuse pas les requêtes avec ce champ défini, les informations seront ignorées et ne seront pas renvoyées dans la réponse.

Options de langue

Aperçu: cette fonctionnalité est en phase de preview (pré-DG). La prise en charge des fonctionnalités et produits pré-DG peut être limitée, et il est possible que les modifications apportées à ces fonctionnalités et 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 global

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 correspondant à l'adresse géocodée.

metadata

object (AddressMetadata)

Autres informations pertinentes pour la livrable. 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 prise en charge des fonctionnalités et produits pré-DG peut être limitée, et il est possible que les modifications apportées à ces fonctionnalités et produits ne soient pas compatibles avec d'autres versions pré-DG. Les offres en pré-DG sont couvertes par les Conditions spécifiques du service Google Maps Platform. Pour en savoir plus, consultez les descriptions des étapes de lancement.

Adresse traduite en anglais. Si une partie de l'adresse n'est pas traduite en anglais, le service l'affiche dans une autre langue utilisant des caractères latins. Pour savoir comment l'autre langue est sélectionnée, cliquez ici. Si une partie de l'adresse ne comporte pas de traduction ni de translittération dans une langue utilisant l'alphabet latin, le service l'affiche dans la langue locale associée à l'adresse.

Vous avez activé ce résultat à l'aide de l'option google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Remarque: Le champ google.maps.addressvalidation.v1.Address.unconfirmed_component_types de englishLatinAddress et le champ google.maps.addressvalidation.v1.AddressComponent.confirmation_level de englishLatinAddress.address_components ne sont pas renseignés.

Verdict

Vue d'ensemble 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 en savoir plus sur les signaux de validation, consultez 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 faire correspondre le numéro d'appartement dans les bases de données, ou si le numéro d'appartement n'est pas valide, validationGranularity sera probablement PREMISE ou inférieur.

validationGranularity

enum (Granularity)

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

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

geocodeGranularity

enum (Granularity)

Informations sur la précision de geocode. Il s'agit de la signification sémantique du degré de précision du lieu géocodé.

Il peut parfois être différent du validationGranularity ci-dessus. Par exemple, notre base de données peut enregistrer l'existence d'un numéro d'appartement, mais l'emplacement précis de l'appartement dans un grand immeuble n'est pas précisé. 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 être ni catégorisé, 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

Il s'agit des différents niveaux de précision d'une adresse ou d'un géocode. Lorsqu'elles sont utilisées pour indiquer le niveau de précision d'une adresse, ces valeurs indiquent le degré de précision de l'adresse pour identifier une destination d'envoi. Par exemple, une adresse telle que "123 Main Street, Redwood City, CA, 94061" identifie un PREMISE, tandis que "Redwood City, CA, 94061" identifie un LOCALITY. Toutefois, si nous ne parvenons pas à trouver le géocode du "123 Main Street" à Redwood City, il est possible que le géocode renvoyé soit avec une précision de LOCALITY, même si l'adresse est plus précise.

Enums
GRANULARITY_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
SUB_PREMISE Résultat situé en dessous du bâtiment, par exemple un appartement.
PREMISE Résultat au niveau du bâtiment.
PREMISE_PROXIMITY Géocode qui correspond approximativement à l'emplacement de l'adresse au niveau du bâtiment.
BLOCK L'adresse ou le géocode indiquent un pâté de maisons. Utilisé uniquement dans les régions disposant d'adresses au niveau du bloc, telles que le Japon.
ROUTE Le géocode ou l'adresse sont granulaires pour l'itinéraire, comme une rue, une route ou une autoroute.
OTHER Toutes les autres niveaux de précision, qui sont regroupés puisqu'ils ne peuvent pas être livrés.

Adresse

Détails de l'adresse post-traitée. Le post-traitement comprend la correction des parties mal orthographiées de l'adresse, le remplacement des éléments incorrects et la déduction des éléments manquants.

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

string

Adresse post-traitée, présentée sous la forme d'une adresse sur une seule ligne, conformément aux règles de mise en forme de la région dans laquelle se trouve l'adresse.

postalAddress

object (PostalAddress)

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

addressComponents[]

object (AddressComponent)

Liste à puces. Les composants d'adresse individuelle de l'adresse formatée et corrigée, ainsi que les informations de validation. Vous obtenez ainsi des informations sur l'état de validation de chaque composant.

Les composants d'adresse ne sont pas ordonnés d'une manière particulière. Ne faites aucune hypothèse concernant l'ordre des composants d'adresse dans la liste.

missingComponentTypes[]

string

Les types de composants qui étaient censés être présents dans une adresse postale correctement formatée, mais qui sont introuvables dans l'entrée ET qui n'ont pas pu être déduits. Les composants de ce type ne sont pas présents dans 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 le fichier 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 afin de trouver les types de tous les composants pour lesquels confirmationLevel n'est pas CONFIRMED ou que l'indicateur inferred n'est pas défini sur true. Pour consulter la liste des types possibles, cliquez ici.

unresolvedTokens[]

string

Jetons de l'entrée qui n'ont pas pu être résolus. Il peut s'agir d'une entrée qui n'a pas été reconnue comme une partie valide d'une adresse (par exemple, dans une entrée comme "123235253253 Main St, San Francisco, CA, 94105"), les jetons non résolus peuvent ressembler à ["123235253253"], car il ne s'agit pas d'un numéro de rue valide.

Composant 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 niveau de certitude dont nous disposons 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'une variante orthographique à une autre, comme lorsque vous remplacez "centre" par "centre". Par ailleurs, il ne signale pas toujours les fautes d'orthographe courantes, comme lorsque vous remplacez "Amphitheater Pkwy" par "Amphitheatre Pkwy".

replaced

boolean

Indique que le nom de l'élément a été remplacé par un nom complètement différent (par exemple, un code postal incorrect ayant été remplacé par un nom correspondant à l'adresse). Il ne s'agit pas d'une modification esthétique. Le composant d'entrée a été remplacé par un autre.

unexpected

boolean

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

NomComposant

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. Ce champ est absent si le nom du composant n'est pas associé à une langue, comme un numéro de rue.

Niveau de confirmation

Différentes valeurs possibles pour les niveaux de confirmation.

Enums
CONFIRMATION_LEVEL_UNSPECIFIED Valeur par défaut. Cette valeur n'est pas utilisée.
CONFIRMED Nous avons pu vérifier que ce composant existe et qu'il est pertinent par rapport au reste de l'adresse.
UNCONFIRMED_BUT_PLAUSIBLE Ce composant n'a pas pu être confirmé, mais il est possible qu'il existe. Par exemple, il peut s'agir d'un numéro compris dans une plage de numéros valide et connue, pour une rue où des numéros de maison spécifiques ne sont pas connus.
UNCONFIRMED_AND_SUSPICIOUS Ce composant n'a pas été confirmé et est probablement incorrect. (un quartier qui ne correspond pas au reste de l'adresse, par exemple).

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)

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

Il est préférable d'utiliser des ID de lieu plutôt que des adresses, des coordonnées de latitude/longitude ou des plus codes. Si vous utilisez des coordonnées lors d'un calcul d'itinéraire, le point est systématiquement aligné sur la route la plus proche de ces coordonnées. Il est possible qu'il ne s'agisse pas d'une route qui mène à la destination de manière rapide ou sûre, ni à proximité d'un point d'accès à la propriété. En outre, lorsqu'un lieu est géocodé inverse, rien ne garantit que l'adresse renvoyée correspondra à l'adresse d'origine.

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 précision du lieu géocodé, mais en taille physique et non sémantique.

placeId

string

ID de lieu du lieu vers lequel cette entrée géocode.

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

placeTypes[]

string

Type(s) de lieu pour 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

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

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/8000 x 1/8000 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 le remplaçant par le nom formaté 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 en diagonale opposés. Une fenêtre d'affichage est considérée comme une région 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. Voici différents cas de figure:

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

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

Vous devez renseigner les champs low et high, 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, cette fenêtre d'affichage 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 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'un établissement. Si cette valeur n'est pas définie, cela signifie que la valeur est inconnue.

poBox

boolean

Indique l'adresse d'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 le champ uspsData soit entièrement renseigné pour toutes les adresses aux États-Unis ou aux relations publiques envoyées à l'API Address Validation. Il est recommandé d'intégrer les champs d'adresse de secours dans la réponse si vous utilisez uspsData comme partie principale de la réponse.

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

object (UspsAddress)

Adresse standardisée USPS.

deliveryPointCode

string

Code du 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 messages scannés automatiquement. En additionnant tous les chiffres de "delivery_point_barcode", "deliveryPointCheckDigit", du code postal et du code postal (ZIP+4), vous obtiendrez un nombre divisible par 10.

dpvConfirmation

string

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

  • Y: l'adresse a été validée pour le numéro principal et les numéros secondaires.
  • N: la confirmation du numéro principal et des numéros secondaires n'a pas pu être confirmée par le DPV.
  • S: l'adresse a été validée par le biais de la DPV uniquement pour le numéro principal, et le numéro secondaire était présent, mais n'a pas été confirmé.
  • D: l'adresse a été validée par le biais de la DPV uniquement pour le numéro principal, et le numéro secondaire était manquant.
dpvFootnote

string

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

  • 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: en correspondance avec DPV (tous les composants)
  • CC: numéro secondaire sans correspondance (présent, mais non valide)
  • N1: numéro secondaire manquant dans l'adresse du gratte-ciel
  • M1: numéro principal manquant
  • M3: numéro principal non valide
  • P1: adresse d'entrée RR ou numéro de boîte du centre d'aide manquant
  • P3: saisissez le numéro de boîte du bon de commande, du numéro de carte RR ou du centre d'aide non valide
  • F1: adresse saisie correspondant à une adresse militaire
  • G1: adresse saisie mise en correspondance avec 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 DPV avec les informations du PMB
  • R1: adresse confirmée par DPV sans informations sur le PMB
  • R7: enregistrement de l'itinéraire R777 ou R779 du transporteur
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 ses clients. Renvoie un seul caractère.

  • Y: l'adresse est un CMRA
  • N: l'adresse n'est pas un 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 une adresse non desservie par l'USPS. Renvoie un seul caractère.

  • Y: l'adresse n'est pas active
  • N: l'adresse est active
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 urbain)
  • R: route rurale
  • H: route couverte par le contrat d'autoroute
  • B: section "Post Office Box" (Boîte postale)
  • G: unité de livraison générale
carrierRouteIndicator

string

Indicateur de tri du tarif de l'itinéraire du transporteur.

ewsNoMatch

boolean

Il est possible d'établir une correspondance pour l'adresse de livraison, mais le fichier EWS indique qu'une correspondance exacte sera bientôt disponible.

postOfficeCity

string

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

Boîte postale uniquement.

pmbDesignator

string

Désignateur 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 ferme, c'est-à-dire 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 livraison générale.
  • H: BUILDING / APARTMENT. Il s'agit d'une correspondance avec l'enregistrement d'un bâtiment ou d'un appartement.
  • P: BOÎTE POSTE. Cela correspond à une boîte postale.
  • R : ROUTE ROUTE ou CONTRACT ACCORDÉ
  • S: STREET RECORD: il s'agit d'une correspondance avec un enregistrement de rue contenant une plage de numéros principaux 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 la société.

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.