Obtenir les paramètres régionaux et le fuseau horaire de l'utilisateur

Les modules complémentaires Google Workspace peuvent accéder aux paramètres régionaux et au fuseau horaire de leur utilisateur, et utiliser ces informations pour personnaliser leur interface et leur comportement. Vous devez configurer le fichier manifeste de votre module complémentaire pour lui permettre d'accéder à ces informations.

Configurer le fichier manifeste du module complémentaire

Vous pouvez configurer votre module complémentaire pour qu'il accède aux informations sur les paramètres régionaux et le fuseau horaire de l'utilisateur en procédant comme suit:

  1. Dans le fichier fichier manifeste de votre module complémentaire, définissez le champ addOns.common.useLocaleFromApp sur true.
  2. Si ce n'est pas déjà fait, ajoutez le champ d'application explicite suivant dans la liste oauthScopes du fichier manifeste : https://www.googleapis.com/auth/script.locale

Si vous avez ajouté un champ d'application à la liste oauthScope du module complémentaire, les utilisateurs doivent réautoriser le module complémentaire la prochaine fois qu'il sera ouvert.

Obtenir des informations sur les paramètres régionaux et le fuseau horaire

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 la langue et du pays/région de l'utilisateur. Exemple :en-US
  • commonEventObject.timeZone.offset : décalage du fuseau horaire de l'utilisateur, en millisecondes, par rapport au temps universel coordonné (UTC).
  • commonEventObject.timeZone.id : identifiant du fuseau horaire de l'utilisateur. Exemple :America/New_York
  • commonEventObject.timeZone : ID et décalage du 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 déclencheur de la page d'accueil et de contexte. Chaque fonction de rappel ou de déclencheur peut lire les informations sur les paramètres régionaux et le fuseau horaire de l'objet 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éterminer le texte à ajouter à la fiche.