Package google.type

Index

Date

Représente une date du calendrier entière ou partielle, par exemple un anniversaire. L'heure de la journée et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. La date correspond au calendrier grégorien proleptique. Il peut s'agir de l'un des éléments suivants :

  • Une date complète, avec des valeurs non nulles pour l'année, le mois et le jour.
  • Un mois et un jour, avec une année nulle (par exemple, un anniversaire).
  • Une année seule, avec un mois et un jour nuls.
  • Une année et un mois, avec un jour zéro (par exemple, la date d'expiration d'une carte de crédit).

Types associés :

Champs
year

int32

Année de la date. Elle doit être comprise entre 1 et 9 999, ou égale à 0 si vous spécifiez une date sans année.
month

int32

Mois d'une année. Il doit être compris entre 1 et 12, ou égal à 0 si vous spécifiez une année sans mois ni jour.
day

int32

Jour du mois. Il doit être compris entre 1 et 31, et valide pour l'année et le mois, ou égal à 0 si vous spécifiez une année seule, ou une année et un mois où le jour n'est pas significatif.

DayOfWeek

Représente un jour de la semaine.

Enums
DAY_OF_WEEK_UNSPECIFIED Le jour de la semaine n'est pas spécifié.
MONDAY Lundi
TUESDAY Mardi
WEDNESDAY Mercredi
THURSDAY Jeudi
FRIDAY Vendredi
SATURDAY Samedi
SUNDAY Dimanche

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 ou la modification d'adresses : utilisez un widget d'adresse compatible avec 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 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.

Champs
revision

int32

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

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

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".
postal_code

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).
sorting_code

string

Facultatif. Code de tri supplémentaire, spécifique à chaque pays. La plupart des régions ne s'en servent pas. Lorsqu'elle est utilisée, la valeur est soit une chaîne de caractères telle que "CEDEX", éventuellement suivie d'un nombre (par exemple, "CEDEX 7"), soit 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).
administrative_area

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, 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 locality vide et utilisez address_lines.
sublocality

string

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

string

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

Étant donné que les valeurs dans address_lines 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 d'une adresse consiste en un region_code avec toutes les informations restantes placées dans le address_lines. 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.

Créer une adresse contenant uniquement un region_code et un address_lines 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.

TimeOfDay

Représente une heure de la journée. La date et le fuseau horaire sont spécifiés ailleurs, ou ne sont pas significatifs. Une API peut choisir d'autoriser des secondes intercalaires. Les types associés sont google.type.Date et google.protobuf.Timestamp.

Champs
hours

int32

Heures de la journée au format 24 heures. Doit être supérieur ou égal à 0 et généralement inférieur ou égal à 23. Une API peut choisir d'autoriser la valeur "24:00:00" pour des cas tels que l'heure de fermeture des bureaux.
minutes

int32

Minutes d'une heure. Doit être supérieur ou égal à 0 et inférieur ou égal à 59.
seconds

int32

Secondes d'une minute. Doit être supérieur ou égal à 0 et généralement inférieur ou égal à 59. Une API peut autoriser la valeur 60 si elle autorise les secondes intercalaires.
nanos

int32

Fractions de secondes, en nanosecondes. La valeur doit être supérieure ou égale à 0 et inférieure ou égale à 999 999 999.

TimeZone

Représente un fuseau horaire de la base de données des fuseaux horaires IANA.

Champs
id

string

Fuseau horaire de la base de données des fuseaux horaires IANA. Par exemple, "America/New_York".
version

string

Facultatif. Numéro de version de la base de données des fuseaux horaires IANA. Par exemple, "2019a".