Interface DriveApp

Allows scripts to create, find, and modify files and folders in Google Drive.

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

interface DriveApp {
    Access: typeof Access;
    Permission: typeof GoogleAppsScript.Drive.Permission;
    addFile(child: GoogleAppsScript.Drive.File): GoogleAppsScript.Drive.Folder;
    addFolder(
        child: GoogleAppsScript.Drive.Folder,
    ): GoogleAppsScript.Drive.Folder;
    continueFileIterator(continuationToken: string): FileIterator;
    continueFolderIterator(continuationToken: string): FolderIterator;
    createFile(blob: BlobSource): GoogleAppsScript.Drive.File;
    createFile(name: string, content: string): GoogleAppsScript.Drive.File;
    createFile(
        name: string,
        content: string,
        mimeType: string,
    ): GoogleAppsScript.Drive.File;
    createFolder(name: string): GoogleAppsScript.Drive.Folder;
    createShortcut(targetId: string): GoogleAppsScript.Drive.File;
    createShortcutForTargetIdAndResourceKey(
        targetId: string,
        targetResourceKey: string,
    ): GoogleAppsScript.Drive.File;
    getFileById(id: string): GoogleAppsScript.Drive.File;
    getFileByIdAndResourceKey(
        id: string,
        resourceKey: string,
    ): GoogleAppsScript.Drive.File;
    getFiles(): FileIterator;
    getFilesByName(name: string): FileIterator;
    getFilesByType(mimeType: string): FileIterator;
    getFolderById(id: string): GoogleAppsScript.Drive.Folder;
    getFolderByIdAndResourceKey(
        id: string,
        resourceKey: string,
    ): GoogleAppsScript.Drive.Folder;
    getFolders(): FolderIterator;
    getFoldersByName(name: string): FolderIterator;
    getRootFolder(): GoogleAppsScript.Drive.Folder;
    getStorageLimit(): number;
    getStorageUsed(): number;
    getTrashedFiles(): FileIterator;
    getTrashedFolders(): FolderIterator;
    removeFile(
        child: GoogleAppsScript.Drive.File,
    ): GoogleAppsScript.Drive.Folder;
    removeFolder(
        child: GoogleAppsScript.Drive.Folder,
    ): GoogleAppsScript.Drive.Folder;
    searchFiles(params: string): FileIterator;
    searchFolders(params: string): FolderIterator;
}

Index

Properties

Access Permission

Methods

addFile addFolder continueFileIterator continueFolderIterator createFile createFolder createShortcut createShortcutForTargetIdAndResourceKey getFileById getFileByIdAndResourceKey getFiles getFilesByName getFilesByType getFolderById getFolderByIdAndResourceKey getFolders getFoldersByName getRootFolder getStorageLimit getStorageUsed getTrashedFiles getTrashedFolders removeFile removeFolder searchFiles searchFolders

Properties

Access

Access: typeof Access

Permission

Permission: typeof GoogleAppsScript.Drive.Permission

Methods

addFile

addFile(child: GoogleAppsScript.Drive.File): GoogleAppsScript.Drive.Folder
Adds the given file to the root of the user's Drive. This method does not move the file out of its existing parent folder; a file can have more than one parent simultaneously.
Parameters
- child: GoogleAppsScript.Drive.File
Returns GoogleAppsScript.Drive.Folder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:40

addFolder

addFolder(child: GoogleAppsScript.Drive.Folder): GoogleAppsScript.Drive.Folder
Adds the given folder to the root of the user's Drive. This method does not move the folder out of its existing parent folder; a folder can have more than one parent simultaneously.
Parameters
- child: GoogleAppsScript.Drive.Folder
Returns GoogleAppsScript.Drive.Folder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:46

continueFileIterator

continueFileIterator(continuationToken: string): FileIterator
Resumes a file iteration using a continuation token from a previous iterator. 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.
Parameters
- continuationToken: string
Returns FileIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:52

continueFolderIterator

continueFolderIterator(continuationToken: string): FolderIterator
Resumes a folder iteration using a continuation token from a previous iterator. 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.
Parameters
- continuationToken: string
Returns FolderIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:58

createFile

createFile(blob: BlobSource): GoogleAppsScript.Drive.File
Creates a file in the root of the user's Drive from a given Blob of arbitrary data.
Parameters
- blob: BlobSource
Returns GoogleAppsScript.Drive.File
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:60
createFile(name: string, content: string): GoogleAppsScript.Drive.File
Creates a text file in the root of the user's Drive with the given name and contents. Throws an exception if content is larger than 50 MB.
Parameters
- name: string
- content: string
Returns GoogleAppsScript.Drive.File
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:65
createFile(
    name: string,
    content: string,
    mimeType: string,
): GoogleAppsScript.Drive.File
Creates a file in the root of the user's Drive with the given name, contents, and MIME type. Throws an exception if content is larger than 10MB.
Parameters
- name: string
- content: string
- mimeType: string
Returns GoogleAppsScript.Drive.File
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:70

createFolder

createFolder(name: string): GoogleAppsScript.Drive.Folder
Creates a folder in the root of the user's Drive with the given name.
Parameters
- name: string
Returns GoogleAppsScript.Drive.Folder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:72

createShortcut

createShortcut(targetId: string): GoogleAppsScript.Drive.File
Creates a shortcut to the provided Drive item ID, and returns it.
Parameters
- targetId: string
Returns GoogleAppsScript.Drive.File
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:74

createShortcutForTargetIdAndResourceKey

createShortcutForTargetIdAndResourceKey(
targetId: string,
targetResourceKey: string,
): GoogleAppsScript.Drive.File
Creates a shortcut to the provided Drive item ID and resource key, and returns it. Resource keys are an additional parameter which need to be passed to access the target file or folder that has been shared using a link.
Parameters
- targetId: string
- targetResourceKey: string
Returns GoogleAppsScript.Drive.File
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:81

getFileById

getFileById(id: string): GoogleAppsScript.Drive.File
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.
Parameters
- id: string
Returns GoogleAppsScript.Drive.File
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:87

getFileByIdAndResourceKey

getFileByIdAndResourceKey(
id: string,
resourceKey: string,
): GoogleAppsScript.Drive.File
Gets the file with the given ID and resource key. Resource keys are an additional parameter which need to be passed to access files that have been shared using a link.

Throws a scripting exception if the file doesn't exist or the user doesn't have permission to access it.
Parameters
- id: string
- resourceKey: string
Returns GoogleAppsScript.Drive.File
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:96

getFiles

getFiles(): FileIterator
Gets a collection of all files in the user's Drive.

Returns FileIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:98

getFilesByName

getFilesByName(name: string): FileIterator
Gets a collection of all files in the user's Drive that have the given name.
Parameters
- name: string
Returns FileIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:100

getFilesByType

getFilesByType(mimeType: string): FileIterator
Gets a collection of all files in the user's Drive that have the given MIME type.
Parameters
- mimeType: string
Returns FileIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:102

getFolderById

getFolderById(id: string): GoogleAppsScript.Drive.Folder
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.
Parameters
- id: string
Returns GoogleAppsScript.Drive.Folder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:107

getFolderByIdAndResourceKey

getFolderByIdAndResourceKey(
id: string,
resourceKey: string,
): GoogleAppsScript.Drive.Folder
Gets the folder with the given ID and resource key. Resource keys are an additional parameter which need to be passed to access folders that have been shared using a link. Throws a scripting exception if the folder doesn't exist or the user doesn't have permission to access it.
Parameters
- id: string
- resourceKey: string
Returns GoogleAppsScript.Drive.Folder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:115

getFolders

getFolders(): FolderIterator
Gets a collection of all folders in the user's Drive.

Returns FolderIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:117

getFoldersByName

getFoldersByName(name: string): FolderIterator
Gets a collection of all folders in the user's Drive that have the given name.
Parameters
- name: string
Returns FolderIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:119

getRootFolder

getRootFolder(): GoogleAppsScript.Drive.Folder
Gets the folder at the root of the user's Drive.

Returns GoogleAppsScript.Drive.Folder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:121

getStorageLimit

getStorageLimit(): number
Gets the number of bytes the user is allowed to store in Drive.

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:123

getStorageUsed

getStorageUsed(): number
Gets the number of bytes the user is currently storing in Drive.

Returns number
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:125

getTrashedFiles

getTrashedFiles(): FileIterator
Gets a collection of all the files in the trash of the user's Drive.

Returns FileIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:127

getTrashedFolders

getTrashedFolders(): FolderIterator
Gets a collection of all the folders in the trash of the user's Drive.

Returns FolderIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:129

removeFile

removeFile(child: GoogleAppsScript.Drive.File): GoogleAppsScript.Drive.Folder
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.
Parameters
- child: GoogleAppsScript.Drive.File
Returns GoogleAppsScript.Drive.Folder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:136

removeFolder

removeFolder(
child: GoogleAppsScript.Drive.Folder,
): GoogleAppsScript.Drive.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.
Parameters
- child: GoogleAppsScript.Drive.Folder
Returns GoogleAppsScript.Drive.Folder
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:143

searchFiles

searchFiles(params: string): FileIterator
Gets a collection of all files in the user's Drive that match the given search criteria. The search criteria are detailed the Google Drive SDK documentation. Note that the params argument is a query string that may contain string values, so take care to escape quotation marks correctly (for example "title contains 'Gulliver\'s Travels'" or 'title contains "Gulliver's Travels"').
Parameters
- params: string
Returns FileIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:151

searchFolders

searchFolders(params: string): FolderIterator
Gets a collection of all folders in the user's Drive that match the given search criteria. The search criteria are detailed the Google Drive SDK documentation. Note that the params argument is a query string that may contain string values, so take care to escape quotation marks correctly (for example "title contains 'Gulliver\'s Travels'" or 'title contains "Gulliver's Travels"').
Parameters
- params: string
Returns FolderIterator
- Defined in google-apps-script-typedoc/DefinitelyTyped/types/google-apps-script/google-apps-script.drive.d.ts:159

Interface DriveApp

Index

Properties

Methods

Properties

Access

Permission

Methods

addFile

Parameters

Returns GoogleAppsScript.Drive.Folder

addFolder

Parameters

Returns GoogleAppsScript.Drive.Folder

continueFileIterator

Parameters

Returns FileIterator

continueFolderIterator

Parameters

Returns FolderIterator

createFile

Parameters

Returns GoogleAppsScript.Drive.File

Parameters

Returns GoogleAppsScript.Drive.File

Parameters

Returns GoogleAppsScript.Drive.File

createFolder

Parameters

Returns GoogleAppsScript.Drive.Folder

createShortcut

Parameters

Returns GoogleAppsScript.Drive.File

createShortcutForTargetIdAndResourceKey

Parameters

Returns GoogleAppsScript.Drive.File

getFileById

Parameters

Returns GoogleAppsScript.Drive.File

getFileByIdAndResourceKey

Parameters

Returns GoogleAppsScript.Drive.File

getFiles

Returns FileIterator

getFilesByName

Parameters

Returns FileIterator

getFilesByType

Parameters

Returns FileIterator

getFolderById

Parameters

Returns GoogleAppsScript.Drive.Folder

getFolderByIdAndResourceKey

Parameters

Returns GoogleAppsScript.Drive.Folder

getFolders

Returns FolderIterator

getFoldersByName

Parameters

Returns FolderIterator

getRootFolder

Returns GoogleAppsScript.Drive.Folder

getStorageLimit

Returns number

getStorageUsed

Returns number

getTrashedFiles

Returns FileIterator

getTrashedFolders

Returns FolderIterator

removeFile

Parameters

Returns GoogleAppsScript.Drive.Folder

removeFolder

Parameters

Returns GoogleAppsScript.Drive.Folder

searchFiles

Parameters

Returns FileIterator