Blob of arbitrary data.
*
*
* // Create an image file in Google Drive using the Maps service.
* var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
* DriveApp.createFile(blob);
* content is larger than 50 MB.
*
*
* // Create a text file with the content "Hello, world!"
* DriveApp.createFile('New Text File', 'Hello, world!');
* content is larger than 10MB.
*
*
* // Create an HTML file with the content "Hello, world!"
* DriveApp.createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);
* See the Simplifying Google Drive’s folder structure and sharing models blog for
* more details.
*
* @param value - The new state of the enforceSingleParent flag.
*/
function enforceSingleParent(
value: Boolean
): void
/**
* Gets the file with the given ID. Throws a scripting exception if the file does not exist or the
* user does not have permission to access it.
*
* @param id - the ID of the file
*
* @returns the file with the given ID
*/
function getFileById(
id: string
): DriveApp.File
/**
* Gets a collection of all files in the user's Drive.
*
* @returns A collection of all files in the user's Drive.
*/
function getFiles(): DriveApp.FileIterator
/**
* Gets a collection of all files in the user's Drive that have the given name.
*
* @param name - The name of the files to find.
*
* @returns A collection of all files in the user's Drive that have the given name.
*/
function getFilesByName(
name: string
): DriveApp.FileIterator
/**
* Gets a collection of all files in the user's Drive that have the given MIME type.
*
* @param mimeType - The MIME type of the files to find.
*
* @returns A collection of all files in the user's Drive that have the given MIME
* type.
*/
function getFilesByType(
mimeType: string
): DriveApp.FileIterator
/**
* Gets the folder with the given ID. Throws a scripting exception if the folder does not exist or
* the user does not have permission to access it.
*
* @param id - the ID of the folder
*
* @returns the folder with the given ID
*/
function getFolderById(
id: string
): DriveApp.Folder
/**
* Gets a collection of all folders in the user's Drive.
*
* @returns A collection of all folders in the user's Drive.
*/
function getFolders(): DriveApp.FolderIterator
/**
* Gets a collection of all folders in the user's Drive that have the given name.
*
* @param name - The name of the folders to find.
*
* @returns A collection of all folders in the user's Drive that have the given name.
*/
function getFoldersByName(
name: string
): DriveApp.FolderIterator
/**
* Gets the folder at the root of the user's Drive.
*
* @returns the root folder of the user's Drive
*/
function getRootFolder(): DriveApp.Folder
/**
* Gets the number of bytes the user is allowed to store in Drive.
*
* @returns the number of bytes the user is allowed to store in Drive
*/
function getStorageLimit(): number
/**
* Gets the number of bytes the user is currently storing in Drive.
*
* @returns the number of bytes the user is currently storing in Drive
*/
function getStorageUsed(): number
/**
* Gets a collection of all the files in the trash of the user's Drive.
*
* @returns a collection of files in the trash
*/
function getTrashedFiles(): DriveApp.FileIterator
/**
* Gets a collection of all the folders in the trash of the user's Drive.
*
* @returns a collection of folders in the trash
*/
function getTrashedFolders(): DriveApp.FolderIterator
/**
* Removes the given file from the root of the user's Drive. 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.
*
* @param child - The child file to remove.
*
* @returns The previous parent of the child.
*/
function removeFile(
child: DriveApp.File
): DriveApp.Folder
/**
* Removes the given folder from the root of the user's Drive. 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.
*
* @param child - The child folder to remove.
*
* @returns The previous parent of the child.
*/
function removeFolder(
child: DriveApp.Folder
): DriveApp.Folder
/**
* Gets a collection of all files in the user's Drive that match the given search
* criteria. The search criteria are detailed in the Google Drive SDK documentation. Note that the params argument is a query string that may contain string values, so take care to escape
* quotation marks correctly (for example "title contains 'Gulliver\\'s Travels'" or
* 'title contains "Gulliver\'s Travels"').
*
*
* // Log the name of every file in the user's Drive that modified after February 28,
* // 2013 whose name contains "untitled".
* var files = DriveApp.searchFiles(
* 'modifiedDate > "2013-02-28" and title contains "untitled"');
* while (files.hasNext()) {
* var file = files.next();
* Logger.log(file.getName());
* }
* params argument is a query string that may contain string values, so take care to escape
* quotation marks correctly (for example "title contains 'Gulliver\\'s Travels'" or
* 'title contains "Gulliver\'s Travels"').
*
*
* // Log the name of every folder in the user's Drive that you own and is starred.
* var folders = DriveApp.searchFolders('starred = true and "me" in owners');
* while (folders.hasNext()) {
* var folder = folders.next();
* Logger.log(folder.getName());
* }
* Domain administrators can prohibit this setting for users of a G Suite domain. If the
* setting is disabled, passing this value to File.setSharing(accessType, permissionType)
* throws an exception.
*/
ANYONE = "ANYONE",
/**
* Anyone who has the link can access. No sign-in required.
*
*
Domain administrators can prohibit this setting for users of a G Suite domain. If the
* setting is disabled, passing this value to File.setSharing(accessType, permissionType)
* throws an exception.
*/
ANYONE_WITH_LINK = "ANYONE_WITH_LINK",
/**
* People in your domain can find and access. Sign-in required.
*
*
This setting is available only for users of a G Suite domain. For other types of Google
* accounts, passing this value to File.setSharing(accessType, permissionType) throws an
* exception.
*/
DOMAIN = "DOMAIN",
/**
* People in your domain who have the link can access. Sign-in required.
*
*
This setting is available only for users of a G Suite domain. For other types of Google
* accounts, passing this value to File.setSharing(accessType, permissionType) throws an
* exception.
*/
DOMAIN_WITH_LINK = "DOMAIN_WITH_LINK",
/**
* Only people explicitly granted permission can access. Sign-in required.
*/
PRIVATE = "PRIVATE",
}
class File {
private constructor();
/**
* 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.
*
* @param emailAddress - The email address of the user to add.
*
* @returns This File, for chaining.
*/
addCommenter(
emailAddress: string
): DriveApp.File
/**
* 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.
*
* @param user - A representation of the user to add.
*
* @returns This File, for chaining.
*/
addCommenter(
user: User
): DriveApp.File
/**
* 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.
*
* @param emailAddresses - An array of email addresses of the users to add.
*
* @returns This File, for chaining.
*/
addCommenters(
emailAddresses: string[]
): DriveApp.File
/**
* 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.
*
* @param emailAddress - The email address of the user to add.
*
* @returns This File, for chaining.
*/
addEditor(
emailAddress: string
): DriveApp.File
/**
* 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.
*
* @param user - A representation of the user to add.
*
* @returns This File, for chaining.
*/
addEditor(
user: User
): DriveApp.File
/**
* 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.
*
* @param emailAddresses - An array of email addresses of the users to add.
*
* @returns This File, for chaining.
*/
addEditors(
emailAddresses: string[]
): DriveApp.File
/**
* 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.
*
* @param emailAddress - The email address of the user to add.
*
* @returns This File, for chaining.
*/
addViewer(
emailAddress: string
): DriveApp.File
/**
* 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.
*
* @param user - A representation of the user to add.
*
* @returns This File, for chaining.
*/
addViewer(
user: User
): DriveApp.File
/**
* 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.
*
* @param emailAddresses - An array of email addresses of the users to add.
*
* @returns This File, for chaining.
*/
addViewers(
emailAddresses: string[]
): DriveApp.File
/**
* Gets the permission granted to the given user.
*
* @param email - the email address of the user whose permissions should be checked
*
* @returns the permissions granted to the user
*/
getAccess(
email: string
): DriveApp.Permission
/**
* Gets the permission granted to the given user.
*
* @param user - a representation of the user whose permissions should be checked
*
* @returns the permissions granted to the user
*/
getAccess(
user: User
): DriveApp.Permission
/**
* 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 G Suite domains might be temporarily subject to stricter quotas.
*
* @param contentType - 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.
*
* @returns The data as a blob.
*/
getAs(
contentType: string
): Blob
/**
* Return the data inside this object as a blob.
*
* @returns The data as a blob.
*/
getBlob(): Blob
/**
* Gets the date the File was created.
*
* @returns the date the File was created
*/
getDateCreated(): Date
/**
* Gets the description for the File.
*
* @returns the description for the File
*/
getDescription(): string
/**
* 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 UrlFetchApp. If you want the contents of the
* file in the script, use getBlob().
*
* @returns The URL that can be used to download the file.
*/
getDownloadUrl(): string
/**
* 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.
*
* @returns An array of users with edit permission.
*/
getEditors(): DriveApp.User[]
/**
* Gets the ID of the File.
*
* @returns the ID of the File
*/
getId(): string
/**
* Gets the date the File was last updated.
*
* @returns the date the File was last updated
*/
getLastUpdated(): Date
/**
* Gets the MIME type of the file.
*
* @returns The MIME type of the file.
*/
getMimeType(): string
/**
* Gets the name of the File.
*
* @returns the name of the File
*/
getName(): string
/**
* Gets the owner of the File.
*
* @returns a User object representing the owner
*/
getOwner(): DriveApp.User
/**
* Gets a collection of folders that are immediate parents of the File.
*
* @returns a collection of folders that are immediate parents of the File
*/
getParents(): DriveApp.FolderIterator
/**
* Gets which class of users can access the File, besides any individual
* users who have been explicitly given access.
*
* @returns which class of users can access the File
*/
getSharingAccess(): DriveApp.Access
/**
* Gets the permission granted to those users who can access the File,
* besides any individual users who have been explicitly given access.
*
* @returns the permissions granted to users who can access the File
*/
getSharingPermission(): DriveApp.Permission
/**
* Gets the number of bytes used to store the File in Drive. Note that G
* Suite application files do not count toward Drive storage limits and thus return 0
* bytes.
*
* @returns the number of bytes used to store the File in Drive
*/
getSize(): number
/**
* If this is a Shortcut, returns the ID of the item it points to.
*
*
Otherwise it returns null.
*
* @returns The target item ID.
*/
getTargetId(): string
/**
* If this is a Shortcut, returns the mime type of the item it points to.
*
*
Otherwise it returns null.
*
* @returns The target item mime type.
*/
getTargetMimeType(): string
/**
* Gets a thumbnail image for the file, or null if no thumbnail exists.
*
* @returns The thumbnail image for the file.
*/
getThumbnail(): Blob
/**
* Gets the URL that can be used to open the File in a Google App like
* Drive or Docs.
*
* @returns the URL that can be used to view this File in a Google App like
* Drive or Docs
*/
getUrl(): string
/**
* 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.
*
* @returns An array of users with view or comment permission.
*/
getViewers(): DriveApp.User[]
/**
* Determines whether users with edit permissions to the File are allowed to
* share with other users or change the permissions.
*
* @returns true if users with edit permissions are allowed to share with other users or
* change the permissions; false if not
*/
isShareableByEditors(): Boolean
/**
* Determines whether the File has been starred in the user's Drive.
*
* @returns true if the File is starred in the user's Drive; false if not
*/
isStarred(): Boolean
/**
* Determines whether the File is in the trash of the user's Drive.
*
* @returns true if the File is in the trash of the user's Drive;
* false if not
*/
isTrashed(): Boolean
/**
* Creates a copy of the file.
*
* @returns The new copy.
*/
makeCopy(): DriveApp.File
/**
* Creates a copy of the file in the destination directory.
*
* @param destination - The directory to copy the file into.
*
* @returns The new copy.
*/
makeCopy(
destination: DriveApp.Folder
): DriveApp.File
/**
* Creates a copy of the file and names it with the name provided.
*
* @param name - The filename that should be applied to the new copy.
*
* @returns The new copy.
*/
makeCopy(
name: string
): DriveApp.File
/**
* Creates a copy of the file in the destination directory and names it with the name provided.
*
* @param name - The filename that should be applied to the new copy.
* @param destination - The directory to copy the file into.
*
* @returns The new copy.
*/
makeCopy(
name: string,
destination: DriveApp.Folder
): DriveApp.File
/**
* 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.
*
* @param destination - The folder that becomes the new parent.
*
* @returns This File, for chaining.
*/
moveTo(
destination: DriveApp.Folder
): DriveApp.File
/**
* 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.
*
* @param emailAddress - The email address of the user to remove.
*
* @returns This File, for chaining.
*/
removeCommenter(
emailAddress: string
): DriveApp.File
/**
* 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.
*
* @param user - A representation of the user to remove.
*
* @returns This File, for chaining.
*/
removeCommenter(
user: User
): DriveApp.File
/**
* 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.
*
* @param emailAddress - The email address of the user to remove.
*
* @returns This File, for chaining.
*/
removeEditor(
emailAddress: string
): DriveApp.File
/**
* 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.
*
* @param user - A representation of the user to remove.
*
* @returns This File, for chaining.
*/
removeEditor(
user: User
): DriveApp.File
/**
* 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.
*
* @param emailAddress - The email address of the user to remove.
*
* @returns This File for chaining.
*/
removeViewer(
emailAddress: string
): DriveApp.File
/**
* 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.
*
* @param user - A representation of the user to remove.
*
* @returns This File for chaining.
*/
removeViewer(
user: User
): DriveApp.File
/**
* 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.
*
* @param user - the email address of the user whose access should be revoked
*
* @returns this File, for chaining
*/
revokePermissions(
user: string
): DriveApp.File
/**
* 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.
*
* @param user - a representation of the user whose access should be revoked
*
* @returns this File, for chaining
*/
revokePermissions(
user: User
): DriveApp.File
/**
* Overwrites the content of the file with a given replacement. Throws an exception if content is larger than 10MB.
*
*
*
* @param content - The new content for the file.
*
* @returns This File, for chaining.
*/
setContent(
content: string
): DriveApp.File
/**
* Sets the description for the File.
*
* @param description - the new description for the File
*
* @returns this File, for chaining
*/
setDescription(
description: string
): DriveApp.File
/**
* Sets the name of the File.
*
* @param name - the new name of the File
*
* @returns this File, for chaining
*/
setName(
name: string
): DriveApp.File
/**
* Changes the owner of the File. This method also gives the previous owner
* explicit edit access to the File.
*
* @param emailAddress - the email address of the user who should become the new owner
*
* @returns this File, for chaining
*/
setOwner(
emailAddress: string
): DriveApp.File
/**
* Changes the owner of the File. This method also gives the previous owner
* explicit edit access to the File.
*
* @param user - a representation of the user who should become the new owner
*
* @returns this File, for chaining
*/
setOwner(
user: User
): DriveApp.File
/**
* 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.
*
* @param shareable - true if users with edit permissions should be allowed to share with
* other users or change the permissions; false if not
*
* @returns this File, for chaining
*/
setShareableByEditors(
shareable: Boolean
): DriveApp.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.
*
*
* // Creates a folder that anyone on the Internet can read from and write to. (Domain
* // administrators can prohibit this setting for users of a G Suite domain.)
* var folder = DriveApp.createFolder('Shared Folder');
* folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
*
*
* @param accessType - which class of users should be able to access the File
* @param permissionType - the permissions that should be granted to users who can access the File
*
* @returns this File, for chaining
*/
setSharing(
accessType: DriveApp.Access,
permissionType: DriveApp.Permission
): DriveApp.File
/**
* Sets whether the File is starred in the user's Drive. The default for
* new Files is false.
*
* @param starred - true if the File should be starred in the user's
* Drive; false if not
*
* @returns this File, for chaining
*/
setStarred(
starred: Boolean
): DriveApp.File
/**
* Sets whether the File is in the trash of the user's Drive. Only the
* owner may trash the File. The default for new Files is false.
*
* @param trashed - true if the File should be moved to the trash of
* the user's Drive; false if not
*
* @returns this File, for chaining
*/
setTrashed(
trashed: Boolean
): DriveApp.File
}
class FileIterator {
private constructor();
/**
* Gets a token that can be used to resume this iteration at a later time. This method is useful
* if processing an iterator in one execution would exceed the maximum execution time.
* Continuation tokens are generally valid for one week.
*
* @returns a continuation token that can be used to resume this iteration with the items that
* remained in the iterator when the token was generated
*/
getContinuationToken(): string
/**
* Determines whether calling next() will return an item.
*
* @returns true if next() will return an item; false if not
*/
hasNext(): Boolean
/**
* Gets the next item in the collection of files or folders. Throws an exception if no items
* remain.
*
* @returns the next item in the collection
*/
next(): DriveApp.File
}
class Folder {
private constructor();
/**
* 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.
*
* @param emailAddress - The email address of the user to add.
*
* @returns This Folder, for chaining.
*/
addEditor(
emailAddress: string
): DriveApp.Folder
/**
* 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.
*
* @param user - A representation of the user to add.
*
* @returns This Folder, for chaining.
*/
addEditor(
user: User
): DriveApp.Folder
/**
* 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.
*
* @param emailAddresses - An array of email addresses of the users to add.
*
* @returns This Folder, for chaining.
*/
addEditors(
emailAddresses: string[]
): DriveApp.Folder
/**
* 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.
*
* @param child - The child file to add.
*
* @returns The new parent of the file added as a child.
*/
addFile(
child: DriveApp.File
): DriveApp.Folder
/**
* 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.
*
* @param child - The child folder to add.
*
* @returns The new parent of the folder added as a child.
*/
addFolder(
child: DriveApp.Folder
): DriveApp.Folder
/**
* 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.
*
* @param emailAddress - The email address of the user to add.
*
* @returns This Folder, for chaining.
*/
addViewer(
emailAddress: string
): DriveApp.Folder
/**
* 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.
*
* @param user - A representation of the user to add.
*
* @returns This Folder, for chaining.
*/
addViewer(
user: User
): DriveApp.Folder
/**
* 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.
*
* @param emailAddresses - An array of email addresses of the users to add.
*
* @returns This Folder, for chaining.
*/
addViewers(
emailAddresses: string[]
): DriveApp.Folder
/**
* Creates a file in the current folder from a given Blob of arbitrary data.
*
*
* // Create an image file in Google Drive using the Maps service.
* var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
* DriveApp.getRootFolder().createFile(blob);
* content is larger than 50 MB.
*
*
* // Create a text file with the content "Hello, world!"
* DriveApp.getRootFolder().createFile('New Text File', 'Hello, world!');
* 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);
* Folder was created.
*
* @returns the date the Folder was created
*/
getDateCreated(): Date
/**
* Gets the description for the Folder.
*
* @returns the description for the Folder
*/
getDescription(): string
/**
* 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.
*
* @returns An array of users with edit permission.
*/
getEditors(): DriveApp.User[]
/**
* Gets a collection of all files that are children of the current folder.
*
* @returns A collection of all files that are children of the current folder.
*/
getFiles(): DriveApp.FileIterator
/**
* Gets a collection of all files that are children of the current folder and have the given name.
*
* @param name - The name of the files to find.
*
* @returns A collection of all files that are children of the current folder and have the given name.
*/
getFilesByName(
name: string
): DriveApp.FileIterator
/**
* Gets a collection of all files that are children of the current folder and have the given MIME type.
*
* @param mimeType - The MIME type of the files to find.
*
* @returns A collection of all files that are children of the current folder and have the given MIME
* type.
*/
getFilesByType(
mimeType: string
): DriveApp.FileIterator
/**
* Gets a collection of all folders that are children of the current folder.
*
* @returns A collection of all folders that are children of the current folder.
*/
getFolders(): DriveApp.FolderIterator
/**
* Gets a collection of all folders that are children of the current folder and have the given name.
*
* @param name - The name of the folders to find.
*
* @returns A collection of all folders that are children of the current folder and have the given name.
*/
getFoldersByName(
name: string
): DriveApp.FolderIterator
/**
* Gets the ID of the Folder.
*
* @returns the ID of the Folder
*/
getId(): string
/**
* Gets the date the Folder was last updated.
*
* @returns the date the Folder was last updated
*/
getLastUpdated(): Date
/**
* Gets the name of the Folder.
*
* @returns the name of the Folder
*/
getName(): string
/**
* Gets the owner of the Folder.
*
* @returns a User object representing the owner
*/
getOwner(): DriveApp.User
/**
* Gets a collection of folders that are immediate parents of the Folder.
*
* @returns a collection of folders that are immediate parents of the Folder
*/
getParents(): DriveApp.FolderIterator
/**
* Gets which class of users can access the Folder, besides any individual
* users who have been explicitly given access.
*
* @returns which class of users can access the Folder
*/
getSharingAccess(): DriveApp.Access
/**
* Gets the permission granted to those users who can access the Folder,
* besides any individual users who have been explicitly given access.
*
* @returns the permissions granted to users who can access the Folder
*/
getSharingPermission(): DriveApp.Permission
/**
* Gets the number of bytes used to store the Folder in Drive. Note that G
* Suite application files do not count toward Drive storage limits and thus return 0
* bytes.
*
* @returns the number of bytes used to store the Folder in Drive
*/
getSize(): number
/**
* Gets the URL that can be used to open the Folder in a Google App like
* Drive or Docs.
*
* @returns the URL that can be used to view this Folder in a Google App like
* Drive or Docs
*/
getUrl(): string
/**
* 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.
*
* @returns An array of users with view or comment permission.
*/
getViewers(): DriveApp.User[]
/**
* Determines whether users with edit permissions to the Folder are allowed to
* share with other users or change the permissions.
*
* @returns true if users with edit permissions are allowed to share with other users or
* change the permissions; false if not
*/
isShareableByEditors(): Boolean
/**
* Determines whether the Folder has been starred in the user's Drive.
*
* @returns true if the Folder is starred in the user's Drive; false if not
*/
isStarred(): Boolean
/**
* Determines whether the Folder is in the trash of the user's Drive.
*
* @returns true if the Folder is in the trash of the user's Drive;
* false if not
*/
isTrashed(): Boolean
/**
* 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.
*
* @param destination - The folder that becomes the new parent.
*
* @returns This Folder, for chaining.
*/
moveTo(
destination: DriveApp.Folder
): DriveApp.Folder
/**
* 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.
*
* @param emailAddress - The email address of the user to remove.
*
* @returns This Folder, for chaining.
*/
removeEditor(
emailAddress: string
): DriveApp.Folder
/**
* 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.
*
* @param user - A representation of the user to remove.
*
* @returns This Folder, for chaining.
*/
removeEditor(
user: User
): DriveApp.Folder
/**
* 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.
*
* @param child - The child file to remove.
*
* @returns The previous parent of the child.
*/
removeFile(
child: DriveApp.File
): DriveApp.Folder
/**
* 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.
*
* @param child - The child folder to remove.
*
* @returns The previous parent of the child.
*/
removeFolder(
child: DriveApp.Folder
): DriveApp.Folder
/**
* 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.
*
* @param emailAddress - The email address of the user to remove.
*
* @returns This Folder for chaining.
*/
removeViewer(
emailAddress: string
): DriveApp.Folder
/**
* 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.
*
* @param user - A representation of the user to remove.
*
* @returns This Folder for chaining.
*/
removeViewer(
user: User
): DriveApp.Folder
/**
* Revokes the access to the Folder granted to the given user. This method does
* not block users from accessing the Folder if they belong to a class of users
* who have general access — for example, if the Folder is shared with the user's
* entire domain.
*
* @param user - the email address of the user whose access should be revoked
*
* @returns this Folder, for chaining
*/
revokePermissions(
user: string
): DriveApp.Folder
/**
* Revokes the access to the Folder granted to the given user. This method does
* not block users from accessing the Folder if they belong to a class of users
* who have general access — for example, if the Folder is shared with the user's
* entire domain.
*
* @param user - a representation of the user whose access should be revoked
*
* @returns this Folder, for chaining
*/
revokePermissions(
user: User
): DriveApp.Folder
/**
* 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 params argument is a query string that may contain string values, so take care to escape
* quotation marks correctly (for example "title contains 'Gulliver\\'s Travels'" or
* 'title contains "Gulliver\'s Travels"').
*
*
* // Log the name of every file that are children of the current folder and modified after February 28,
* // 2013 whose name contains "untitled".
* var files = DriveApp.getRootFolder().searchFiles(
* 'modifiedDate > "2013-02-28" and title contains "untitled"');
* while (files.hasNext()) {
* var file = files.next();
* Logger.log(file.getName());
* }
* params argument is a query string that may contain string values, so take care to escape
* quotation marks correctly (for example "title contains 'Gulliver\\'s Travels'" or
* 'title contains "Gulliver\'s Travels"').
*
*
* // Log the name of every folder that are children of the current folder and you own and is starred.
* var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
* while (folders.hasNext()) {
* var folder = folders.next();
* Logger.log(folder.getName());
* }
* Folder.
*
* @param description - the new description for the Folder
*
* @returns this Folder, for chaining
*/
setDescription(
description: string
): DriveApp.Folder
/**
* Sets the name of the Folder.
*
* @param name - the new name of the Folder
*
* @returns this Folder, for chaining
*/
setName(
name: string
): DriveApp.Folder
/**
* Changes the owner of the Folder. This method also gives the previous owner
* explicit edit access to the Folder.
*
* @param emailAddress - the email address of the user who should become the new owner
*
* @returns this Folder, for chaining
*/
setOwner(
emailAddress: string
): DriveApp.Folder
/**
* Changes the owner of the Folder. This method also gives the previous owner
* explicit edit access to the Folder.
*
* @param user - a representation of the user who should become the new owner
*
* @returns this Folder, for chaining
*/
setOwner(
user: User
): DriveApp.Folder
/**
* 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.
*
* @param shareable - true if users with edit permissions should be allowed to share with
* other users or change the permissions; false if not
*
* @returns this Folder, for chaining
*/
setShareableByEditors(
shareable: Boolean
): DriveApp.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.
*
*
* // Creates a folder that anyone on the Internet can read from and write to. (Domain
* // administrators can prohibit this setting for users of a G Suite domain.)
* var folder = DriveApp.createFolder('Shared Folder');
* folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
*
*
* @param accessType - which class of users should be able to access the Folder
* @param permissionType - the permissions that should be granted to users who can access the Folder
*
* @returns this Folder, for chaining
*/
setSharing(
accessType: DriveApp.Access,
permissionType: DriveApp.Permission
): DriveApp.Folder
/**
* Sets whether the Folder is starred in the user's Drive. The default for
* new Folders is false.
*
* @param starred - true if the Folder should be starred in the user's
* Drive; false if not
*
* @returns this Folder, for chaining
*/
setStarred(
starred: Boolean
): DriveApp.Folder
/**
* Sets whether the Folder is in the trash of the user's Drive. Only the
* owner may trash the Folder. The default for new Folders is false.
*
* @param trashed - true if the Folder should be moved to the trash of
* the user's Drive; false if not
*
* @returns this Folder, for chaining
*/
setTrashed(
trashed: Boolean
): DriveApp.Folder
}
class FolderIterator {
private constructor();
/**
* Gets a token that can be used to resume this iteration at a later time. This method is useful
* if processing an iterator in one execution would exceed the maximum execution time.
* Continuation tokens are generally valid for one week.
*
* @returns a continuation token that can be used to resume this iteration with the items that
* remained in the iterator when the token was generated
*/
getContinuationToken(): string
/**
* Determines whether calling next() will return an item.
*
* @returns true if next() will return an item; false if not
*/
hasNext(): Boolean
/**
* Gets the next item in the collection of files or folders. Throws an exception if no items
* remain.
*
* @returns the next item in the collection
*/
next(): DriveApp.Folder
}
enum Permission {
/**
* Users who can access the file or folder are able only to view it, copy it, or comment on it.
* Passing this value to File.setSharing(accessType, permissionType) throws an exception if
* the type of file does not support it.
*/
COMMENT = "COMMENT",
/**
* Users who can access the file or folder are able to edit it. Unless File.setShareableByEditors(shareable) is set to false, users can also change the sharing
* settings. Passing this value to File.setSharing(accessType, permissionType) throws an
* exception if the type of file does not support it.
*/
EDIT = "EDIT",
/**
* Users who can edit, trash, and move content within a shared drive. This value can be returned,
* but passing it to File.setSharing(accessType, permissionType) throws an exception.
*/
FILE_ORGANIZER = "FILE_ORGANIZER",
/**
* The user does not have any permissions for the file or folder. This value can be returned, but
* passing it to File.setSharing(accessType, permissionType) throws an exception unless it
* is set in combination with Access.ANYONE.
*/
NONE = "NONE",
/**
* Users who can organize files and folders within a shared drive. This value can be returned, but
* passing it to File.setSharing(accessType, permissionType) throws an exception.
*/
ORGANIZER = "ORGANIZER",
/**
* The user owns the file or folder. This value can be returned, but passing it to File.setSharing(accessType, permissionType) throws an exception.
*/
OWNER = "OWNER",
/**
* Users who can access the file or folder are able only to view it or copy it. Passing this value
* to File.setSharing(accessType, permissionType) throws an exception if the type of file
* does not support it.
*/
VIEW = "VIEW",
}
class User {
private constructor();
/**
* Gets the domain name associated with the user's account.
*
*
* // Log the domain names associated with all users who have edit access to a file.
* var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
* var editors = file.getEditors();
* for (var i = 0; i < editors.length; i++) {
* Logger.log(editors[i].getDomain());
* }
*
* // Log the email address of all users who have edit access to a file.
* var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
* var editors = file.getEditors();
* for (var i = 0; i < editors.length; i++) {
* Logger.log(editors[i].getEmail());
* }
* null if the user's name is not available.
*
*
* // Log the names of all users who have edit access to a file.
* var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
* var editors = file.getEditors();
* for (var i = 0; i < editors.length; i++) {
* Logger.log(editors[i].getName());
* }
* null if the name is not available
*/
getName(): string
/**
* Gets the URL for the user's photo. This method returns null if the user's photo is not
* available.
*
*
* // Log the URLs for the photos of all users who have edit access to a file.
* var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz');
* var editors = file.getEditors();
* for (var i = 0; i < editors.length; i++) {
* Logger.log(editors[i].getPhotoUrl());
* }
* null if the photo is not available
*/
getPhotoUrl(): string
/**
* Gets the user's email address.
*
*
* // Log the email address of the person running the script.
* Logger.log(Session.getActiveUser().getUserLoginId());
*