- Requête HTTP
- Corps de la requête
- Corps de la réponse
- PostalAddress
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- LanguageOptions
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ValidationResult
- Verdict
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Précision
- Adresse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- AddressComponent
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ComponentName
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ConfirmationLevel
- Géocode
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- LatLng
- PlusCode
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Fenêtre d'affichage
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- AddressMetadata
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- UspsData
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- UspsAddress
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
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 ( |
Champs | |
---|---|
address |
Obligatoire. Adresse en cours de validation. Les adresses non formatées doivent être envoyées via 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 L'API Address Validation ignore les valeurs dans |
previousResponseId |
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' |
enableUspsCass |
Active le mode compatible USPS CASS. Cela n'affecte que le champ Nous vous recommandons d'utiliser une propriété |
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 |
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 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 ( |
Champs | |
---|---|
result |
Résultat de la validation de l'adresse. |
responseId |
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 |
Révision du schéma de |
regionCode |
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 |
languageCode |
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 |
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 |
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 |
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 |
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 |
Facultatif. Sous-localité de l'adresse. Il peut s'agir, par exemple, de quartiers, d'arrondissements ou de districts. |
addressLines[] |
Obligatoire. Lignes d'adresse non structurées décrivant les niveaux inférieurs d'une adresse. |
recipients[] |
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 |
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 |
Aperçu: Renvoyez un |
ValidationResult
Résultat de la validation d'une adresse.
Représentation JSON |
---|
{ "verdict": { object ( |
Champs | |
---|---|
verdict |
Options de verdict globales |
address |
Informations sur l'adresse elle-même, par opposition au géocode. |
geocode |
Informations sur l'emplacement et le lieu auxquels l'adresse a été géocodée. |
metadata |
Autres informations pertinentes sur la délivrabilité. Il n'est pas garanti que |
uspsData |
Indicateurs de distribution supplémentaires fournis par USPS. Fourni uniquement dans les régions |
englishLatinAddress |
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 Remarque: Le champ |
Verdict
Vue d'ensemble du résultat de la validation de l'adresse et du geocoding
Représentation JSON |
---|
{ "inputGranularity": enum ( |
Champs | |
---|---|
inputGranularity |
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 Par exemple, si l'adresse d'entrée inclut un numéro d'appartement spécifique, |
validationGranularity |
Niveau de précision avec lequel l'API peut entièrement valider l'adresse. Par exemple, une Le résultat de la validation par composant d'adresse est disponible dans |
geocodeGranularity |
Informations sur le niveau de précision de Elle peut parfois différer de la valeur |
addressComplete |
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 |
hasUnconfirmedComponents |
Au moins un composant d'adresse ne peut être ni classé, ni validé. Consultez |
hasInferredComponents |
Au moins un composant d'adresse a été déduit (ajouté) qui ne figurait pas dans l'entrée. Pour en savoir plus, consultez |
hasReplacedComponents |
Au moins un composant d'adresse a été remplacé. Pour en savoir plus, consultez |
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 ( |
Champs | |
---|---|
formattedAddress |
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 |
Adresse post-traitée représentée sous forme d'adresse postale. |
addressComponents[] |
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[] |
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 |
unconfirmedComponentTypes[] |
Types de composants présents dans |
unresolvedTokens[] |
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 à |
AddressComponent
Représente un élément d'adresse, tel qu'une rue, une ville ou un État.
Représentation JSON |
---|
{ "componentName": { object ( |
Champs | |
---|---|
componentName |
Nom de ce composant. |
componentType |
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 |
Indique le degré de certitude que le composant est correct. |
inferred |
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 |
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 |
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 |
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 |
Texte du nom. Exemple : "5e Avenue". pour un nom de rue ou "1253" pour un numéro de rue. |
languageCode |
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 ( |
Champs | |
---|---|
location |
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 |
Plus code correspondant à l'élément |
bounds |
Limites du lieu géocodé. |
featureSizeMeters |
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 |
PlaceID du lieu géocodé par cette entrée. Pour en savoir plus sur les ID de lieu, cliquez ici. |
placeTypes[] |
Type(s) de lieu géocodé(s) par l'entrée. Par exemple, |
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 |
Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0]. |
longitude |
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 |
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 |
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 ethigh.longitude
= 180 degrés, la fenêtre d'affichage inclut toutes les longitudes.Si
low.longitude
= 180 degrés ethigh.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 ( |
Champs | |
---|---|
low |
Obligatoire. Point bas de la fenêtre d'affichage. |
high |
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 |
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 |
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 |
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 ( |
Champs | |
---|---|
standardizedAddress |
adresse normalisée USPS. |
deliveryPointCode |
Code de point de livraison à deux chiffres |
deliveryPointCheckDigit |
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 |
Valeurs possibles pour la confirmation de la DPV. Renvoie un seul caractère ou aucune valeur.
|
dpvFootnote |
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.
|
dpvCmra |
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.
|
dpvVacant |
Ce lieu est-il inoccupé ? Renvoie un seul caractère.
|
dpvNoStat |
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.
|
dpvNoStatReasonCode |
Indique le type de valeur NoStat. Renvoie un code de motif sous la forme d'un entier.
|
dpvDrop |
L'indicateur indique que le courrier est distribué à un seul destinataire sur un site. Renvoie un seul caractère.
|
dpvThrowback |
Indique que le courrier n'est pas distribué à l'adresse postale. Renvoie un seul caractère.
|
dpvNonDeliveryDays |
L'indicateur indique que l'envoi d'e-mails n'est pas effectué tous les jours de la semaine. Renvoie un seul caractère.
|
dpvNonDeliveryDaysValues |
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 |
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.
|
dpvPbsa |
Indique que l'adresse a été mise en correspondance avec un enregistrement PBSA. Renvoie un seul caractère.
|
dpvDoorNotAccessible |
L'indicateur indique les adresses pour lesquelles USPS ne peut pas frapper à la porte pour distribuer du courrier. Renvoie un seul caractère.
|
dpvEnhancedDeliveryCode |
Indique que plusieurs codes DPV renvoyés sont valides pour l'adresse. Renvoie un seul caractère.
|
carrierRoute |
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:
|
carrierRouteIndicator |
Indicateur de tri du tarif de routage du transporteur. |
ewsNoMatch |
L'adresse de livraison peut correspondre, mais le fichier EWS indique qu'une correspondance exacte sera bientôt disponible. |
postOfficeCity |
Ville du bureau de poste principal. |
postOfficeState |
Bureau de poste principal. |
abbreviatedCity |
Ville abrégée. |
fipsCountyCode |
Code de comté FIPS. |
county |
Nom du comté. |
elotNumber |
Numéro eLOT (Enhanced Line of Travel). |
elotFlag |
Indicateur eLOT croissant/décroissant (A/D). |
lacsLinkReturnCode |
Code de retour LACSLink. |
lacsLinkIndicator |
Indicateur LACSLink. |
poBoxOnlyPostalCode |
Code postal de la boîte postale uniquement. |
suitelinkFootnote |
les notes de bas de page, issues de la mise en correspondance d'un enregistrement de rue ou d'un gratte-ciel avec les informations sur l'appartement ; En cas de correspondance du nom d'entreprise, le numéro secondaire est renvoyé.
|
pmbDesignator |
Désignation de la boîte aux lettres privée (PMB) |
pmbNumber |
Numéro de boîte aux lettres privée (PMB) |
addressRecordType |
Type d'enregistrement d'adresse correspondant à l'adresse d'entrée.
|
defaultAddress |
Indicateur spécifiant qu'une adresse par défaut a été trouvée, mais qu'il existe des adresses plus spécifiques. |
errorMessage |
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 |
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 |
Première ligne d'adresse. |
firm |
Nom de l'entreprise. |
secondAddressLine |
Deuxième ligne d'adresse. |
urbanization |
Nom d'urbanisation portoricain |
cityStateZipAddressLine |
Ville + État + code postal. |
city |
Nom de la ville. |
state |
Code d'État à deux lettres. |
zipCode |
Code postal, par exemple 10009. |
zipCodeExtension |
Extension de code postal à quatre chiffres (ex. : 5023. |