Obtenir les paramètres régionaux et le fuseau horaire d'un utilisateur du module complémentaire Google Workspace

Ce guide explique comment un module complémentaire peut obtenir les paramètres régionaux et le fuseau horaire d'un utilisateur, puis utiliser ces informations pour personnaliser son interface et son comportement. Pour un guide spécifique à Google Apps Script, consultez la section Obtenir les paramètres régionaux et le fuseau horaire de l'utilisateur dans la documentation d'Apps Script pour les développeurs.

Configurer la ressource de déploiement du module complémentaire

Pour autoriser un module complémentaire à obtenir les paramètres régionaux et le fuseau horaire d'un utilisateur, configurez sa ressource de déploiement:

  1. Dans la ressource de déploiement du module complémentaire, définissez le champ addOns.common.useLocaleFromApp sur true.
  2. Ajoutez le champ d'application d'autorisation https://www.googleapis.com/auth/script.locale à la liste oauthScopes de la ressource de déploiement. Ce champ d'application accorde au module complémentaire l'autorisation de l'utilisateur d'afficher son pays, sa langue et son fuseau horaire.
  3. Enregistrez la ressource de déploiement mise à jour.

Après avoir ajouté un champ d'application à la liste oauthScopes du module complémentaire, les utilisateurs doivent à nouveau autoriser ce module la prochaine fois qu'ils l'utilisent.

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

Les objets événement incluent des informations sur les paramètres régionaux de l'utilisateur, que vous pouvez obtenir à partir des propriétés commonEventObject suivantes:

  • commonEventObject.userLocale : langue et identifiant du pays ou de la région de l'utilisateur. Par exemple, en-US représente la langue anglaise parlée aux États-Unis.
  • commonEventObject.timeZone.offset : décalage horaire de l'utilisateur, en millisecondes, à partir du 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.

Les objets d'événement sont transmis aux fonctions de rappel action, homepageTrigger et contextualTrigger lorsque l'utilisateur interagit avec le module complémentaire en cliquant, par exemple, sur un bouton. Chaque fonction de rappel ou de déclencheur peut obtenir les informations sur les paramètres régionaux et les fuseaux horaires à partir des objets d'événement, et les utiliser si nécessaire. Par exemple, une fonction de rappel qui accède à une nouvelle fiche peut se référer à la chaîne de paramètres régionaux pour décider du texte à ajouter à la fiche.