Google Apps Script

Class Folder

A folder in Google Drive. Folders can be accessed or created from DriveApp.

 // Log the name of every folder in the user's Drive.
 var folders = DriveApp.getFolders();
 while (folders.hasNext()) {
   var folder = folders.next();
   Logger.log(folder.getName());
 }
 

Methods

MethodReturn typeBrief description
addEditor(emailAddress)FolderAdds the given user to the list of editors for the Folder.
addEditor(user)FolderAdds the given user to the list of editors for the Folder.
addEditors(emailAddresses)FolderAdds the given array of users to the list of editors for the Folder.
addFile(child)FolderAdds the given file to the current folder.
addFolder(child)FolderAdds the given folder to the current folder.
addViewer(emailAddress)FolderAdds the given user to the list of viewers for the Folder.
addViewer(user)FolderAdds the given user to the list of viewers for the Folder.
addViewers(emailAddresses)FolderAdds the given array of users to the list of viewers for the Folder.
createFile(blob)FileCreates a file in the current folder from a given Blob of arbitrary data.
createFile(name, content)FileCreates a text file in the current folder with the given name and contents.
createFile(name, content, mimeType)FileCreates a file in the current folder with the given name, contents, and MIME type.
createFolder(name)FolderCreates a folder in the current folder with the given name.
getAccess(email)PermissionGets the permission granted to the given user.
getAccess(user)PermissionGets the permission granted to the given user.
getDateCreated()DateGets the date the Folder was created.
getDescription()StringGets the description for the Folder.
getEditors()User[]Gets the list of editors for this Folder.
getFiles()FileIteratorGets a collection of all files that are children of the current folder.
getFilesByName(name)FileIteratorGets a collection of all files that are children of the current folder and have the given name.
getFilesByType(mimeType)FileIteratorGets a collection of all files that are children of the current folder and have the given MIME type.
getFolders()FolderIteratorGets a collection of all folders that are children of the current folder.
getFoldersByName(name)FolderIteratorGets a collection of all folders that are children of the current folder and have the given name.
getId()StringGets the ID of the Folder.
getLastUpdated()DateGets the date the Folder was last updated.
getName()StringGets the name of the Folder.
getOwner()UserGets the owner of the Folder.
getParents()FolderIteratorGets a collection of folders that are immediate parents of the Folder.
getSharingAccess()AccessGets which class of users can access the Folder, besides any individual users who have been explicitly given access.
getSharingPermission()PermissionGets the permission granted to those users who can access the Folder, besides any individual users who have been explicitly given access.
getSize()IntegerGets the number of bytes used to store the Folder in Drive.
getUrl()StringGets the URL that can be used to open the Folder in a Google App like Drive or Docs.
getViewers()User[]Gets the list of viewers and commenters for this Folder.
isShareableByEditors()BooleanDetermines whether users with edit permissions to the Folder are allowed to share with other users or change the permissions.
isStarred()BooleanDetermines whether the Folder has been starred in the user's Drive.
isTrashed()BooleanDetermines whether the Folder is in the trash of the user's Drive.
removeEditor(emailAddress)FolderRemoves the given user from the list of editors for the Folder.
removeEditor(user)FolderRemoves the given user from the list of editors for the Folder.
removeFile(child)FolderRemoves the given file from the current folder.
removeFolder(child)FolderRemoves the given folder from the current folder.
removeViewer(emailAddress)FolderRemoves the given user from the list of viewers and commenters for the Folder.
removeViewer(user)FolderRemoves the given user from the list of viewers and commenters for the Folder.
revokePermissions(user)FolderRevokes the access to the Folder granted to the given user.
revokePermissions(user)FolderRevokes the access to the Folder granted to the given user.
searchFiles(params)FileIteratorGets a collection of all files that are children of the current folder and match the given search criteria.
searchFolders(params)FolderIteratorGets a collection of all folders that are children of the current folder and match the given search criteria.
setDescription(description)FolderSets the description for the Folder.
setName(name)FolderSets the name of the Folder.
setOwner(emailAddress)FolderChanges the owner of the Folder.
setOwner(user)FolderChanges the owner of the Folder.
setShareableByEditors(shareable)FolderSets whether users with edit permissions to the Folder are allowed to share with other users or change the permissions.
setSharing(accessType, permissionType)FolderSets which class of users can access the Folder and what permissions those users are granted, besides any individual users who have been explicitly given access.
setStarred(starred)FolderSets whether the Folder is starred in the user's Drive.
setTrashed(trashed)FolderSets whether the Folder is in the trash of the user's Drive.

Detailed documentation

addEditor(emailAddress)

Adds the given user to the list of editors for the Folder. If the user was already on the list of viewers, this method promotes the user out of the list of viewers.

Parameters

NameTypeDescription
emailAddressStringthe email address of the user to add

Return

Folder — this Folder, for chaining


addEditor(user)

Adds the given user to the list of editors for the Folder. If the user was already on the list of viewers, this method promotes the user out of the list of viewers.

Parameters

NameTypeDescription
userUsera representation of the user to add

Return

Folder — this Folder, for chaining


addEditors(emailAddresses)

Adds the given array of users to the list of editors for the Folder. If any of the users were already on the list of viewers, this method promotes them out of the list of viewers.

Parameters

NameTypeDescription
emailAddressesString[]an array of email addresses of the users to add

Return

Folder — this Folder, for chaining


addFile(child)

Adds the given file to the current folder. This method does not move the file out of its existing parent folder; a file can have more than one parent simultaneously.

Parameters

NameTypeDescription
childFilethe child file to add

Return

Folder — this The new parent of the file added as a child.


addFolder(child)

Adds the given folder to the current folder. This method does not move the folder out of its existing parent folder; a folder can have more than one parent simultaneously.

Parameters

NameTypeDescription
childFolderthe child folder to add

Return

Folder — this The new parent of the folder added as a child.


addViewer(emailAddress)

Adds the given user to the list of viewers for the Folder. If the user was already on the list of editors, this method has no effect.

Parameters

NameTypeDescription
emailAddressStringthe email address of the user to add

Return

Folder — this Folder, for chaining


addViewer(user)

Adds the given user to the list of viewers for the Folder. If the user was already on the list of editors, this method has no effect.

Parameters

NameTypeDescription
userUsera representation of the user to add

Return

Folder — this Folder, for chaining


addViewers(emailAddresses)

Adds the given array of users to the list of viewers for the Folder. If any of the users were already on the list of editors, this method has no effect for them.

Parameters

NameTypeDescription
emailAddressesString[]an array of email addresses of the users to add

Return

Folder — this Folder, for chaining


createFile(blob)

Creates a file in the current folder from a given Blob of arbitrary data.

 // Create an image file in Google Drive using the Maps service.
 var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
 DriveApp.getRootFolder().createFile(blob);
 

Parameters

NameTypeDescription
blobBlobSourcethe data for the new file

Return

File — the new file


createFile(name, content)

Creates a text file in the current folder with the given name and contents. Throws an exception if content is larger than 10MB.

 // Create a text file with the content "Hello, world!"
 DriveApp.getRootFolder().createFile('New Text File', 'Hello, world!');
 

Parameters

NameTypeDescription
nameStringthe name of the new file
contentStringthe content for the new file

Return

File — the new file


createFile(name, content, mimeType)

Creates a file in the current folder with the given name, contents, and MIME type. Throws an exception if content is larger than 10MB.

 
// Create an HTML file with the content "Hello, world!"
 DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);
 
 

Parameters

NameTypeDescription
nameStringthe name of the new file
contentStringthe content for the new file
mimeTypeStringthe MIME type of the new file

Return

File — the new file


createFolder(name)

Creates a folder in the current folder with the given name.

Parameters

NameTypeDescription
nameStringthe name of the new folder

Return

Folder — the new folder


getAccess(email)

Gets the permission granted to the given user.

Parameters

NameTypeDescription
emailStringthe email address of the user whose permissions should be checked

Return

Permission — the permissions granted to the user


getAccess(user)

Gets the permission granted to the given user.

Parameters

NameTypeDescription
userUsera representation of the user whose permissions should be checked

Return

Permission — the permissions granted to the user


getDateCreated()

Gets the date the Folder was created.

Return

Date — the date the Folder was created


getDescription()

Gets the description for the Folder.

Return

String — the description for the Folder


getEditors()

Gets the list of editors for this Folder. If the user who executes the script does not have edit access to the Folder, this method returns an empty array.

Return

User[] — an array of users with edit permission


getFiles()

Gets a collection of all files that are children of the current folder.

Return

FileIterator — a collection of all files that are children of the current folder


getFilesByName(name)

Gets a collection of all files that are children of the current folder and have the given name.

Parameters

NameTypeDescription
nameStringthe name of the files to find

Return

FileIterator — a collection of all files that are children of the current folder and have the given name


getFilesByType(mimeType)

Gets a collection of all files that are children of the current folder and have the given MIME type.

Parameters

NameTypeDescription
mimeTypeStringthe MIME type of the files to find

Return

FileIterator — a collection of all files that are children of the current folder and have the given MIME type


getFolders()

Gets a collection of all folders that are children of the current folder.

Return

FolderIterator — a collection of all folders that are children of the current folder


getFoldersByName(name)

Gets a collection of all folders that are children of the current folder and have the given name.

Parameters

NameTypeDescription
nameStringthe name of the folders to find

Return

FolderIterator — a collection of all folders that are children of the current folder and have the given name


getId()

Gets the ID of the Folder.

Return

String — the ID of the Folder


getLastUpdated()

Gets the date the Folder was last updated.

Return

Date — the date the Folder was last updated


getName()

Gets the name of the Folder.

Return

String — the name of the Folder


getOwner()

Gets the owner of the Folder.

Return

User — a User object representing the owner


getParents()

Gets a collection of folders that are immediate parents of the Folder.

Return

FolderIterator — a collection of folders that are immediate parents of the Folder


getSharingAccess()

Gets which class of users can access the Folder, besides any individual users who have been explicitly given access.

Return

Access — which class of users can access the Folder


getSharingPermission()

Gets the permission granted to those users who can access the Folder, besides any individual users who have been explicitly given access.

Return

Permission — the permissions granted to users who can access the Folder


getSize()

Gets the number of bytes used to store the Folder in Drive. Note that Google Apps files do not count toward Drive storage limits and thus return 0 bytes.

Return

Integer — the number of bytes used to store the Folder in Drive


getUrl()

Gets the URL that can be used to open the Folder in a Google App like Drive or Docs.

Return

String — the URL that can be used to view this Folder in a Google App like Drive or Docs


getViewers()

Gets the list of viewers and commenters for this Folder. If the user who executes the script does not have edit access to the Folder, this method returns an empty array.

Return

User[] — an array of users with view or comment permission


isShareableByEditors()

Determines whether users with edit permissions to the Folder are allowed to share with other users or change the permissions.

Return

Booleantrue if users with edit permissions are allowed to share with other users or change the permissions; false if not


isStarred()

Determines whether the Folder has been starred in the user's Drive.

Return

Booleantrue if the Folder is starred in the user's Drive; false if not


isTrashed()

Determines whether the Folder is in the trash of the user's Drive.

Return

Booleantrue if the Folder is in the trash of the user's Drive; false if not


removeEditor(emailAddress)

Removes the given user from the list of editors for the Folder. This method does not block users from accessing the Folder if they belong to a class of users who have general access — for example, if the Folder is shared with the user's entire domain.

Parameters

NameTypeDescription
emailAddressStringthe email address of the user to remove

Return

Folder — this Folder, for chaining


removeEditor(user)

Removes the given user from the list of editors for the Folder. This method does not block users from accessing the Folder if they belong to a class of users who have general access — for example, if the Folder is shared with the user's entire domain.

Parameters

NameTypeDescription
userUsera representation of the user to remove

Return

Folder — this Folder, for chaining


removeFile(child)

Removes the given file from the current folder. This method does not delete the file, but if a file is removed from all of its parents, it cannot be seen in Drive except by searching for it or using the "All items" view.

Parameters

NameTypeDescription
childFilethe child file to remove

Return

Folder — this The previous parent of the child.


removeFolder(child)

Removes the given folder from the current folder. This method does not delete the folder or its contents, but if a folder is removed from all of its parents, it cannot be seen in Drive except by searching for it or using the "All items" view.

Parameters

NameTypeDescription
childFolderthe child folder to remove

Return

Folder — this The previous parent of the child.


removeViewer(emailAddress)

Removes the given user from the list of viewers and commenters for the Folder. This method has no effect if the user is an editor, not a viewer or commenter. This method also does not block users from accessing the Folder if they belong to a class of users who have general access — for example, if the Folder is shared with the user's entire domain.

Parameters

NameTypeDescription
emailAddressStringthe email address of the user to remove

Return

Folder — this Folder for chaining


removeViewer(user)

Removes the given user from the list of viewers and commenters for the Folder. This method has no effect if the user is an editor, not a viewer. This method also does not block users from accessing the Folder if they belong to a class of users who have general access — for example, if the Folder is shared with the user's entire domain.

Parameters

NameTypeDescription
userUsera representation of the user to remove

Return

Folder — this Folder for chaining


revokePermissions(user)

Revokes the access to the Folder granted to the given user. This method does not block users from accessing the Folder if they belong to a class of users who have general access — for example, if the Folder is shared with the user's entire domain.

Parameters

NameTypeDescription
userStringthe email address of the user whose access should be revoked

Return

Folder — this Folder, for chaining


revokePermissions(user)

Revokes the access to the Folder granted to the given user. This method does not block users from accessing the Folder if they belong to a class of users who have general access — for example, if the Folder is shared with the user's entire domain.

Parameters

NameTypeDescription
userUsera representation of the user whose access should be revoked

Return

Folder — this Folder, for chaining


searchFiles(params)

Gets a collection of all files that are children of the current folder and match the given search criteria. The search criteria are detailed the Google Drive SDK documentation. Note that the params argument is a query string that may contain string values, so take care to escape quotation marks correctly (for example "title contains 'Gulliver\\'s Travels'" or 'title contains "Gulliver\'s Travels"').

 // Log the name of every file that are children of the current folder and modified after February 28,
 // 2013 whose name contains "untitled".
 var files = DriveApp.getRootFolder().searchFiles(
     'modifiedDate > "2013-02-28" and title contains "untitled"');
 while (files.hasNext()) {
   var file = files.next();
   Logger.log(file.getName());
 }
 

Parameters

NameTypeDescription
paramsStringthe search criteria, as detailed in the Google Drive SDK documentation

Return

FileIterator — a collection of all files that are children of the current folder and match the search criteria


searchFolders(params)

Gets a collection of all folders that are children of the current folder and match the given search criteria. The search criteria are detailed the Google Drive SDK documentation. Note that the params argument is a query string that may contain string values, so take care to escape quotation marks correctly (for example "title contains 'Gulliver\\'s Travels'" or 'title contains "Gulliver\'s Travels"').

 // Log the name of every folder that are children of the current folder and you own and is starred.
 var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
 while (folders.hasNext()) {
   var folder = folders.next();
   Logger.log(folder.getName());
 }
 

Parameters

NameTypeDescription
paramsStringthe search criteria, as detailed in the Google Drive SDK documentation

Return

FolderIterator — a collection of all folders that are children of the current folder and match the search criteria


setDescription(description)

Sets the description for the Folder.

Parameters

NameTypeDescription
descriptionStringthe new description for the Folder

Return

Folder — this Folder, for chaining


setName(name)

Sets the name of the Folder.

Parameters

NameTypeDescription
nameStringthe new name of the Folder

Return

Folder — this Folder, for chaining


setOwner(emailAddress)

Changes the owner of the Folder. This method also gives the previous owner explicit edit access to the Folder.

Parameters

NameTypeDescription
emailAddressStringthe email address of the user who should become the new owner

Return

Folder — this Folder, for chaining


setOwner(user)

Changes the owner of the Folder. This method also gives the previous owner explicit edit access to the Folder.

Parameters

NameTypeDescription
userUsera representation of the user who should become the new owner

Return

Folder — this Folder, for chaining


setShareableByEditors(shareable)

Sets whether users with edit permissions to the Folder are allowed to share with other users or change the permissions. The default for a new Folder is true.

Parameters

NameTypeDescription
shareableBooleantrue if users with edit permissions should be allowed to share with other users or change the permissions; false if not

Return

Folder — this Folder, for chaining


setSharing(accessType, permissionType)

Sets which class of users can access the Folder and what permissions those users are granted, besides any individual users who have been explicitly given access.

 // Creates a folder that anyone on the Internet can read from and write to. (Domain
 // administrators can prohibit this setting for users of Google Apps for Business, Google Apps
 // for Education, or Google Apps for Your Domain.)
 var folder = DriveApp.createFolder('Shared Folder');
 folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
 

Parameters

NameTypeDescription
accessTypeAccesswhich class of users should be able to access the Folder
permissionTypePermissionthe permissions that should be granted to users who can access the Folder

Return

Folder — this Folder, for chaining


setStarred(starred)

Sets whether the Folder is starred in the user's Drive. The default for new Folders is false.

Parameters

NameTypeDescription
starredBooleantrue if the Folder should be starred in the user's Drive; false if not

Return

Folder — this Folder, for chaining


setTrashed(trashed)

Sets whether the Folder is in the trash of the user's Drive. The default for new Folders is false.

Parameters

NameTypeDescription
trashedBooleantrue if the Folder should be moved to the trash of the user's Drive; false if not

Return

Folder — this Folder, for chaining

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.