Hide

Class File

File

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

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

Methods

MethodReturn typeBrief description
addCommenter(emailAddress)FileAdd the given user to the list of commenters for the File.
addCommenter(user)FileAdd the given user to the list of commenters for the File.
addCommenters(emailAddresses)FileAdd the given array of users to the list of commenters for the File.
addEditor(emailAddress)FileAdds the given user to the list of editors for the File.
addEditor(user)FileAdds the given user to the list of editors for the File.
addEditors(emailAddresses)FileAdds the given array of users to the list of editors for the File.
addViewer(emailAddress)FileAdds the given user to the list of viewers for the File.
addViewer(user)FileAdds the given user to the list of viewers for the File.
addViewers(emailAddresses)FileAdds the given array of users to the list of viewers for the File.
getAccess(email)PermissionGets the permission granted to the given user.
getAccess(user)PermissionGets the permission granted to the given user.
getAs(contentType)BlobReturn the data inside this object as a blob converted to the specified content type.
getBlob()BlobReturn the data inside this object as a blob.
getDateCreated()DateGets the date the File was created.
getDescription()StringGets the description for the File.
getDownloadUrl()StringGets the URL that can be used to download the file.
getEditors()User[]Gets the list of editors for this File.
getId()StringGets the ID of the File.
getLastUpdated()DateGets the date the File was last updated.
getMimeType()StringGets the MIME type of the file.
getName()StringGets the name of the File.
getOwner()UserGets the owner of the File.
getParents()FolderIteratorGets a collection of folders that are immediate parents of the File.
getSharingAccess()AccessGets which class of users can access the File, besides any individual users who have been explicitly given access.
getSharingPermission()PermissionGets the permission granted to those users who can access the File, besides any individual users who have been explicitly given access.
getSize()IntegerGets the number of bytes used to store the File in Drive.
getThumbnail()BlobGets a thumbnail image for the file, or null if no thumbnail exists.
getUrl()StringGets the URL that can be used to open the File in a Google App like Drive or Docs.
getViewers()User[]Gets the list of viewers and commenters for this File.
isShareableByEditors()BooleanDetermines whether users with edit permissions to the File are allowed to share with other users or change the permissions.
isStarred()BooleanDetermines whether the File has been starred in the user's Drive.
isTrashed()BooleanDetermines whether the File is in the trash of the user's Drive.
makeCopy()FileCreates a copy of the file.
makeCopy(destination)FileCreates a copy of the file in the destination directory.
makeCopy(name)FileCreates a copy of the file and names it with the name provided.
makeCopy(name, destination)FileCreates a copy of the file in the destination directory and names it with the name provided.
removeCommenter(emailAddress)FileRemoves the given user from the list of commenters for the File.
removeCommenter(user)FileRemoves the given user from the list of commenters for the File.
removeEditor(emailAddress)FileRemoves the given user from the list of editors for the File.
removeEditor(user)FileRemoves the given user from the list of editors for the File.
removeViewer(emailAddress)FileRemoves the given user from the list of viewers and commenters for the File.
removeViewer(user)FileRemoves the given user from the list of viewers and commenters for the File.
revokePermissions(user)FileRevokes the access to the File granted to the given user.
revokePermissions(user)FileRevokes the access to the File granted to the given user.
setContent(content)FileOverwrites the content of the file with a given replacement.
setDescription(description)FileSets the description for the File.
setName(name)FileSets the name of the File.
setOwner(emailAddress)FileChanges the owner of the File.
setOwner(user)FileChanges the owner of the File.
setShareableByEditors(shareable)FileSets whether users with edit permissions to the File are allowed to share with other users or change the permissions.
setSharing(accessType, permissionType)FileSets 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.
setStarred(starred)FileSets whether the File is starred in the user's Drive.
setTrashed(trashed)FileSets whether the File is in the trash of the user's Drive.

Detailed documentation

addCommenter(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.

Parameters

NameTypeDescription
emailAddressStringthe email address of the user to add

Return

File — this File, for chaining


addCommenter(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.

Parameters

NameTypeDescription
userUsera representation of the user to add

Return

File — this File, for chaining


addCommenters(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.

Parameters

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

Return

File — this File, for chaining


addEditor(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

NameTypeDescription
emailAddressStringthe email address of the user to add

Return

File — this File, for chaining


addEditor(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

NameTypeDescription
userUsera representation of the user to add

Return

File — this File, for chaining


addEditors(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

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

Return

File — this File, for chaining


addViewer(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

NameTypeDescription
emailAddressStringthe email address of the user to add

Return

File — this File, for chaining


addViewer(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

NameTypeDescription
userUsera representation of the user to add

Return

File — this File, for chaining


addViewers(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

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

Return

File — this File, for chaining


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


getAs(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, "ChristmasList.12.25.2014" will become "ChristmasList.12.25.pdf".

Parameters

NameTypeDescription
contentTypeStringthe 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.

Return

Blob — the data as a blob


getBlob()

Return the data inside this object as a blob.

Return

Blob — the data as a blob


getDateCreated()

Gets the date the File was created.

Return

Date — the date the File was created


getDescription()

Gets the description for the File.

Return

String — the description for the File


getDownloadUrl()

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.

Return

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


getEditors()

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.

Return

User[] — an array of users with edit permission


getId()

Gets the ID of the File.

Return

String — the ID of the File


getLastUpdated()

Gets the date the File was last updated.

Return

Date — the date the File was last updated


getMimeType()

Gets the MIME type of the file.

Return

String — the MIME type of the file


getName()

Gets the name of the File.

Return

String — the name of the File


getOwner()

Gets the owner of the File.

Return

User — a User object representing the owner


getParents()

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

Return

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


getSharingAccess()

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


getSharingPermission()

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


getSize()

Gets the number of bytes used to store the File 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 File in Drive


getThumbnail()

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

Return

Blob — the thumbnail image for the file


getUrl()

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


getViewers()

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.

Return

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


isShareableByEditors()

Determines whether users with edit permissions to the File 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 File has been starred in the user's Drive.

Return

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


isTrashed()

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

Return

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


makeCopy()

Creates a copy of the file.

Return

File — the new copy


makeCopy(destination)

Creates a copy of the file in the destination directory.

Parameters

NameTypeDescription
destinationFolderthe directory to copy the file into.

Return

File — the new copy


makeCopy(name)

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

Parameters

NameTypeDescription
nameStringthe filename that should be applied to the new copy

Return

File — the new copy


makeCopy(name, destination)

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

Parameters

NameTypeDescription
nameStringthe filename that should be applied to the new copy
destinationFolderthe directory to copy the file into.

Return

File — the new copy


removeCommenter(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.

Parameters

NameTypeDescription
emailAddressStringthe email address of the user to remove

Return

File — this File, for chaining


removeCommenter(user)

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.

Parameters

NameTypeDescription
userUsera representation of the user to remove

Return

File — this File, for chaining


removeEditor(emailAddress)

Removes the given user from the list of editors for the File. This method does not 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

NameTypeDescription
emailAddressStringthe email address of the user to remove

Return

File — this File, for chaining


removeEditor(user)

Removes the given user from the list of editors for the File. This method does not 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

NameTypeDescription
userUsera representation of the user to remove

Return

File — this File, for chaining


removeViewer(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 does not 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

NameTypeDescription
emailAddressStringthe email address of the user to remove

Return

File — this File for chaining


removeViewer(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 does not 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

NameTypeDescription
userUsera representation of the user to remove

Return

File — this File for chaining


revokePermissions(user)

Revokes the access to the File granted to the given user. This method does not 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

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

Return

File — this File, for chaining


revokePermissions(user)

Revokes the access to the File granted to the given user. This method does not 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

NameTypeDescription
userUsera representation of the user whose access should be revoked

Return

File — this File, for chaining


setContent(content)

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

Parameters

NameTypeDescription
contentStringthe new content for the file

Return

File — this File, for chaining


setDescription(description)

Sets the description for the File.

Parameters

NameTypeDescription
descriptionStringthe new description for the File

Return

File — this File, for chaining


setName(name)

Sets the name of the File.

Parameters

NameTypeDescription
nameStringthe new name of the File

Return

File — this File, for chaining


setOwner(emailAddress)

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

Parameters

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

Return

File — this File, for chaining


setOwner(user)

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

Parameters

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

Return

File — this File, for chaining


setShareableByEditors(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

NameTypeDescription
shareableBooleantrue 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


setSharing(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 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 File
permissionTypePermissionthe permissions that should be granted to users who can access the File

Return

File — this File, for chaining


setStarred(starred)

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

Parameters

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

Return

File — this File, for chaining


setTrashed(trashed)

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

Parameters

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

Return

File — this File, for chaining

Send feedback about...

Apps Script