Class File

File

A file in Google Drive. Files can be accessed or created from Drive App .

 // Trash every untitled spreadsheet that hasn't been updated in a week. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Untitled spreadsheet' 
 ); 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 if 
  
 ( 
 new 
  
 Date 
 () 
  
 - 
  
 file 
 . 
 getLastUpdated 
 () 
 > 
 7 
  
 * 
  
 24 
  
 * 
  
 60 
  
 * 
  
 60 
  
 * 
  
 1000 
 ) 
  
 { 
  
 file 
 . 
 setTrashed 
 ( 
 true 
 ); 
  
 } 
 }

Methods

Method	Return type	Brief description
`add Commenter(emailAddress)`	`File`	Add the given user to the list of commenters for the `File` .
`add Commenter(user)`	`File`	Add the given user to the list of commenters for the `File` .
`add Commenters(emailAddresses)`	`File`	Add the given array of users to the list of commenters for the `File` .
`add Editor(emailAddress)`	`File`	Adds the given user to the list of editors for the `File` .
`add Editor(user)`	`File`	Adds the given user to the list of editors for the `File` .
`add Editors(emailAddresses)`	`File`	Adds the given array of users to the list of editors for the `File` .
`add Viewer(emailAddress)`	`File`	Adds the given user to the list of viewers for the `File` .
`add Viewer(user)`	`File`	Adds the given user to the list of viewers for the `File` .
`add Viewers(emailAddresses)`	`File`	Adds the given array of users to the list of viewers for the `File` .
`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 As(contentType)`	`Blob`	Return the data inside this object as a blob converted to the specified content type.
`get Blob()`	`Blob`	Return the data inside this object as a blob.
`get Date Created()`	`Date`	Gets the date the `File` was created.
`get Description()`	`String`	Gets the description for the `File` .
`get Download Url()`	`String`	Gets the URL that can be used to download the file.
`get Editors()`	`User[]`	Gets the list of editors for this `File` .
`get Id()`	`String`	Gets the ID of the `File` .
`get Last Updated()`	`Date`	Gets the date the `File` was last updated.
`get Mime Type()`	`String`	Gets the MIME type of the file.
`get Name()`	`String`	Gets the name of the `File` .
`get Owner()`	`User`	Gets the file owner.
`get Parents()`	`Folder Iterator`	Gets a collection of folders that are immediate parents of the `File` .
`get Resource Key()`	`String`	Gets the resource key of the `File` that is required to access items that have been shared using a link.
`get Security Update Eligible()`	`Boolean`	Gets whether this `File` 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 `File` 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 `File` , 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 `File` , besides any individual users who have been explicitly given access.
`get Size()`	`Integer`	Gets the number of bytes used to store the `File` in Drive.
`get Target Id()`	`String`	If this is a Shortcut, returns the ID of the item it points to.
`get Target Mime Type()`	`String`	If this is a Shortcut, returns the mime type of the item it points to.
`get Target Resource Key()`	`String`	If the file is a shortcut, returns the resource key of the item it points to.
`get Thumbnail()`	`Blob`	Gets a thumbnail image for the file, or `null` if no thumbnail exists.
`get Url()`	`String`	Gets the URL that can be used to open the `File` in a Google App like Drive or Docs.
`get Viewers()`	`User[]`	Gets the list of viewers and commenters for this `File` .
`is Shareable By Editors()`	`Boolean`	Determines whether users with edit permissions to the `File` are allowed to share with other users or change the permissions.
`is Starred()`	`Boolean`	Determines whether the `File` has been starred in the user's Drive.
`is Trashed()`	`Boolean`	Determines whether the `File` is in the trash of the user's Drive.
`make Copy()`	`File`	Creates a copy of the file.
`make Copy(destination)`	`File`	Creates a copy of the file in the destination directory.
`make Copy(name)`	`File`	Creates a copy of the file and names it with the name provided.
`make Copy(name, destination)`	`File`	Creates a copy of the file in the destination directory and names it with the name provided.
`move To(destination)`	`File`	Moves this item to the provided destination folder.
`remove Commenter(emailAddress)`	`File`	Removes the given user from the list of commenters for the `File` .
`remove Commenter(user)`	`File`	Removes the given user from the list of commenters for the `File` .
`remove Editor(emailAddress)`	`File`	Removes the given user from the list of editors for the `File` .
`remove Editor(user)`	`File`	Removes the given user from the list of editors for the `File` .
`remove Viewer(emailAddress)`	`File`	Removes the given user from the list of viewers and commenters for the `File` .
`remove Viewer(user)`	`File`	Removes the given user from the list of viewers and commenters for the `File` .
`revoke Permissions(emailAddress)`	`File`	Revokes the access to the `File` granted to the given user.
`revoke Permissions(user)`	`File`	Revokes the access to the `File` granted to the given user.
`set Content(content)`	`File`	Overwrites the content of the file with a given replacement.
`set Description(description)`	`File`	Sets the description for the `File` .
`set Name(name)`	`File`	Sets the name of the `File` .
`set Owner(emailAddress)`	`File`	Changes the owner of the `File` .
`set Owner(user)`	`File`	Changes the owner of the `File` .
`set Security Update Enabled(enabled)`	`File`	Sets whether the `File` requires a resource key for access when it's shared using a link.
`set Shareable By Editors(shareable)`	`File`	Sets whether users with edit permissions to the `File` are allowed to share with other users or change the permissions.
`set Sharing(accessType, permissionType)`	`File`	Sets which class of users can access the `File` and what permissions those users are granted, besides any individual users who have been explicitly given access.
`set Starred(starred)`	`File`	Sets whether the `File` is starred in the user's Drive.
`set Trashed(trashed)`	`File`	Sets whether the `File` is in the trash of the user's Drive.

Detailed documentation

`add Commenter(emailAddress)`

Add the given user to the list of commenters for the File . If the user was already on the list of viewers, this method promotes the user out of the list of viewers.

 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 file 
 . 
 addCommenter 
 ( 
 'hello@example.com' 
 ); 
 }

Parameters

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

Return

File — This File , 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 Commenter(user)`

Add the given user to the list of commenters for the File . If the user was already on the list of viewers, this method promotes the user out of the list of viewers.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Adds the active user as a commenter. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 file 
 . 
 addCommenter 
 ( 
 Session 
 . 
 getActiveUser 
 ()); 
 }

Parameters

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

Return

File — This File , 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 Commenters(emailAddresses)`

Add the given array of users to the list of commenters for the File . If any of the users were already on the list of viewers, this method promotes them out of the list of viewers.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and 
  
 // 'baklavainthebalkans@gmail.com' with the email addresses to add as 
  
 // commenters. 
  
 const 
  
 emails 
  
 = 
  
 [ 
  
 'cloudysanfrancisco@gmail.com' 
 , 
  
 'baklavainthebalkans@gmail.com' 
 , 
  
 ]; 
  
 console 
 . 
 log 
 ( 
 file 
 . 
 addCommenters 
 ( 
 emails 
 )); 
 }

Parameters

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

Return

File — This File , 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(emailAddress)`

Adds the given user to the list of editors for the File . 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

File — This File , 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 File . 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

File — This File , 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 File . 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

File — This File , 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 File . 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

File — This File , 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 File . 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

File — This File , 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 File . 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

File — This File , for chaining.

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 As(contentType)`

Return the data inside this object as a blob converted to the specified content type. This method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it assumes that the part of the filename that follows the last period (if any) is an existing extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes "ShoppingList.12.25.pdf".

To view the daily quotas for conversions, see Quotas for Google Services . Newly created Google Workspace domains might be temporarily subject to stricter quotas.

Parameters

Name	Type	Description
`content Type`	`String`	The MIME type to convert to. For most blobs, `'application/pdf'` is the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of `'image/bmp'` , `'image/gif'` , `'image/jpeg'` , or `'image/png'` are also valid. For a Google Docs document, `'text/markdown'` is also valid.

Return

Blob — The data as a blob.

`get Blob()`

Return the data inside this object as a blob.

Return

Blob — The data as a blob.

`get Date Created()`

Gets the date the File was created.

Return

Date — the date the File 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 File .

Return

String — the description for the File

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 Download Url()`

Gets the URL that can be used to download the file. Only users with permission to open the file in Google Drive can access the URL. You can use this URL in a browser to download the file, but you can't use to fetch the file with Url Fetch App . If you want the contents of the file in the script, use get Blob() .

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files and logs the download URLs to the console. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 console 
 . 
 log 
 ( 
 file 
 . 
 getDownloadUrl 
 ()); 
 }

Return

String — The URL that can be used to download the file.

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 File . If the user who executes the script does not have edit access to the File , this method returns an empty array.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // Adds the email addresses in the array as editors of each file. 
  
 // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' 
  
 // and 'baklavainthebalkans@gmail.com' with valid email addresses. 
  
 file 
 . 
 addEditors 
 ([ 
  
 'cloudysanfrancisco@gmail.com' 
 , 
  
 'baklavainthebalkans@gmail.com' 
 , 
  
 ]); 
  
 // Gets a list of the file editors. 
  
 const 
  
 editors 
  
 = 
  
 file 
 . 
 getEditors 
 (); 
  
 // For each file, logs the editors' email addresses to the console. 
  
 for 
  
 ( 
 const 
  
 editor 
  
 of 
  
 editors 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 editor 
 . 
 getEmail 
 ()); 
  
 } 
 }

Return

User[] — If the user has edit access for this File , returns the list of editors. If the user doesn't have edit access, returns an empty array.

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 File .

Return

String — the ID of the File

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 File was last updated.

Return

Date — the date the File 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 Mime Type()`

Gets the MIME type of the file.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files and logs the MIME type to the console. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 console 
 . 
 log 
 ( 
 file 
 . 
 getMimeType 
 ()); 
 }

Return

String — The MIME type of the file.

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 File .

Return

String — the name of the File

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 file owner.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files and logs the names of the file owners to the console. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 console 
 . 
 log 
 ( 
 file 
 . 
 getOwner 
 (). 
 getName 
 ()); 
 }

Return

User — The file owner.

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 File .

Return

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

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 File that is required to access items that have been shared using a link.

Return

String — The resource key of the File .

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 File 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 File .

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 File 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 File .

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 File , besides any individual users who have been explicitly given access.

Return

Access — which class of users can access the File

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 File , besides any individual users who have been explicitly given access.

Return

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

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 File 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 File 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 Target Id()`

If this is a Shortcut, returns the ID of the item it points to.

Otherwise it returns null .

 // The ID of the file for which to make a shortcut and the ID of 
 // the folder to which you want to add the shortcut. 
 // TODO(developer): Replace the file and folder IDs with your IDs. 
 const 
  
 fileId 
  
 = 
  
 'abc123456' 
 ; 
 const 
  
 folderId 
  
 = 
  
 'xyz987654' 
 ; 
 // Gets the folder to add the shortcut to. 
 const 
  
 folder 
  
 = 
  
 DriveApp 
 . 
 getFolderById 
 ( 
 folderId 
 ); 
 // Creates a shortcut of the file and moves it to the specified folder. 
 const 
  
 shortcut 
  
 = 
  
 DriveApp 
 . 
 createShortcut 
 ( 
 fileId 
 ). 
 moveTo 
 ( 
 folder 
 ); 
 // Logs the target ID of the shortcut. 
 console 
 . 
 log 
 ( 
 ` 
 ${ 
 shortcut 
 . 
 getName 
 () 
 } 
 = 
 ${ 
 shortcut 
 . 
 getTargetId 
 () 
 } 
 ` 
 );

Return

String — The target item ID.

`get Target Mime Type()`

If this is a Shortcut, returns the mime type of the item it points to.

Otherwise it returns null .

 // The ID of the file for which to make a shortcut and the ID of 
 // the folder to which you want to add the shortcut. 
 // TODO(developer): Replace the file and folder IDs with your IDs. 
 const 
  
 fileId 
  
 = 
  
 'abc123456' 
 ; 
 const 
  
 folderId 
  
 = 
  
 'xyz987654' 
 ; 
 // Gets the folder to add the shortcut to. 
 const 
  
 folder 
  
 = 
  
 DriveApp 
 . 
 getFolderById 
 ( 
 folderId 
 ); 
 // Creates a shortcut of the file and moves it to the specified folder. 
 const 
  
 shortcut 
  
 = 
  
 DriveApp 
 . 
 createShortcut 
 ( 
 fileId 
 ). 
 moveTo 
 ( 
 folder 
 ); 
 // Logs the MIME type of the file that the shortcut points to. 
 console 
 . 
 log 
 ( 
 `MIME type of the shortcut: 
 ${ 
 shortcut 
 . 
 getTargetMimeType 
 () 
 } 
 ` 
 );

Return

String — The target item mime type.

`get Target Resource Key()`

If the file is a shortcut, returns the resource key of the item it points to. A resource key is an additional parameter that you need to pass to access files that have been shared using a link.

If the file isn't a shortcut, it returns null .

 //  Gets a file by its ID. 
 //  TODO(developer): Replace 'abc123456' with your file ID. 
 const 
  
 file 
  
 = 
  
 DriveApp 
 . 
 getFileById 
 ( 
 'abc123456' 
 ); 
 // If the file is a shortcut, returns the resource key of the file that it 
 // points to. 
 console 
 . 
 log 
 ( 
 file 
 . 
 getTargetResourceKey 
 ());

Return

String — The target item's resource key or null if the file is not a shortcut.

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 Thumbnail()`

Gets a thumbnail image for the file, or null if no thumbnail exists.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // Logs the thumbnail image for each file to the console as a blob, 
  
 // or null if no thumbnail exists. 
  
 console 
 . 
 log 
 ( 
 file 
 . 
 getThumbnail 
 ()); 
 }

Return

Blob — The thumbnail image for the file.

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 File in a Google App like Drive or Docs.

Return

String — the URL that can be used to view this File 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 File . If the user who executes the script does not have edit access to the File , this method returns an empty array.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // For each file, logs the viewers' email addresses to the console. 
  
 const 
  
 viewers 
  
 = 
  
 file 
 . 
 getViewers 
 (); 
  
 for 
  
 ( 
 const 
  
 viewer 
  
 of 
  
 viewers 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 viewer 
 . 
 getEmail 
 ()); 
  
 } 
 }

Return

User[] — If the user has edit access for this File , returns the list of viewers and commenters. If the user doesn't have edit access, returns an empty array.

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 File 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 File has been starred in the user's Drive.

Return

Boolean — true if the File 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 File is in the trash of the user's Drive.

Return

Boolean — true if the File 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

`make Copy()`

Creates a copy of the file.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // Creates a copy of each file and logs the file name to the console. 
  
 console 
 . 
 log 
 ( 
 file 
 . 
 makeCopy 
 (). 
 getName 
 ()); 
 }

Return

File — The new copy.

Authorization

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

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

`make Copy(destination)`

Creates a copy of the file in the destination directory.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // Creates a copy of each file and adds it to the specified folder. 
  
 // TODO(developer): Replace the folder ID with your own. 
  
 const 
  
 destination 
  
 = 
  
 DriveApp 
 . 
 getFolderById 
 ( 
 '123456abcxyz' 
 ); 
  
 const 
  
 copiedFile 
  
 = 
  
 file 
 . 
 makeCopy 
 ( 
 destination 
 ); 
  
 // Logs the file names to the console. 
  
 console 
 . 
 log 
 ( 
 copiedFile 
 . 
 getName 
 ()); 
 }

Parameters

Name	Type	Description
`destination`	`Folder`	The directory to copy the file into.

Return

File — The new copy.

Authorization

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

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

`make Copy(name)`

Creates a copy of the file and names it with the name provided.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // Creates a copy of each file and sets the name to 'Test-Copy.' 
  
 const 
  
 filename 
  
 = 
  
 file 
 . 
 makeCopy 
 ( 
 'Test-Copy' 
 ); 
  
 // Logs the copied file's name to the console. 
  
 console 
 . 
 log 
 ( 
 filename 
 . 
 getName 
 ()); 
 }

Parameters

Name	Type	Description
`name`	`String`	The filename that should be applied to the new copy.

Return

File — The new copy.

Authorization

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

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

`make Copy(name, destination)`

Creates a copy of the file in the destination directory and names it with the name provided.

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // Creates a copy of each file, sets the file name, and adds the copied file 
  
 // to the specified folder. 
  
 // TODO(developer): Replace the folder ID with your own. 
  
 const 
  
 destination 
  
 = 
  
 DriveApp 
 . 
 getFolderById 
 ( 
 '123456abcxyz' 
 ); 
  
 const 
  
 copiedFile 
  
 = 
  
 file 
 . 
 makeCopy 
 ( 
 'Test-Copy' 
 , 
  
 destination 
 ); 
  
 // Logs the file names to the console. 
  
 console 
 . 
 log 
 ( 
 copiedFile 
 . 
 getName 
 ()); 
 }

Parameters

Name	Type	Description
`name`	`String`	The filename that should be applied to the new copy.
`destination`	`Folder`	The directory to copy the file into.

Return

File — The new copy.

Authorization

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

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

File — This File , 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 Commenter(emailAddress)`

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

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // Removes the given user from the list of commenters for each file. 
  
 // TODO(developer): Replace the email with the email of the user you want to 
  
 // remove. 
  
 file 
 . 
 removeCommenter 
 ( 
 'cloudysanfrancisco@gmail.com' 
 ); 
 }

Parameters

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

Return

File — This File , 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 Commenter(user)`

 // Gets a list of all files in Google Drive with the given name. 
 // TODO(developer): Replace the file name with your own. 
 const 
  
 files 
  
 = 
  
 DriveApp 
 . 
 getFilesByName 
 ( 
 'Test' 
 ); 
 // Loops through the files. 
 while 
  
 ( 
 files 
 . 
 hasNext 
 ()) 
  
 { 
  
 const 
  
 file 
  
 = 
  
 files 
 . 
 next 
 (); 
  
 // Removes the given user from the list of commenters for each file. 
  
 console 
 . 
 log 
 ( 
 file 
 . 
 removeCommenter 
 ( 
 Session 
 . 
 getActiveUser 
 ())); 
 }

Parameters

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

Return

File — This File , 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 File . This method doesn't block users from accessing the File if they belong to a class of users who have general access—for example, if the File is shared with the user's entire domain, or if the File 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

File — This File , 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

File — This File , 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 File . 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 File if they belong to a class of users who have general access—for example, if the File is shared with the user's entire domain, or if the File 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

File — This File 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 File . This method has no effect if the user is an editor, not a viewer. This method also doesn't block users from accessing the File if they belong to a class of users who have general access—for example, if the File is shared with the user's entire domain, or if the File 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

File — This File 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 File granted to the given user. This method doesn't block users from accessing the File if they belong to a class of users who have general access — for example, if the File 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

File — This File , 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

File — This File , 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 Content(content)`

Overwrites the content of the file with a given replacement. Throws an exception if content is larger than 10MB.

 // Creates a text file with the content 'Hello, world!' 
 const 
  
 file 
  
 = 
  
 DriveApp 
 . 
 createFile 
 ( 
 'New Text File' 
 , 
  
 'Hello, world!' 
 ); 
 // Logs the content of the text file to the console. 
 console 
 . 
 log 
 ( 
 file 
 . 
 getBlob 
 (). 
 getDataAsString 
 ()); 
 // Updates the content of the text file to 'Updated text!' 
 file 
 . 
 setContent 
 ( 
 'Updated text!' 
 ); 
 // Logs content of the text file to the console. 
 console 
 . 
 log 
 ( 
 file 
 . 
 getBlob 
 (). 
 getDataAsString 
 ());

Parameters

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

Return

File — This File , 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 Description(description)`

Sets the description for the File .

Parameters

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

Return

File — this File , 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 File .

Parameters

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

Return

File — this File , 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 File . This method also gives the previous owner explicit edit access to the File .

Parameters

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

Return

File — this File , 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 File . This method also gives the previous owner explicit edit access to the File .

Parameters

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

Return

File — this File , 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 File 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 `File` .

Return

File — This File , 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 File are allowed to share with other users or change the permissions. The default for a new File 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

File — this File , 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 File 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 `File`
`permission Type`	`Permission`	the permissions that should be granted to users who can access the `File`

Return

File — this File , 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 File is starred in the user's Drive. The default for new File s is false .

Parameters

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

Return

File — this File , 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 File is in the trash of the user's Drive. Only the owner may trash the File . The default for new File s is false .

Parameters

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

Return

File — this File , for chaining

Authorization

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

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

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

Methods

Detailed documentation

add Commenter(emailAddress)

Parameters

Return

Authorization

add Commenter(user)

Parameters

Return

Authorization

add Commenters(emailAddresses)

Parameters

Return

Authorization

add Editor(emailAddress)

Parameters

Return

Authorization

add Editor(user)

Parameters

Return

Authorization

add Editors(emailAddresses)

Parameters

Return

Authorization

add Viewer(emailAddress)

Parameters

Return

Authorization

add Viewer(user)

Parameters

Return

Authorization

add Viewers(emailAddresses)

Parameters

Return

Authorization

get Access(email)

Parameters

Return

Authorization

get Access(user)

Parameters

Return

Authorization

get As(contentType)

Parameters

Return

get Blob()

Return

get Date Created()

Return

Authorization

get Description()

Return

Authorization

get Download Url()

Return

Authorization

get Editors()

Return

Authorization

get Id()

Return

Authorization

get Last Updated()

Return

Authorization

get Mime Type()

Return

Authorization

get Name()

Return

Authorization

get Owner()

Return

Authorization

get Parents()

Class File

`add Commenter(emailAddress)`

`add Commenter(user)`

`add Commenters(emailAddresses)`

`add Editor(emailAddress)`

`add Editor(user)`

`add Editors(emailAddresses)`

`add Viewer(emailAddress)`

`add Viewer(user)`

`add Viewers(emailAddresses)`

`get Access(email)`

`get Access(user)`

`get As(contentType)`

`get Blob()`

`get Date Created()`

`get Description()`

`get Download Url()`

`get Editors()`

`get Id()`

`get Last Updated()`

`get Mime Type()`

`get Name()`

`get Owner()`

`get Parents()`

`get Resource Key()`

`get Security Update Eligible()`

`get Security Update Enabled()`

`get Sharing Access()`

`get Sharing Permission()`

`get Size()`

`get Target Id()`

`get Target Mime Type()`

`get Target Resource Key()`

`get Thumbnail()`

`get Url()`

`get Viewers()`

`is Shareable By Editors()`

`is Starred()`

`is Trashed()`

`make Copy()`

`make Copy(destination)`

`make Copy(name)`

`make Copy(name, destination)`

`move To(destination)`

`remove Commenter(emailAddress)`

`remove Commenter(user)`