Accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur

Les modules complémentaires peuvent accéder aux paramètres régionaux et au fuseau horaire de l'utilisateur, et utiliser ces informations pour personnaliser son interface et son comportement. Vous devez configurer le fichier manifeste de votre module complémentaire pour qu'il puisse accéder à ces informations.

Configurer le fichier manifeste du module complémentaire

Vous pouvez configurer votre module complémentaire pour accéder aux informations sur les paramètres régionaux et les fuseaux horaires de l'utilisateur en procédant comme suit:

  1. Dans le fichier manifest de votre module complémentaire, définissez le champ addOns.common.useLocaleFromApp sur true.
  2. S'il n'est pas déjà présent, ajoutez le champ d'application explicite suivant dans la liste oauthScopes du fichier manifeste : https://www.googleapis.com/auth/script.locale
  3. Enregistrez les modifications apportées au fichier manifeste.

Si vous avez ajouté un champ d'application à la liste oauthScope du module complémentaire, les utilisateurs doivent réautoriser ce module lors de sa prochaine ouverture.

Obtenir des informations sur les paramètres régionaux et les fuseaux horaires

Les objets d'événement contiennent des informations sur les paramètres régionaux de l'utilisateur lorsqu'ils sont correctement configurés. Les champs suivants apparaissent dans la sous-structure commonEventObject de l'objet événement:

  • commonEventObject.userLocale : identifiant de langue et de pays/région de l'utilisateur. Exemple : en-US.
  • commonEventObject.timeZone.offset : décalage horaire de l'utilisateur, en millisecondes, par rapport au temps universel coordonné (UTC).
  • commonEventObject.timeZone.id : identifiant de fuseau horaire de l'utilisateur. Exemple : America/New_York.
  • commonEventObject.timeZone : ID et décalage de fuseau horaire de l'utilisateur.

Pour en savoir plus, consultez la section Objets d'événement.

Les objets d'événement sont transmis aux fonctions de rappel d'action lorsque l'utilisateur interagit avec votre module complémentaire, ainsi qu'aux fonctions de page d'accueil et de déclencheur contextuel. Chaque fonction de rappel ou de déclencheur peut lire les informations sur les paramètres régionaux et les fuseaux horaires à partir de l'objet événement, et les utiliser si nécessaire. Par exemple, une fonction de rappel qui accède à une nouvelle carte peut se référer à la chaîne de paramètres régionaux pour décider du texte à ajouter à la fiche.