Resumes a file iteration using a continuation token from a previous iterator. This method isuseful if processing an iterator in one execution exceeds the maximum execution time.Continuation tokens are generally valid for one week.

// Continues getting a list of all 'Untitled document' files in the user's// Drive. Creates a file iterator named 'previousIterator'.constpreviousIterator=DriveApp.getFilesByName('Untitled document');// Gets continuation token from the previous file iterator.constcontinuationToken=previousIterator.getContinuationToken();// Creates a new iterator using the continuation token from the previous file// iterator.constnewIterator=DriveApp.continueFileIterator(continuationToken);// Resumes the file iteration using a continuation token from 'firstIterator'// and logs the file name.if(newIterator.hasNext()){constfile=newIterator.next();console.log(file.getName());}

Parameters

Return

FileIterator — A collection of files that remained in a previous iterator when the continuation token was generated.

Resumes a folder iteration using a continuation token from a previous iterator. This method isuseful if processing an iterator in one execution exceeds the maximum execution time.Continuation tokens are generally valid for one week.

// Continues getting a list of all folders in user's Drive.// Creates a folder iterator named 'previousIterator'.constpreviousIterator=DriveApp.getFolders();// Gets continuation token from the previous folder iterator.constcontinuationToken=previousIterator.getContinuationToken();// Creates a new iterator using the continuation token from the previous folder// iterator.constnewIterator=DriveApp.continueFolderIterator(continuationToken);// Resumes the folder iteration using a continuation token from the previous// iterator and logs the folder name.if(newIterator.hasNext()){constfolder=newIterator.next();console.log(folder.getName());}

Parameters

Return

FolderIterator — A collection of folders that remained in a previous iterator when the continuation token was generated.

Creates a file in the root of the user's Drive from a givenBlob of arbitrary data.

Parameters

Return

File — The new file.

Authorization

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

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

Creates a text file in the root of the user's Drive with the given name and contents. Throws anexception ifcontent is larger than 50 MB.

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

Parameters

Return

File — The new file.

Authorization

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

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

Creates a file in the root of the user's Drive with the given name, contents, and MIME type. Throwsan exception ifcontent is larger than 10MB.

// Create an HTML file with the content "Hello, world!"DriveApp.createFile('New HTML File','<b>Hello, world!</b>',MimeType.HTML);

Parameters

Return

File — The new file.

Authorization

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

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

Creates a folder in the root of the user's Drive with the given name.

Parameters

Return

Folder — The new folder.

Authorization

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

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

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

Parameters

Return

File — The new shortcut.

Authorization

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

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

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

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

Parameters

Return

File — The new shortcut.

Authorization

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

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

Enables or disables enforceSingleParent behavior for all calls affecting item parents.

See the Simplifying Google Drive’s folder structure and sharing models blog formore details.

// Enables enforceSingleParent behavior for all calls affecting item parents.DriveApp.enforceSingleParent(true);

Parameters

Authorization

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

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

Gets the file with the given ID. Throws a scripting exception if the file does not exist or theuser does not have permission to access it.

// Gets a list of all files in Google Drive with the given name.// TODO(developer): Replace 'Test' with your file name.constfiles=DriveApp.getFilesByName('Test');if(files.hasNext()){// Gets the ID of each file in the list.constfileId=files.next().getId();// Gets the file name using its ID and logs it to the console.console.log(DriveApp.getFileById(fileId).getName());}

Parameters

Return

File — The file with the given ID.

Authorization

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

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

Gets the file with the given ID and resource key. Resource keys are an additional parameterwhich 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 permissionto access it.

// Gets a list of all files in Drive with the given name.// TODO(developer): Replace 'Test' with your file name.constfiles=DriveApp.getFilesByName('Test');if(files.hasNext()){// Gets the first file in the list.constfile=files.next();// Gets the ID and resource key.constkey=file.getResourceKey();constid=file.getId();// Logs the file name to the console using its ID and resource key.console.log(DriveApp.getFileByIdAndResourceKey(id,key).getName());}

Parameters

Return

File — The file with the given ID.

Authorization

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

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

Gets a collection of all files in the user's Drive.

Return

FileIterator — A collection of all files in the user's Drive.

Authorization

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

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

Gets a collection of all files in the user's Drive that have the given name.

Parameters

Return

FileIterator — A collection of all files in the user's Drive that have the given name.

Authorization

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

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

Gets a collection of all files in the user's Drive that have the given MIME type.

Parameters

Return

FileIterator — A collection of all files in the user's Drive that have the given MIME type.

Authorization

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

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

Gets the folder with the given ID. Throws a scripting exception if the folder does not exist orthe user does not have permission to access it.

Parameters

Return

Folder — The folder with the given ID.

Authorization

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

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

Gets the folder with the given ID and resource key. Resource keys are an additional parameterwhich 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 permissionto access it.

Parameters

Return

Folder — The folder with the given ID.

Authorization

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

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

Gets a collection of all folders in the user's Drive.

Return

FolderIterator — A collection of all folders in the user's Drive.

Authorization

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

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

Gets a collection of all folders in the user's Drive that have the given name.

Parameters

Return

FolderIterator — A collection of all folders in the user's Drive that have the given name.

Authorization

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

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

Gets the folder at the root of the user's Drive.

// Gets the user's My Drive folder and logs its name to the console.console.log(DriveApp.getRootFolder().getName());// Logs the Drive owner's name to the console.console.log(DriveApp.getRootFolder().getOwner().getName());

Return

Folder — The root folder of the user's Drive.

Authorization

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

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

Gets the number of bytes the user is allowed to store in Drive.

// Gets the number of bytes the user can store in Drive and logs it to the// console.console.log(DriveApp.getStorageLimit());

Return

Integer — The number of bytes the user is allowed to store in Drive.

Authorization

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

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

Gets the number of bytes the user is currently storing in Drive.

// Gets the number of bytes the user is currently storing in Drive and logs it// to the console.console.log(DriveApp.getStorageUsed());

Return

Integer — The number of bytes the user is currently storing in Drive.

Authorization

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

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

Gets a collection of all the files in the trash of the user's Drive.

// Gets a list of all the files in the trash of the user's Drive.consttrashFiles=DriveApp.getTrashedFiles();// Logs the trash file names to the console.while(trashFiles.hasNext()){constfile=trashFiles.next();console.log(file.getName());}

Return

FileIterator — A collection of files in the trash.

Authorization

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

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

Gets a collection of all the folders in the trash of the user's Drive.

// Gets a collection of all the folders in the trash of the user's Drive.consttrashFolders=DriveApp.getTrashedFolders();// Logs the trash folder names to the console.while(trashFolders.hasNext()){constfolder=trashFolders.next();console.log(folder.getName());}

Return

FolderIterator — A collection of folders in the trash.

Authorization

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

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

Gets a collection of all files in the user's Drive that match the given searchcriteria. The search criteria are detailed in theGoogle Drive SDK documentation. Note that the Driveservice uses v2 of the Drive API and some query fields differ from v3. Review thefielddifferences between v2 and v3.

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

// Logs the name of every file in the user's Drive that modified after February 28,// 2022 whose name contains "untitled.""constfiles=DriveApp.searchFiles('modifiedDate > "2022-02-28" and title contains "untitled"');while(files.hasNext()){constfile=files.next();console.log(file.getName());}

Parameters

Return

FileIterator — A collection of all files in the user's Drive that match the search criteria.

Authorization

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

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

Gets a collection of all folders in the user's Drive that match the given searchcriteria. The search criteria are detailed in theGoogle Drive SDK documentation. Note that the Driveservice uses v2 of the Drive API and some query fields differ from v3. Review thefielddifferences between v2 and v3.

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

// Logs the name of every folder in the user's Drive that you own and is starred.constfolders=DriveApp.searchFolders('starred = true and "me" in owners');while(folders.hasNext()){constfolder=folders.next();console.log(folder.getName());}

Parameters

Return

FolderIterator — A collection of all folders in the user's Drive that match the search criteria.

Authorization

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

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

Deprecated. Instead, useFile.moveTo(destination) orFolder.createShortcut(targetId).

Adds the given file to the root of the user's Drive. This method does not move the file out of itsexisting parent folder; a file can have more than one parent simultaneously.

Parameters

Return

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

Authorization

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

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

Deprecated. Instead, useFolder.moveTo(destination) orFolder.createShortcut(targetId).

Adds the given folder to the root of the user's Drive. This method does not move the folder out ofits existing parent folder; a folder can have more than one parent simultaneously.

Parameters

Return

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

Authorization

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

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

Deprecated. Instead, useFile.moveTo(destination).

Removes the given file from the root of the user's Drive. This method does not delete the file, butif a file is removed from all of its parents, it cannot be seen in Drive except by searchingfor it or using the "All items" view.

Parameters

Return

Folder — The previous parent of the child.

Authorization

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

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

Deprecated. Instead, useFolder.moveTo(destination).

Removes the given folder from the root of the user's Drive. This method does not delete the folderor its contents, but if a folder is removed from all of its parents, it cannot be seen in Driveexcept by searching for it or using the "All items" view.

Parameters

Return

Folder — The previous parent of the child.

Authorization

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

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