Class User

Spark icon

AI-generated Key Takeaways

The User class in Google Drive represents a user associated with a file and can be accessed through methods like File.getEditors() or Folder.getViewers().
Available methods for a User include retrieving their domain (getDomain()), email address (getEmail()), name (getName()), and photo URL (getPhotoUrl()).
The getUserLoginId() method is deprecated and has been replaced by getEmail().

User

A user associated with a file in Google Drive. Users can be accessed from File.getEditors() , Folder.getViewers() , and other methods.

// Log the email address of all users who have edit access to a file.
constfile=DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
consteditors=file.getEditors();
for(leti=0;i < editors.length;i++){
Logger.log(editors[i].getEmail());
}

Methods

Method	Return type	Brief description
`getDomain()`	`String`	Gets the domain name associated with the user's account.
`getEmail()`	`String`	Gets the user's email address.
`getName()`	`String`	Gets the user's name.
`getPhotoUrl()`	`String`	Gets the URL for the user's photo.

Deprecated methods

Method	Return type	Brief description
`(削除) getUserLoginId() (削除ここまで)`	`String`	Gets the user's email address.

Detailed documentation

`getDomain()`

Gets the domain name associated with the user's account.

// Log the domain names associated with all users who have edit access to a
// file.
constfile=DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
consteditors=file.getEditors();
for(leti=0;i < editors.length;i++){
Logger.log(editors[i].getDomain());
}

Return

String — the domain name associated with the user's account

`getEmail()`

Gets the user's email address. The user's email address is only available if the user has chosen to share the address from the Google+ account settings page, or if the user belongs to the same domain as the user running the script and the domain administrator has allowed all users within the domain to see other users' email addresses.

// Log the email address of all users who have edit access to a file.
constfile=DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
consteditors=file.getEditors();
for(leti=0;i < editors.length;i++){
Logger.log(editors[i].getEmail());
}

Return

String — the user's email's address, or a blank string if the email address is not available

`getName()`

Gets the user's name. This method returns null if the user's name is not available.

// Log the names of all users who have edit access to a file.
constfile=DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
consteditors=file.getEditors();
for(leti=0;i < editors.length;i++){
Logger.log(editors[i].getName());
}

Return

String — the user's name, or null if the name is not available

`getPhotoUrl()`

Gets the URL for the user's photo. This method returns null if the user's photo is not available.

// Log the URLs for the photos of all users who have edit access to a file.
constfile=DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
consteditors=file.getEditors();
for(leti=0;i < editors.length;i++){
Logger.log(editors[i].getPhotoUrl());
}

Return

String — the URL for the user's photo, or null if the photo is not available

Deprecated methods

(削除) `getUserLoginId()` (削除ここまで)

Deprecated. As of June 24, 2013, replaced by getEmail() .

Gets the user's email address.

// Log the email address of the person running the script.
Logger.log(Session.getActiveUser().getUserLoginId());

Return

String — The user's email's address.

Class User Stay organized with collections Save and categorize content based on your preferences.

AI-generated Key Takeaways

Methods

Deprecated methods

Detailed documentation

getDomain()

Return

getEmail()

Return

getName()

Return

getPhotoUrl()

Return

Deprecated methods

(削除) getUserLoginId() (削除ここまで)

Return

Class User

`getDomain()`

`getEmail()`

`getName()`

`getPhotoUrl()`

(削除) `getUserLoginId()` (削除ここまで)