Cómo obtener la configuración regional y la zona horaria de un usuario del complemento de Google Workspace

En esta guía, se explica cómo un complemento puede obtener la configuración regional y la zona horaria de un usuario y, luego, usar esa información para personalizar su interfaz y comportamiento. Si quieres obtener una guía específica de Google Apps Script, consulta Cómo obtener la configuración regional y la zona horaria del usuario en la documentación para desarrolladores de Apps Script.

Configura el recurso de implementación del complemento

Para permitir que un complemento obtenga la configuración regional y la zona horaria de un usuario, configura el recurso de implementación del complemento:

  1. En el recurso de implementación del complemento, establece el campo addOns.common.useLocaleFromApp en true.
  2. Agrega el permiso de autorización https://www.googleapis.com/auth/script.locale a la lista oauthScopes del recurso de implementación. Este alcance le otorga al complemento permiso del usuario para ver su país, idioma y zona horaria.
  3. Guarda el recurso de implementación actualizado.

Después de agregar un alcance a la lista oauthScopes del complemento, los usuarios deberán volver a autorizarlo la próxima vez que lo usen.

Cómo obtener información sobre la configuración regional y la zona horaria

Los objetos de evento incluyen información de configuración regional del usuario, que puedes obtener de las siguientes propiedades de commonEventObject:

  • commonEventObject.userLocale: Es el identificador de idioma y país o región del usuario. Por ejemplo, en-US representa el idioma inglés que se habla en los Estados Unidos.
  • commonEventObject.timeZone.offset: El desplazamiento de la zona horaria del usuario, en milisegundos, desde la hora universal coordinada (UTC)
  • commonEventObject.timeZone.id: El identificador de zona horaria del usuario. Por ejemplo, America/New_York.
  • commonEventObject.timeZone: Indica el ID de zona horaria y el desplazamiento del usuario.

Los objetos de evento se pasan a funciones de devolución de llamada action, funciones de homepageTrigger y funciones de contextualTrigger a medida que el usuario interactúa con el complemento, por ejemplo, si hace clic en un botón. Cada función de devolución de llamada o activador puede obtener la información de la configuración regional y la zona horaria de los objetos de evento y usarla según sea necesario. Por ejemplo, una función de devolución de llamada que navega a una tarjeta nueva podría hacer referencia a la cadena de configuración regional para decidir qué texto agregar a la tarjeta.