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

Intervalle

Représente un intervalle de temps, encodé sous la forme d'un code temporel de début (inclusif) et d'un code temporel de fin (exclusif).

La valeur de début doit être inférieure ou égale à celle de fin. Lorsque la valeur de début est la même que la valeur de fin, l'intervalle est vide (il ne correspond à aucune durée). Lorsque les heures de début et de fin ne sont pas spécifiées, l'intervalle couvre toutes les heures.

Champs
start_time

Timestamp

Facultatif. Valeur de début (inclusive) de l'intervalle.

Si elle est spécifiée, un code temporel correspondant à cet intervalle devra être égal ou postérieur à l'heure de début.

end_time

Timestamp

Facultatif. Valeur de fin (exclusive) de l'intervalle.

Si elle est spécifiée, un code temporel correspondant à cet intervalle devra être antérieur à l'heure de fin.

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.

Champs
latitude

double

Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0].

longitude

double

Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0].

Money

Représente un montant associé à un type de devise.

Champs
currency_code

string

Code de la devise à trois lettres défini par la norme ISO 4217.

units

int64

Unités entières du montant. Par exemple, si currencyCode est défini sur "USD", une unité correspond à un dollar américain.

nanos

int32

Nombre de nano-unités (10^-9) du montant. La valeur doit être comprise entre -999 999 999 et +999 999 999 inclus. Si units est positif, nanos doit être positif ou égal à zéro. Si units est égal à zéro, nanos peut être positif, nul ou négatif. Si units est négatif, nanos doit être négatif ou égal à zéro. Par exemple, -1,75 $ est représenté par units=-1 et nanos=-750 000 000.

PostalAddress

Représente une adresse postale, par exemple pour la distribution du courrier ou les adresses de paiement. Une adresse postale permet à un service postal de livrer des articles à un local, une boîte postale ou un emplacement similaire. Une adresse postale n'est pas destinée à modéliser des emplacements géographiques tels que des routes, des villes ou des montagnes.

En général, une adresse est créée par l'utilisateur ou en important des données existantes, selon le type de processus.

Conseils pour saisir ou modifier une adresse :

  • Utilisez un widget d'adresse prêt pour 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ù ces champs sont utilisés.

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

Champs
revision

int32

Révision de 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 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 de codes postaux, mais lorsqu'ils sont utilisés, ils peuvent déclencher une validation supplémentaire avec d'autres parties de l'adresse (par exemple, la validation de l'État ou du 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 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, en Suisse, ce champ doit rester vide.

locality

string

Facultatif. Désigne généralement la partie 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 d'un quartier, d'un arrondissement ou d'un district, par exemple.

address_lines[]

string

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

Étant donné que les valeurs de address_lines ne contiennent pas d'informations sur le 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 d'enveloppe du pays ou de la région de l'adresse. Dans les pays où cela peut varier (par exemple, le Japon), address_language est utilisé pour l'expliciter (par exemple, "ja" pour l'ordre du plus grand au plus petit et "ja-Latn" ou "en" pour l'ordre du plus petit au plus grand). 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 se compose d'un region_code, toutes les informations restantes étant 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.

Pour gérer des adresses complètement non structurées, nous vous recommandons de créer une adresse ne contenant que region_code et address_lines, puis de la géocoder (plutôt que d'essayer de deviner quelles parties de l'adresse doivent être 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 d'une 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. La valeur doit être supérieure ou égale à 0 et inférieure ou égale à 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 de fuseaux horaires IANA. Par exemple, "America/New_York".

version

string

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