PostalAddress

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

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

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

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

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

integer

Révision du schéma de PostalAddress. Il doit être défini sur 0, à savoir la dernière révision.

Toutes les nouvelles révisions doivent être rétrocompatibles avec les anciennes révisions.

regionCode

string

Obligatoire. Code pays/région CLDR de l'adresse. Il n'est jamais déduit, et il revient à l'utilisateur de s'assurer que la valeur est correcte. 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.

languageCode

string

Facultatif. Code de langue BCP-47 du contenu de cette adresse (s'il est connu). Il s'agit souvent de la langue d'UI du formulaire de saisie. Sinon, il doit correspondre à l'une des langues utilisées dans le pays/la région mentionnés dans l'adresse ou leurs équivalents translittérés. Ce champ peut modifier la mise en forme dans certains pays, mais cela ne risque pas de nuire à l'exactitude des données et n'affectera jamais aucune validation ni aucune opération ne concernant pas la mise en forme.

Si cette valeur est inconnue, vous devez l'omettre (plutôt que de spécifier une valeur par défaut éventuellement incorrecte).

Exemples : "zh-Hant", "ja", "ja-Latn" et "en".

postalCode

string

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

sortingCode

string

Facultatif. Code de tri supplémentaire, spécifique à chaque pays. La plupart des régions ne s'en servent pas. Lorsqu'il est utilisé, la valeur est une chaîne telle que "CEDEX", éventuellement suivie d'un nombre (par exemple, "CEDEX 7") ou simplement un nombre seul, représentant le "code de secteur" (Jamaïque), l'"indicateur de zone de livraison" (Malawi) ou l'"indicateur de bureau de poste" (Côte d'Ivoire).

administrativeArea

string

Facultatif. Plus haute subdivision administrative utilisée pour les adresses postales d'un pays ou d'une région. Par exemple, il peut s'agir d'un État, d'une province, d'un oblast ou d'une préfecture. Pour l'Espagne, il s'agit de la province et non de la communauté autonome (par exemple, "Barcelone" et non "Catalogne"). De nombreux pays n'utilisent pas de région administrative dans leurs adresses postales. Par exemple, en Suisse, ce champ doit rester vide.

locality

string

Facultatif. Fait généralement référence à la ville de l'adresse. Exemples : une "city" aux États-Unis, une "comune" en Italie, une "post town" au Royaume-Uni. Dans les régions du monde où les localités ne sont pas bien définies ou ne s'intègrent pas bien dans cette structure, laissez locality vide et utilisez addressLines.

sublocality

string

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

addressLines[]

string

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

Étant donné que les valeurs dans addressLines ne contiennent pas d'informations de type et peuvent parfois comprendre plusieurs valeurs dans un seul champ (par exemple, "Austin, TX"), il est important que l'ordre des lignes soit bien clair. L'ordre des lignes d'adresse doit correspondre à l'ordre suivi sur les enveloppes pour le pays ou la région de l'adresse. Dans les pays où cet ordre peut varier (par exemple, au Japon), address_language est utilisé pour le rendre explicite (par exemple, "ja" pour un ordre décroissant et "ja-Latn" ou "en" pour un ordre croissant). De cette façon, la ligne la plus spécifique d'une adresse peut être sélectionnée en fonction de la langue.

La représentation structurelle minimale autorisée pour une adresse consiste en un regionCode avec toutes les informations restantes placées dans le addressLines. Il serait possible de mettre en forme une telle adresse de manière très approximative sans géocodage, mais aucun raisonnement sémantique ne pourrait être réalisé quant à l'un des composants d'adresse avant qu'il n'ait été au moins partiellement résolu.

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

recipients[]

string

Facultatif. Destinataire. Ce champ peut, dans certaines circonstances, contenir des informations multilignes. Par exemple, il peut comporter la ligne "chez".

organization

string

Facultatif. Nom de l'entreprise.