Class User
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Usuário
Um usuário associado a um arquivo no Google Drive. Os usuários podem ser acessados em File.getEditors()
, Folder.getViewers()
e outros métodos.
// Log the email address of all users who have edit access to a file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
Logger.log(editors[i].getEmail());
}
Métodos
Método | Tipo de retorno | Breve descrição |
getDomain() | String | Consegue o nome de domínio associado à conta do usuário. |
getEmail() | String | Retorna o endereço de e-mail do usuário. |
getName() | String | Recebe o nome do usuário. |
getPhotoUrl() | String | Recebe o URL da foto do usuário. |
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
getDomain()
Consegue o nome de domínio associado à conta do usuário.
// Log the domain names associated with all users who have edit access to a
// file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
Logger.log(editors[i].getDomain());
}
Retornar
String
: o nome de domínio associado à conta do usuário.
getEmail()
Retorna o endereço de e-mail do usuário. O endereço de e-mail do usuário só estará disponível se ele tiver escolhido compartilhar o endereço na página de configurações da conta do Google+ ou se ele pertencer ao mesmo domínio do usuário que está executando o script e o administrador do domínio tiver permitido que todos os usuários do domínio vejam os endereços de e-mail de outros usuários.
// Log the email address of all users who have edit access to a file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
Logger.log(editors[i].getEmail());
}
Retornar
String
: o endereço de e-mail do usuário ou uma string em branco se o endereço de e-mail não estiver disponível.
getName()
Recebe o nome do usuário. Esse método retorna null
se o nome do usuário não estiver disponível.
// Log the names of all users who have edit access to a file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
Logger.log(editors[i].getName());
}
Retornar
String
: o nome do usuário ou null
se o nome não estiver disponível.
getPhotoUrl()
Recebe o URL da foto do usuário. Esse método retorna null
se a foto do usuário não estiver
disponível.
// Log the URLs for the photos of all users who have edit access to a file.
const file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
const editors = file.getEditors();
for (let i = 0; i < editors.length; i++) {
Logger.log(editors[i].getPhotoUrl());
}
Retornar
String
: o URL da foto do usuário ou null
se a foto não estiver disponível.
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\u003eA User in Google Drive represents an individual associated with a file or folder, accessible through methods like \u003ccode\u003egetEditors()\u003c/code\u003e and \u003ccode\u003egetViewers()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve user information such as their domain, email address, name, and photo URL using dedicated methods of the \u003ccode\u003eUser\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetUserLoginId()\u003c/code\u003e method is deprecated and has been replaced by \u003ccode\u003egetEmail()\u003c/code\u003e for accessing a user's email address.\u003c/p\u003e\n"],["\u003cp\u003eUser email addresses might not be available if privacy settings restrict access or if domain-wide sharing isn't enabled.\u003c/p\u003e\n"],["\u003cp\u003eUser names and photo URLs may return \u003ccode\u003enull\u003c/code\u003e if they are not available or have not been set by the user.\u003c/p\u003e\n"]]],[],null,["# Class User\n\nUser\n\nA user associated with a file in Google Drive. Users can be accessed from [File.getEditors()](/apps-script/reference/drive/file#getEditors()), [Folder.getViewers()](/apps-script/reference/drive/folder#getViewers()), and other methods.\n\n```javascript\n// Log the email address of all users who have edit access to a file.\nconst file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');\nconst editors = file.getEditors();\nfor (let i = 0; i \u003c editors.length; i++) {\n Logger.log(editors[i].getEmail());\n}\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------|-------------|----------------------------------------------------------|\n| [getDomain()](#getDomain()) | `String` | Gets the domain name associated with the user's account. |\n| [getEmail()](#getEmail()) | `String` | Gets the user's email address. |\n| [getName()](#getName()) | `String` | Gets the user's name. |\n| [getPhotoUrl()](#getPhotoUrl()) | `String` | Gets the URL for the user's photo. |\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``Domain()`\n\nGets the domain name associated with the user's account.\n\n```javascript\n// Log the domain names associated with all users who have edit access to a\n// file.\nconst file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');\nconst editors = file.getEditors();\nfor (let i = 0; i \u003c editors.length; i++) {\n Logger.log(editors[i].getDomain());\n}\n```\n\n#### Return\n\n\n`String` --- the domain name associated with the user's account\n\n*** ** * ** ***\n\n### `get``Email()`\n\nGets the user's email address. The user's email address is only available if the user has\nchosen to share the address from the Google+ account settings page, or if the user belongs to\nthe same domain as the user running the script and the domain administrator has allowed all\nusers within the domain to see other users' email addresses.\n\n```javascript\n// Log the email address of all users who have edit access to a file.\nconst file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');\nconst editors = file.getEditors();\nfor (let i = 0; i \u003c editors.length; i++) {\n Logger.log(editors[i].getEmail());\n}\n```\n\n#### Return\n\n\n`String` --- the user's email's address, or a blank string if the email address is not available\n\n*** ** * ** ***\n\n### `get``Name()`\n\nGets the user's name. This method returns `null` if the user's name is not available.\n\n```javascript\n// Log the names of all users who have edit access to a file.\nconst file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');\nconst editors = file.getEditors();\nfor (let i = 0; i \u003c editors.length; i++) {\n Logger.log(editors[i].getName());\n}\n```\n\n#### Return\n\n\n`String` --- the user's name, or `null` if the name is not available\n\n*** ** * ** ***\n\n### `get``Photo``Url()`\n\nGets the URL for the user's photo. This method returns `null` if the user's photo is not\navailable.\n\n```javascript\n// Log the URLs for the photos of all users who have edit access to a file.\nconst file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');\nconst editors = file.getEditors();\nfor (let i = 0; i \u003c editors.length; i++) {\n Logger.log(editors[i].getPhotoUrl());\n}\n```\n\n#### Return\n\n\n`String` --- the URL for the user's photo, or `null` if the photo is not available\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."]]