Class User
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Usuário
Representação de um usuário, adequada para programação.
Métodos
Método | Tipo de retorno | Breve descrição |
getEmail() | String | Retorna o endereço de e-mail do usuário, se disponível. |
Métodos obsoletos
Método | Tipo de retorno | Breve descrição |
getUserLoginId()
| String | Retorna o endereço de e-mail do usuário. |
Documentação detalhada
getEmail()
Retorna o endereço de e-mail do usuário, se disponível. Se as políticas de segurança não permitirem o acesso ao
endereço de e-mail do usuário, esse método retornará uma string em branco. As circunstâncias em que o endereço de e-mail está disponível variam: por exemplo, o endereço de e-mail do usuário não está disponível em nenhum contexto que permita a execução de um script sem a autorização do usuário, como um acionador onOpen(e)
ou onEdit(e)
simples, uma função personalizada no Planilhas Google ou um app da Web implantado para "executar como eu", ou seja, autorizado pelo desenvolvedor em vez do usuário.
No entanto, essas restrições geralmente não se aplicam se o desenvolvedor executa o script
ou pertence ao mesmo domínio do Google Workspace que o usuário.
// Log the email address of the person running the script.
Logger.log(Session.getActiveUser().getEmail());
Retornar
String
: o endereço de e-mail do usuário ou uma string em branco se as políticas de segurança não permitirem o acesso
ao endereço de e-mail do usuário.
Métodos obsoletos
getUserLoginId()
Obsoleto. Substituído por getEmail()
em 24 de junho de 2013.
Retorna o endereço de e-mail do usuário.
// Log the email address of the person running the script.
Logger.log(Session.getActiveUser().getUserLoginId());
Retornar
String
: o endereço de e-mail do usuário.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003eRepresents a user for scripting purposes, providing methods to access user information.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetEmail()\u003c/code\u003e retrieves the user's email address if permitted by security policies, returning a blank string otherwise.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003egetUserLoginId()\u003c/code\u003e is deprecated and replaced by \u003ccode\u003egetEmail()\u003c/code\u003e for retrieving the user's email address.\u003c/p\u003e\n"],["\u003cp\u003eAccess to the user's email address might be restricted in certain contexts due to security considerations, such as unauthorized script execution.\u003c/p\u003e\n"]]],[],null,["# Class User\n\nUser\n\nRepresentation of a user, suitable for scripting. \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------|-------------|----------------------------------------------|\n| [getEmail()](#getEmail()) | `String` | Gets the user's email address, if available. |\n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|---------------------------------------|-------------|--------------------------------|\n| [getUserLoginId()](#getUserLoginId()) | `String` | Gets the user's email address. |\n\nDetailed documentation\n----------------------\n\n### `get``Email()`\n\nGets the user's email address, if available. If security policies do not allow access to the\nuser's email address, this method returns a blank string. The circumstances in which the email\naddress is available vary: for example, the user's email address is not available in any\ncontext that allows a script to run without that user's authorization, like a simple `on``Open(e)` or `on``Edit(e)` trigger, a custom function in Google Sheets, or a web app\ndeployed to \"execute as me\" (that is, authorized by the developer instead of the user).\nHowever, these restrictions generally do not apply if the developer runs the script themselves\nor belongs to the same Google Workspace domain as the user.\n\n```javascript\n// Log the email address of the person running the script.\nLogger.log(Session.getActiveUser().getEmail());\n```\n\n#### Return\n\n\n`String` --- The user's email's address, or a blank string if security policies do not allow access\nto the user's email address.\n\nDeprecated methods\n------------------\n\n### `get``User``Login``Id()`\n\n\n**Deprecated.** As of June 24, 2013, replaced by [getEmail()](#getEmail()).\n\nGets the user's email address.\n\n```javascript\n// Log the email address of the person running the script.\nLogger.log(Session.getActiveUser().getUserLoginId());\n```\n\n#### Return\n\n\n`String` --- The user's email's address."]]