A classe Sessão fornece acesso a informações da sessão, como o endereço de e-mail do usuário (em em algumas circunstâncias) e a configuração de idioma.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getActiveUser() | User | Recebe informações sobre o usuário atual. |
getActiveUserLocale() | String | Recebe a configuração de idioma do usuário atual como uma string. Por exemplo, en para inglês. |
getEffectiveUser() | User | Extrai informações sobre o usuário sob a qual autoridade o script está sendo executado. |
getScriptTimeZone() | String | Recebe o fuso horário do script. |
getTemporaryActiveUserKey() | String | Recebe uma chave temporária exclusiva para o usuário ativo, mas não revela a identidade do usuário. |
Documentação detalhada
getActiveUser()
Recebe informações sobre o usuário atual. Se as políticas de segurança não permitirem o acesso à conta do usuário,
identidade, User.getEmail()
retorna uma string em branco. As circunstâncias em que o
disponíveis variam: por exemplo, o endereço de e-mail do usuário não está disponível
Contexto que permite que um script seja executado sem a autorização do usuário, como um simples gatilho onOpen(e)
ou onEdit(e)
, uma função personalizada nas Planilhas Google ou um app da Web
implantado para "executar como eu" (ou seja, com autorização do desenvolvedor, e não do usuário).
No entanto, essas restrições geralmente não se aplicam quando o próprio desenvolvedor executa o script.
ou pertencem ao mesmo domínio do Google Workspace que o usuário.
// Log the email address of the person running the script. var email = Session.getActiveUser().getEmail(); Logger.log(email);
Retornar
User
: o usuário atual
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/userinfo.email
getActiveUserLocale()
Recebe a configuração de idioma do usuário atual como uma string. Por exemplo, en
para inglês.
// Log the language setting of the person running the script. Logger.log(Session.getActiveUserLocale());
Retornar
String
: uma string que representa a configuração de idioma do usuário.
getEffectiveUser()
Extrai informações sobre o usuário sob a qual autoridade o script está sendo executado. Se o script for uma
app da Web definido como "executar como eu" (o desenvolvedor), retorna a conta de usuário do desenvolvedor. Se
o script está sendo executado em um ambiente instalado
acionador, retorna a conta do usuário que criou o acionador. Na maioria dos outros
cenários, isso retornará a mesma conta que getActiveUser()
.
// Log the email address of the user under whose authority the script is running. var email = Session.getEffectiveUser().getEmail(); Logger.log(email);
Retornar
User
: o usuário sob a autoridade do script que está sendo executado.
Autorização
Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:
-
https://www.googleapis.com/auth/userinfo.email
getScriptTimeZone()
Recebe o fuso horário do script. Os novos scripts usam como padrão o fuso horário do proprietário, mas o o fuso horário do seu script pode ser alterado clicando em Arquivo > Propriedades do projeto no script editor. As planilhas têm um fuso horário separado, que pode ser alterado clicando Arquivo > Configurações das planilhas no Planilhas Google. Fusos horários da planilha que são diferentes dos fuso horário do script são uma fonte frequente de bugs de script.
// Log the time zone of the script. var timeZone = Session.getScriptTimeZone(); Logger.log(timeZone);
Retornar
String
: o fuso horário do script
getTemporaryActiveUserKey()
Recebe uma chave temporária exclusiva para o usuário ativo, mas não revela a identidade do usuário. A chave temporária é alternada a cada 30 dias e é exclusiva para o script.
// Log the temporary key of the person running the script. Logger.log(Session.getTemporaryActiveUserKey());
Retornar
String
: a chave de usuário ativa temporária