Class Folder

Folder

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

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

Methods

Method	Return type	Brief description
`add Editor(emailAddress)`	`Folder`	Adds the given user to the list of editors for the `Folder` .
`add Editor(user)`	`Folder`	Adds the given user to the list of editors for the `Folder` .
`add Editors(emailAddresses)`	`Folder`	Adds the given array of users to the list of editors for the `Folder` .
`add Viewer(emailAddress)`	`Folder`	Adds the given user to the list of viewers for the `Folder` .
`add Viewer(user)`	`Folder`	Adds the given user to the list of viewers for the `Folder` .
`add Viewers(emailAddresses)`	`Folder`	Adds the given array of users to the list of viewers for the `Folder` .
`create File(blob)`	`File`	Creates a file in the current folder from a given `Blob` of arbitrary data.
`create File(name, content)`	`File`	Creates a text file in the current folder with the given name and contents.
`create File(name, content, mimeType)`	`File`	Creates a file in the current folder with the given name, contents, and MIME type.
`create Folder(name)`	`Folder`	Creates a folder in the current folder with the given name.
`create Shortcut(targetId)`	`File`	Creates a shortcut to the provided Drive item ID, and returns it.
`create Shortcut For Target Id And Resource Key(targetId, targetResourceKey)`	`File`	Creates a shortcut to the provided Drive item ID and resource key, and returns it.
`get Access(email)`	`Permission`	Gets the permission granted to a specific user.
`get Access(user)`	`Permission`	Gets the permission granted to a specific user.
`get Date Created()`	`Date`	Gets the date the `Folder` was created.
`get Description()`	`String`	Gets the description for the `Folder` .
`get Editors()`	`User[]`	Gets the list of editors for this `Folder` .
`get Files()`	`File Iterator`	Gets a collection of all files that are children of the current folder.
`get Files By Name(name)`	`File Iterator`	Gets a collection of all files that are children of the current folder and have the given name.
`get Files By Type(mimeType)`	`File Iterator`	Gets a collection of all files that are children of the current folder and have the given MIME type.
`get Folders()`	`Folder Iterator`	Gets a collection of all folders that are children of the current folder.
`get Folders By Name(name)`	`Folder Iterator`	Gets a collection of all folders that are children of the current folder and have the given name.
`get Id()`	`String`	Gets the ID of the `Folder` .
`get Last Updated()`	`Date`	Gets the date the `Folder` was last updated.
`get Name()`	`String`	Gets the name of the `Folder` .
`get Owner()`	`User`	Gets the owner of this `Folder` .
`get Parents()`	`Folder Iterator`	Gets a collection of folders that are immediate parents of the `Folder` .
`get Resource Key()`	`String`	Gets the resource key of the `Folder` that is required to access items that have been shared using a link.
`get Security Update Eligible()`	`Boolean`	Gets whether this `Folder` is eligible to apply the security update that requires a resource key for access when it's shared using a link.
`get Security Update Enabled()`	`Boolean`	Gets whether this `Folder` requires a resource key for access when it's shared using a link.
`get Sharing Access()`	`Access`	Gets which class of users can access the `Folder` , besides any individual users who have been explicitly given access.
`get Sharing Permission()`	`Permission`	Gets the permission granted to those users who can access the `Folder` , besides any individual users who have been explicitly given access.
`get Size()`	`Integer`	Gets the number of bytes used to store the `Folder` in Drive.
`get Url()`	`String`	Gets the URL that can be used to open the `Folder` in a Google App like Drive or Docs.
`get Viewers()`	`User[]`	Gets the list of viewers and commenters for this `Folder` .
`is Shareable By Editors()`	`Boolean`	Determines whether users with edit permissions to the `Folder` are allowed to share with other users or change the permissions.
`is Starred()`	`Boolean`	Determines whether the `Folder` has been starred in the user's Drive.
`is Trashed()`	`Boolean`	Determines whether the `Folder` is in the trash of the user's Drive.
`move To(destination)`	`Folder`	Moves this item to the provided destination folder.
`remove Editor(emailAddress)`	`Folder`	Removes the given user from the list of editors for the `Folder` .
`remove Editor(user)`	`Folder`	Removes the given user from the list of editors for the `Folder` .
`remove Viewer(emailAddress)`	`Folder`	Removes the given user from the list of viewers and commenters for the `Folder` .
`remove Viewer(user)`	`Folder`	Removes the given user from the list of viewers and commenters for the `Folder` .
`revoke Permissions(emailAddress)`	`Folder`	Revokes the access to the `Folder` granted to the given user.
`revoke Permissions(user)`	`Folder`	Revokes the access to the `Folder` granted to the given user.
`search Files(params)`	`File Iterator`	Gets a collection of all files that are children of the current folder and match the given search criteria.
`search Folders(params)`	`Folder Iterator`	Gets a collection of all folders that are children of the current folder and match the given search criteria.
`set Description(description)`	`Folder`	Sets the description for the `Folder` .
`set Name(name)`	`Folder`	Sets the name of the `Folder` .
`set Owner(emailAddress)`	`Folder`	Changes the owner of the `Folder` .
`set Owner(user)`	`Folder`	Changes the owner of the `Folder` .
`set Security Update Enabled(enabled)`	`Folder`	Sets whether the `Folder` requires a resource key for access when it's shared using a link.
`set Shareable By Editors(shareable)`	`Folder`	Sets whether users with edit permissions to the `Folder` are allowed to share with other users or change the permissions.
`set Sharing(accessType, permissionType)`	`Folder`	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.
`set Starred(starred)`	`Folder`	Sets whether the `Folder` is starred in the user's Drive.
`set Trashed(trashed)`	`Folder`	Sets whether the `Folder` is in the trash of the user's Drive.

Deprecated methods

Method	Return type	Brief description
~~`add File(child)`~~	`Folder`	Adds the given file to the current folder.
~~`add Folder(child)`~~	`Folder`	Adds the given folder to the current folder.
~~`remove File(child)`~~	`Folder`	Removes the given file from the current folder.
~~`remove Folder(child)`~~	`Folder`	Removes the given folder from the current folder.

Detailed documentation

`add Editor(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

Name	Type	Description
`email Address`	`String`	The email address of the user to add.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`add Editor(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

Name	Type	Description
`user`	`User`	A representation of the user to add.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`add Editors(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

Name	Type	Description
`email Addresses`	`String[]`	An array of email addresses of the users to add.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`add Viewer(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

Name	Type	Description
`email Address`	`String`	The email address of the user to add.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`add Viewer(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

Name	Type	Description
`user`	`User`	A representation of the user to add.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`add Viewers(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

Name	Type	Description
`email Addresses`	`String[]`	An array of email addresses of the users to add.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`create File(blob)`

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

Parameters

Name	Type	Description
`blob`	`Blob Source`	The data for the new file.

Return

File — The new file.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`create File(name, content)`

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

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

Parameters

Name	Type	Description
`name`	`String`	The name of the new file.
`content`	`String`	The content for the new file.

Return

File — The new file.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`create File(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

Name	Type	Description
`name`	`String`	The name of the new file.
`content`	`String`	The content for the new file.
`mime Type`	`String`	The MIME type of the new file.

Return

File — The new file.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`create Folder(name)`

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

Parameters

Name	Type	Description
`name`	`String`	The name of the new folder.

Return

Folder — The new folder.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`create Shortcut(targetId)`

Creates a shortcut to the provided Drive item ID, and returns it.

Parameters

Name	Type	Description
`target Id`	`String`	The file ID of the target file or folder.

Return

File — The new shortcut.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`create Shortcut For Target Id And Resource Key(targetId, targetResourceKey)`

Creates a shortcut to the provided Drive item ID and resource key, and returns it. A resource key is an additional parameter that needs to be passed to access the target file or folder that has been shared using a link.

 // Creates shortcuts for all folders in the user's drive that have a specific 
 // name. 
 // TODO(developer): Replace 'Test-Folder' with a valid folder name in your 
 // drive. 
 const 
  
 folders 
  
 = 
  
 DriveApp 
 . 
 getFoldersByName 
 ( 
 'Test-Folder' 
 ); 
 // Iterates through all folders named 'Test-Folder'. 
 while 
  
 ( 
 folders 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 folder 
  
 = 
  
 folders 
 . 
 next 
 (); 
  
 // Creates a shortcut to the provided Drive item ID and resource key, and 
  
 // returns it. 
  
 DriveApp 
 . 
 createShortcutForTargetIdAndResourceKey 
 ( 
  
 folder 
 . 
 getId 
 (), 
  
 folder 
 . 
 getResourceKey 
 (), 
  
 ); 
 }

Parameters

Name	Type	Description
`target Id`	`String`	The ID of the target file or folder.
`target Resource Key`	`String`	The resource key of the target file or folder.

Return

File — The new shortcut.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`get Access(email)`

Gets the permission granted to a specific user. The method doesn't support returning permissions for a Google Group or permissions inherited through Google Groups.

Parameters

Name	Type	Description
`email`	`String`	The email address of the user whose permissions should be checked. Google Groups aren't supported.

Return

Permission — The permissions granted to the user.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Access(user)`

Gets the permission granted to a specific user. The method doesn't support returning permissions for a Google Group or permissions inherited through Google Groups.

Parameters

Name	Type	Description
`user`	`User`	A representation of the user whose permissions should be checked.

Return

Permission — The permissions granted to the user.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Date Created()`

Gets the date the Folder was created.

Return

Date — the date the Folder was created

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Description()`

Gets the description for the Folder .

Return

String — the description for the Folder

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Editors()`

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.

 //  Gets a folder by its ID. 
 //  TODO(developer): Replace the folder ID with your own. 
 const 
  
 folder 
  
 = 
  
 DriveApp 
 . 
 getFolderById 
 ( 
 '1234567890abcdefghijklmnopqrstuvwxyz' 
 ); 
 // Gets the list of editors and logs their names to the console. 
 const 
  
 editors 
  
 = 
  
 folder 
 . 
 getEditors 
 (); 
 for 
  
 ( 
 const 
  
 editor 
  
 of 
  
 editors 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 editor 
 . 
 getName 
 ()); 
 }

Return

User[] — The list of editors for this Folder if the user has edit access or an empty array otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Files()`

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

Return

File Iterator — A collection of all files that are children of the current folder.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Files By Name(name)`

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

Parameters

Name	Type	Description
`name`	`String`	The name of the files to find.

Return

File Iterator — A collection of all files that are children of the current folder and have the given name.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Files By Type(mimeType)`

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

Parameters

Name	Type	Description
`mime Type`	`String`	The MIME type of the files to find.

Return

File Iterator — A collection of all files that are children of the current folder and have the given MIME type.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Folders()`

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

Return

Folder Iterator — A collection of all folders that are children of the current folder.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Folders By Name(name)`

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

Parameters

Name	Type	Description
`name`	`String`	The name of the folders to find.

Return

Folder Iterator — A collection of all folders that are children of the current folder and have the given name.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Id()`

Gets the ID of the Folder .

Return

String — the ID of the Folder

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Last Updated()`

Gets the date the Folder was last updated.

Return

Date — the date the Folder was last updated

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Name()`

Gets the name of the Folder .

Return

String — the name of the Folder

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Owner()`

Gets the owner of this Folder .

 //  Gets a folder by its ID. 
 //  TODO(developer): Replace the folder ID with your own. 
 const 
  
 folder 
  
 = 
  
 DriveApp 
 . 
 getFolderById 
 ( 
 '1234567890abcdefghijklmnopqrstuvwxyz' 
 ); 
 // Gets the owner of the folder and logs the name to the console. 
 const 
  
 folderOwner 
  
 = 
  
 folder 
 . 
 getOwner 
 (); 
 console 
 . 
 log 
 ( 
 folderOwner 
 . 
 getName 
 ());

Return

User — The owner of this Folder .

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Parents()`

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

Return

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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Resource Key()`

Gets the resource key of the Folder that is required to access items that have been shared using a link.

Return

String — The resource key of the Folder .

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Security Update Eligible()`

Gets whether this Folder is eligible to apply the security update that requires a resource key for access when it's shared using a link.

Drive requires a resource key to access some files or folders that have been shared using a link. This change is part of a security update. The update is turned on by default for eligible files and folders. To turn the resource key requirement on or off for eligible files, use set Security Update Enabled .

Learn more about the Security update for Google Drive .

Return

Boolean — Whether the resource key requirement can be applied for the Folder .

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Security Update Enabled()`

Gets whether this Folder requires a resource key for access when it's shared using a link. This requirement is turned on by default for eligible files and folders. To turn the resource key requirement on or off for eligible files, use setSecurityUpdateEnabled .

Learn more about the Security update for Google Drive .

Return

Boolean — Whether the resource key requirement is enabled for this Folder .

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Sharing Access()`

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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Sharing Permission()`

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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Size()`

Gets the number of bytes used to store the Folder in Drive. Note that Google Workspace application 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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Url()`

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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`get Viewers()`

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.

 //  Gets a folder by its ID. 
 //  TODO(developer): Replace the folder ID with your own. 
 const 
  
 folder 
  
 = 
  
 DriveApp 
 . 
 getFolderById 
 ( 
 '1234567890abcdefghijklmnopqrstuvwxyz' 
 ); 
 // Gets the list of viewers and logs their names to the console. 
 const 
  
 viewers 
  
 = 
  
 folder 
 . 
 getViewers 
 (); 
 for 
  
 ( 
 const 
  
 viewer 
  
 of 
  
 viewers 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 viewer 
 . 
 getName 
 ()); 
 }

Return

User[] — The list of viewers and commenters for this Folder if the user has edit access or an empty array otherwise.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`is Shareable By Editors()`

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

Return

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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`is Starred()`

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

Return

Boolean — true if the Folder is starred in the user's Drive; false if not

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`is Trashed()`

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

Return

Boolean — true if the Folder is in the trash of the user's Drive; false if not

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`move To(destination)`

Moves this item to the provided destination folder.

The current user must be the owner of the file or have at least edit access to the item's current parent folder in order to move the item to the destination folder.

Parameters

Name	Type	Description
`destination`	`Folder`	The folder that becomes the new parent.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`remove Editor(emailAddress)`

Removes the given user from the list of editors for the Folder . This method doesn't 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, or if the Folder is in a shared drive that the user can access.

For Drive files, this also removes the user from the list of viewers.

Parameters

Name	Type	Description
`email Address`	`String`	The email address of the user to remove.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`remove Editor(user)`

For Drive files, this also removes the user from the list of viewers.

Parameters

Name	Type	Description
`user`	`User`	A representation of the user to remove.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`remove Viewer(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 doesn't 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, or if the Folder is in a shared drive that the user can access.

For Drive files, this also removes the user from the list of editors.

Parameters

Name	Type	Description
`email Address`	`String`	The email address of the user to remove.

Return

Folder — This Folder for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`remove Viewer(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 doesn't 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, or if the Folder is in a shared drive that the user can access.

For Drive files, this also removes the user from the list of editors.

Parameters

Name	Type	Description
`user`	`User`	A representation of the user to remove.

Return

Folder — This Folder for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`revoke Permissions(emailAddress)`

Revokes the access to the Folder granted to the given user. This method doesn't 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

Name	Type	Description
`email Address`	`String`	The email address of the user whose access should be revoked.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`revoke Permissions(user)`

Parameters

Name	Type	Description
`user`	`User`	A representation of the user whose access should be revoked.

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`search Files(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 in the Google Drive SDK documentation . Note that the Drive service uses v2 of the Drive API and some query fields differ from v3. Review the field differences between v2 and v3 .

The params argument is a query string that can contain string values, so take care to escape quotation marks correctly (for example "title contains 'Gulliver\\'s Travels'" or 'title contains "Gulliver\'s Travels"' ).

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

Parameters

Name	Type	Description
`params`	`String`	The search criteria, as detailed in the Google Drive SDK documentation .

Return

File Iterator — A collection of all files that are children of the current folder and match the search criteria.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`search Folders(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 in the Google Drive SDK documentation . Note that the Drive service uses v2 of the Drive API and some query fields differ from v3. Review the field differences between v2 and v3 .

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

Parameters

Name	Type	Description
`params`	`String`	The search criteria, as detailed in the Google Drive SDK documentation .

Return

Folder Iterator — A collection of all folders that are children of the current folder and match the search criteria.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`set Description(description)`

Sets the description for the Folder .

Parameters

Name	Type	Description
`description`	`String`	the new description for the `Folder`

Return

Folder — this Folder , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`set Name(name)`

Sets the name of the Folder .

Parameters

Name	Type	Description
`name`	`String`	the new name of the `Folder`

Return

Folder — this Folder , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`set Owner(emailAddress)`

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

Parameters

Name	Type	Description
`email Address`	`String`	the email address of the user who should become the new owner

Return

Folder — this Folder , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`set Owner(user)`

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

Parameters

Name	Type	Description
`user`	`User`	a representation of the user who should become the new owner

Return

Folder — this Folder , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`set Security Update Enabled(enabled)`

Sets whether the Folder requires a resource key for access when it's shared using a link. Eligible files and folders are enabled by default.

Learn more about the Security update for Google Drive .

Parameters

Name	Type	Description
`enabled`	`Boolean`	Whether to enable the resource key requirement for the `Folder` .

Return

Folder — This Folder , for chaining.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`set Shareable By Editors(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

Name	Type	Description
`shareable`	`Boolean`	`true` 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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`set Sharing(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 a Google 
 // Workspace domain.) 
 const 
  
 folder 
  
 = 
  
 DriveApp 
 . 
 createFolder 
 ( 
 'Shared Folder' 
 ); 
 folder 
 . 
 setSharing 
 ( 
 DriveApp 
 . 
 Access 
 . 
 ANYONE 
 , 
  
 DriveApp 
 . 
 Permission 
 . 
 EDIT 
 );

Parameters

Name	Type	Description
`access Type`	`Access`	which class of users should be able to access the `Folder`
`permission Type`	`Permission`	the permissions that should be granted to users who can access the `Folder`

Return

Folder — this Folder , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`set Starred(starred)`

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

Parameters

Name	Type	Description
`starred`	`Boolean`	`true` if the `Folder` should be starred in the user's Drive; `false` if not

Return

Folder — this Folder , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`set Trashed(trashed)`

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

Parameters

Name	Type	Description
`trashed`	`Boolean`	`true` if the `Folder` should be moved to the trash of the user's Drive; `false` if not

Return

Folder — this Folder , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

Deprecated methods

`add File(child)`

Deprecated.Instead, use File.moveTo(destination) or create Shortcut(targetId) .

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

Name	Type	Description
`child`	`File`	The child file to add.

Return

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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`add Folder(child)`

Deprecated.Instead, use move To(destination) or create Shortcut(targetId) .

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

Name	Type	Description
`child`	`Folder`	The child folder to add.

Return

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

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`remove File(child)`

Deprecated.Instead, use File.moveTo(destination) .

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

Name	Type	Description
`child`	`File`	The child file to remove.

Return

Folder — The previous parent of the child.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive

`remove Folder(child)`

Deprecated.Instead, use move To(destination) .

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

Name	Type	Description
`child`	`Folder`	The child folder to remove.

Return

Folder — The previous parent of the child.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

https://www.googleapis.com/auth/drive