Acessar a localidade e o fuso horário de um usuário de complemento do Google Workspace

Neste guia, explicamos como um complemento pode identificar a localidade e o fuso horário de um usuário e usar essas informações para personalizar a interface e o comportamento dele. Para ver um guia específico do Google Apps Script, consulte Ver a localidade e o fuso horário do usuário na documentação do desenvolvedor do Apps Script.

Configurar o recurso de implantação do complemento

Para permitir que um complemento acesse a localidade e o fuso horário de um usuário, configure o recurso de implantação do complemento:

  1. No recurso de implantação do complemento, defina o campo addOns.common.useLocaleFromApp como true.
  2. Adicione o escopo de autorização https://www.googleapis.com/auth/script.locale à lista oauthScopes do recurso de implantação. Esse escopo concede ao complemento a permissão do usuário para conferir o país, o idioma e o fuso horário.
  3. Salve o recurso de implantação atualizado.

Depois de adicionar um escopo à lista oauthScopes do complemento, os usuários precisarão autorizar o complemento novamente na próxima vez.

Receber informações de localidade e fuso horário

Os objetos de evento incluem informações de localidade do usuário, que podem ser encontradas nestas propriedades commonEventObject:

  • commonEventObject.userLocale: o idioma e o identificador de país ou região do usuário. Por exemplo, en-US representa o idioma inglês como falado nos Estados Unidos.
  • commonEventObject.timeZone.offset: a diferença de fuso horário do usuário, em milissegundos, em relação ao Tempo Universal Coordenado (UTC).
  • commonEventObject.timeZone.id: o identificador de fuso horário do usuário. Por exemplo, America/New_York.
  • commonEventObject.timeZone: o ID e o deslocamento do fuso horário do usuário.

Os objetos de evento são transmitidos para as funções de callback action, funções homepageTrigger e contextualTrigger à medida que o usuário interage com o complemento, por exemplo, clicando em um botão. Cada função de callback ou acionador pode receber as informações de localidade e fuso horário dos objetos de evento e usá-las conforme necessário. Por exemplo, uma função de callback que acessa um novo card pode se referir à string de localidade ao decidir qual texto adicionar ao cartão.