Class Folder

Google 云端硬盘中的文件夹。您可以通过 DriveApp 访问或创建文件夹。

// Log the name of every folder in the user's Drive.
const folders = DriveApp.getFolders();
while (folders.hasNext()) {
  const folder = folders.next();
  Logger.log(folder.getName());
}

方法

方法	返回类型	简介
`addEditor(emailAddress)`	`Folder`	将指定用户添加到 `Folder` 的编辑者列表中。
`addEditor(user)`	`Folder`	将指定用户添加到 `Folder` 的编辑者列表中。
`addEditors(emailAddresses)`	`Folder`	将指定的用户数组添加到 `Folder` 的编辑者列表中。
`addViewer(emailAddress)`	`Folder`	将指定用户添加到 `Folder` 的观看者列表中。
`addViewer(user)`	`Folder`	将指定用户添加到 `Folder` 的观看者列表中。
`addViewers(emailAddresses)`	`Folder`	将给定用户数组添加到 `Folder` 的观看者列表中。
`createFile(blob)`	`File`	根据任意数据的给定 `Blob` 在当前文件夹中创建文件。
`createFile(name, content)`	`File`	在当前文件夹中创建一个文本文件，并为其指定给定名称和内容。
`createFile(name, content, mimeType)`	`File`	在当前文件夹中创建一个文件，并为其指定给定名称、内容和 MIME 类型。
`createFolder(name)`	`Folder`	在当前文件夹中创建一个名为给定名称的文件夹。
`createShortcut(targetId)`	`File`	创建指向所提供云端硬盘内容 ID 的快捷方式，并将其返回。
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	创建指向所提供的云端硬盘内容 ID 和资源键的快捷方式，并返回该快捷方式。
`getAccess(email)`	`Permission`	获取向特定用户授予的权限。
`getAccess(user)`	`Permission`	获取向特定用户授予的权限。
`getDateCreated()`	`Date`	获取 `Folder` 的创建日期。
`getDescription()`	`String`	获取 `Folder` 的说明。
`getEditors()`	`User[]`	获取此 `Folder` 的编辑器列表。
`getFiles()`	`FileIterator`	获取当前文件夹的所有子文件的集合。
`getFilesByName(name)`	`FileIterator`	获取当前文件夹的子文件夹中所有具有给定名称的文件的集合。
`getFilesByType(mimeType)`	`FileIterator`	获取当前文件夹的子文件夹且具有给定 MIME 类型的所有文件的集合。
`getFolders()`	`FolderIterator`	获取当前文件夹的所有子文件夹的集合。
`getFoldersByName(name)`	`FolderIterator`	获取当前文件夹的子文件夹中具有给定名称的所有文件夹的集合。
`getId()`	`String`	获取 `Folder` 的 ID。
`getLastUpdated()`	`Date`	获取 `Folder` 的上次更新日期。
`getName()`	`String`	获取 `Folder` 的名称。
`getOwner()`	`User`	获取此 `Folder` 的所有者。
`getParents()`	`FolderIterator`	获取 `Folder` 的直接父级文件夹的集合。
`getResourceKey()`	`String`	获取访问使用链接共享的内容所需的 `Folder` 的资源密钥。
`getSecurityUpdateEligible()`	`Boolean`	获取此 `Folder` 是否符合条件，以应用安全更新（在使用链接共享时，需要使用资源密钥才能访问）。
`getSecurityUpdateEnabled()`	`Boolean`	获取此 `Folder` 在使用链接共享时是否需要资源键才能访问。
`getSharingAccess()`	`Access`	除了已明确授予访问权限的任何个人用户之外，获取哪类用户可以访问 `Folder`。
`getSharingPermission()`	`Permission`	获取授予可以访问 `Folder` 的用户（除了已明确授予访问权限的任何个人用户）的权限。
`getSize()`	`Integer`	获取用于在云端硬盘中存储 `Folder` 的字节数。
`getUrl()`	`String`	获取可用于在 Google 应用（例如云端硬盘或文档）中打开 `Folder` 的网址。
`getViewers()`	`User[]`	获取此 `Folder` 的查看者和评论者的列表。
`isShareableByEditors()`	`Boolean`	确定是否允许对 `Folder` 拥有修改权限的用户与其他用户共享或更改权限。
`isStarred()`	`Boolean`	确定 `Folder` 是否已在用户的云端硬盘中加入了收藏。
`isTrashed()`	`Boolean`	确定 `Folder` 是否位于用户云端硬盘的回收站中。
`moveTo(destination)`	`Folder`	将此项移至所提供的目标文件夹。
`removeEditor(emailAddress)`	`Folder`	从 `Folder` 的编辑者列表中移除指定用户。
`removeEditor(user)`	`Folder`	从 `Folder` 的编辑者列表中移除指定用户。
`removeViewer(emailAddress)`	`Folder`	从 `Folder` 的观看者和评论者列表中移除指定用户。
`removeViewer(user)`	`Folder`	从 `Folder` 的观看者和评论者列表中移除指定用户。
`revokePermissions(emailAddress)`	`Folder`	撤消向指定用户授予的对 `Folder` 的访问权限。
`revokePermissions(user)`	`Folder`	撤消向指定用户授予的对 `Folder` 的访问权限。
`searchFiles(params)`	`FileIterator`	获取当前文件夹的子文件夹且符合给定搜索条件的所有文件的集合。
`searchFolders(params)`	`FolderIterator`	获取当前文件夹的子文件夹且符合给定搜索条件的所有文件夹的集合。
`setDescription(description)`	`Folder`	设置 `Folder` 的说明。
`setName(name)`	`Folder`	设置 `Folder` 的名称。
`setOwner(emailAddress)`	`Folder`	更改 `Folder` 的所有者。
`setOwner(user)`	`Folder`	更改 `Folder` 的所有者。
`setSecurityUpdateEnabled(enabled)`	`Folder`	设置 `Folder` 在使用链接共享时是否需要资源键才能访问。
`setShareableByEditors(shareable)`	`Folder`	设置是否允许拥有 `Folder` 修改权限的用户与其他用户共享或更改权限。
`setSharing(accessType, permissionType)`	`Folder`	除了已明确授予访问权限的任何个人用户之外，还设置哪类用户可以访问 `Folder` 以及授予这些用户哪些权限。
`setStarred(starred)`	`Folder`	设置 `Folder` 是否已在用户的云端硬盘中加星标。
`setTrashed(trashed)`	`Folder`	设置 `Folder` 是否位于用户云端硬盘的回收站中。

已弃用的方法

方法	返回类型	简介
`addFile(child)`	`Folder`	将指定文件添加到当前文件夹。
`addFolder(child)`	`Folder`	将指定的文件夹添加到当前文件夹。
`removeFile(child)`	`Folder`	从当前文件夹中移除指定的文件。
`removeFolder(child)`	`Folder`	从当前文件夹中移除指定文件夹。

详细文档

`addEditor(emailAddress)`

将指定用户添加到 Folder 的编辑者列表中。如果用户已在观看者列表中，此方法会将用户从观看者列表中移除。

参数

名称	类型	说明
`emailAddress`	`String`	要添加的用户的电子邮件地址。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`addEditor(user)`

将指定用户添加到 Folder 的编辑者列表中。如果用户已在观看者列表中，此方法会将用户从观看者列表中移除。

参数

名称	类型	说明
`user`	`User`	要添加的用户的表示法。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`addEditors(emailAddresses)`

将指定的用户数组添加到 Folder 的编辑者列表中。如果任何用户已在观看者列表中，此方法会将其从观看者列表中移除。

参数

名称	类型	说明
`emailAddresses`	`String[]`	要添加的用户的电子邮件地址的数组。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`addViewer(emailAddress)`

将指定用户添加到 Folder 的观看者列表中。如果用户已在编辑者名单中，此方法将无效。

参数

名称	类型	说明
`emailAddress`	`String`	要添加的用户的电子邮件地址。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`addViewer(user)`

将指定用户添加到 Folder 的观看者列表中。如果用户已在编辑者名单中，此方法将无效。

参数

名称	类型	说明
`user`	`User`	要添加的用户的表示法。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`addViewers(emailAddresses)`

将给定用户数组添加到 Folder 的观看者列表中。如果任何用户已在编辑者列表中，此方法对他们没有任何影响。

参数

名称	类型	说明
`emailAddresses`	`String[]`	要添加的用户的电子邮件地址的数组。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`createFile(blob)`

根据任意数据的给定 Blob 在当前文件夹中创建文件。

参数

名称	类型	说明
`blob`	`BlobSource`	新文件的数据。

File - 新文件。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`createFile(name, content)`

在当前文件夹中创建一个文本文件，并为其指定给定名称和内容。如果 content 大于 50 MB，则会抛出异常。

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

参数

名称	类型	说明
`name`	`String`	新文件的名称。
`content`	`String`	新文件的内容。

File - 新文件。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`createFile(name, content, mimeType)`

在当前文件夹中创建一个文件，并为其指定名称、内容和 MIME 类型。如果 content 大于 10MB，则会抛出异常。

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

参数

名称	类型	说明
`name`	`String`	新文件的名称。
`content`	`String`	新文件的内容。
`mimeType`	`String`	新文件的 MIME 类型。

File - 新文件。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`createFolder(name)`

在当前文件夹中创建一个名为给定名称的文件夹。

参数

名称	类型	说明
`name`	`String`	新文件夹的名称。

Folder - 新建的文件夹。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`createShortcut(targetId)`

创建指向所提供云端硬盘内容 ID 的快捷方式，并将其返回。

参数

名称	类型	说明
`targetId`	`String`	目标文件或文件夹的文件 ID。

File - 新快捷方式。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

创建指向所提供的云端硬盘内容 ID 和资源键的快捷方式，并返回该快捷方式。资源键是需要传递的附加参数，用于访问已使用链接共享的目标文件或文件夹。

// 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.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and
  // returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(
      folder.getId(),
      folder.getResourceKey(),
  );
}

参数

名称	类型	说明
`targetId`	`String`	目标文件或文件夹的 ID。
`targetResourceKey`	`String`	目标文件或文件夹的资源键。

File - 新快捷方式。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getAccess(email)`

获取向特定用户授予的权限。该方法不支持返回 Google 群组的权限或通过 Google 群组继承的权限。

参数

名称	类型	说明
`email`	`String`	应检查权限的用户的电子邮件地址。不支持 Google 群组。

Permission - 向用户授予的权限。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getAccess(user)`

获取向特定用户授予的权限。该方法不支持返回 Google 群组的权限或通过 Google 群组继承的权限。

参数

名称	类型	说明
`user`	`User`	应检查权限的用户的表示法。

Permission - 向用户授予的权限。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getDateCreated()`

获取 Folder 的创建日期。

Date - Folder 的创建日期

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getDescription()`

获取 Folder 的说明。

String - Folder 的说明

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getEditors()`

获取此 Folder 的编辑器列表。如果执行脚本的用户没有对 Folder 的修改权限，此方法会返回一个空数组。

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of editors and logs their names to the console.
const editors = folder.getEditors();
for (const editor of editors) {
  console.log(editor.getName());
}

User[] - 如果用户拥有修改权限，则为此 Folder 的编辑者列表；否则，为空数组。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getFiles()`

获取当前文件夹的所有子文件的集合。

FileIterator - 当前文件夹的所有子文件的集合。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getFilesByName(name)`

获取当前文件夹的子文件夹中所有具有给定名称的文件的集合。

参数

名称	类型	说明
`name`	`String`	要查找的文件的名称。

FileIterator - 当前文件夹的子文件夹且具有给定名称的所有文件的集合。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getFilesByType(mimeType)`

获取当前文件夹的子文件夹且具有给定 MIME 类型的所有文件的集合。

参数

名称	类型	说明
`mimeType`	`String`	要查找的文件的 MIME 类型。

FileIterator - 当前文件夹的子文件夹且具有给定 MIME 类型的所有文件的集合。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getFolders()`

获取当前文件夹的所有子文件夹的集合。

FolderIterator - 当前文件夹的所有子文件夹的集合。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getFoldersByName(name)`

获取当前文件夹的子文件夹中具有给定名称的所有文件夹的集合。

参数

名称	类型	说明
`name`	`String`	要查找的文件夹的名称。

FolderIterator - 当前文件夹的子文件夹且具有给定名称的所有文件夹的集合。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getId()`

获取 Folder 的 ID。

String - Folder 的 ID

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getLastUpdated()`

获取 Folder 的上次更新日期。

Date - Folder 的上次更新日期

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getName()`

获取 Folder 的名称。

String - Folder 的名称

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getOwner()`

获取此 Folder 的所有者。

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the owner of the folder and logs the name to the console.
const folderOwner = folder.getOwner();
console.log(folderOwner.getName());

User - 此 Folder 的所有者。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getParents()`

获取 Folder 的直接父级文件夹的集合。

FolderIterator - Folder 的直接父级文件夹的集合

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getResourceKey()`

获取访问使用链接共享的内容所需的 Folder 的资源密钥。

String - Folder 的资源键。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getSecurityUpdateEligible()`

获取此 Folder 是否符合条件，以应用安全更新（在使用链接共享时，需要使用资源密钥才能访问）。

云端硬盘需要资源密钥才能访问使用链接共享的部分文件或文件夹。此变更是安全更新的一部分。系统会默认为符合条件的文件和文件夹开启更新。如需为符合条件的文件开启或关闭资源键要求，请使用 setSecurityUpdateEnabled。

详细了解 Google 云端硬盘安全更新。

Boolean - 是否可以对 Folder 应用资源键要求。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getSecurityUpdateEnabled()`

获取此 Folder 在使用链接共享时是否需要资源键才能访问。默认情况下，系统会为符合条件的文件和文件夹启用此要求。如需为符合条件的文件开启或关闭资源密钥要求，请使用 setSecurityUpdateEnabled。

详细了解 Google 云端硬盘安全更新。

Boolean - 是否为此 Folder 启用了资源键要求。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getSharingAccess()`

除了已明确授予访问权限的任何个人用户之外，获取哪类用户可以访问 Folder。

Access - 哪类用户可以访问 Folder

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getSharingPermission()`

获取授予可以访问 Folder 的用户（除了已明确授予访问权限的任何个人用户）的权限。

Permission - 向可以访问 Folder 的用户授予的权限

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getSize()`

获取用于在云端硬盘中存储 Folder 的字节数。请注意，Google Workspace 应用文件不会计入云端硬盘存储空间上限，因此会返回 0 字节。

Integer - 用于在云端硬盘中存储 Folder 的字节数

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getUrl()`

获取可用于在 Google 应用（例如云端硬盘或文档）中打开 Folder 的网址。

String - 可用于在 Google 应用（例如云端硬盘或文档）中查看此 Folder 的网址

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getViewers()`

获取此 Folder 的查看者和评论者的列表。如果执行脚本的用户无权修改 Folder，此方法会返回一个空数组。

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (const viewer of viewers) {
  console.log(viewer.getName());
}

User[] - 如果用户拥有此 Folder 的修改权限，则为此 Folder 的查看者和评论者的列表；否则，为空数组。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`isShareableByEditors()`

确定是否允许对 Folder 拥有修改权限的用户与其他用户共享或更改权限。

Boolean - 如果允许具有修改权限的用户与其他用户共享或更改权限，则为 true；否则为 false

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`isStarred()`

确定 Folder 是否已在用户的云端硬盘中加入了收藏。

Boolean - 如果 Folder 已在用户的云端硬盘中添加了星标，则为 true；否则为 false

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`isTrashed()`

确定 Folder 是否位于用户云端硬盘的回收站中。

Boolean - 如果 Folder 位于用户云端硬盘的回收站中，则为 true；否则为 false

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`moveTo(destination)`

将此项移至所提供的目标文件夹。

当前用户必须是文件的所有者，或者至少对内容当前的父级文件夹拥有编辑权限，才能将内容移至目标文件夹。

参数

名称	类型	说明
`destination`	`Folder`	将成为新父级的文件夹。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`removeEditor(emailAddress)`

从 Folder 的编辑者列表中移除指定用户。如果用户属于拥有一般访问权限的用户类别，此方法不会阻止他们访问 Folder，例如，如果 Folder 与用户的整个网域共享，或者 Folder 位于用户可以访问的共享云端硬盘中。

对于云端硬盘文件，这还会将用户从观看者列表中移除。

参数

名称	类型	说明
`emailAddress`	`String`	要移除的用户的电子邮件地址。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`removeEditor(user)`

对于云端硬盘文件，这还会将用户从观看者列表中移除。

参数

名称	类型	说明
`user`	`User`	要移除的用户的表示法。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`removeViewer(emailAddress)`

从 Folder 的观看者和评论者列表中移除指定用户。如果用户是编辑者（而非观看者或评论者），此方法将无效。此外，如果用户属于具有一般访问权限的用户类别，此方法也不会阻止他们访问 Folder，例如，如果 Folder 与用户的整个网域共享，或者 Folder 位于用户可以访问的共享云端硬盘中。

对于云端硬盘文件，这还会将用户从编辑者列表中移除。

参数

名称	类型	说明
`emailAddress`	`String`	要移除的用户的电子邮件地址。

Folder - 此 Folder 用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`removeViewer(user)`

从 Folder 的观看者和评论者列表中移除指定用户。如果用户是编辑者（而非查看者），此方法将无效。如果用户属于具有一般访问权限的用户类别，此方法也不会阻止他们访问 Folder，例如，如果 Folder 与用户的整个网域共享，或者 Folder 位于用户可以访问的共享云端硬盘中。

对于云端硬盘文件，这还会将用户从编辑者列表中移除。

参数

名称	类型	说明
`user`	`User`	要移除的用户的表示法。

Folder - 此 Folder 用于链式调用。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`revokePermissions(emailAddress)`

撤消向指定用户授予的对 Folder 的访问权限。如果用户属于具有一般访问权限的用户类别（例如，Folder 已与用户的整个网域共享），此方法不会阻止用户访问 Folder。

参数

名称	类型	说明
`emailAddress`	`String`	应撤消访问权限的用户的电子邮件地址。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`revokePermissions(user)`

参数

名称	类型	说明
`user`	`User`	表示应撤消访问权限的用户的表示法。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`searchFiles(params)`

获取当前文件夹的子文件夹且符合给定搜索条件的所有文件的集合。如需详细了解搜索条件，请参阅 Google 云端硬盘 SDK 文档。请注意，云端硬盘服务使用的是 v2 版云端硬盘 API，并且某些查询字段与 v3 版不同。查看 v2 和 v3 之间的字段差异。

params 参数是一个可包含字符串值的查询字符串，因此请务必正确转义引号（例如 "title contains 'Gulliver\\'s Travels'" 或 'title contains "Gulliver\'s Travels"'）。

// Logs the name of every file that are children of the current folder and modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

参数

名称	类型	说明
`params`	`String`	搜索条件，详见 Google 云端硬盘 SDK 文档。

FileIterator - 当前文件夹的子文件夹且符合搜索条件的所有文件的集合。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`searchFolders(params)`

获取当前文件夹的子文件夹中所有符合给定搜索条件的文件夹的集合。如需详细了解搜索条件，请参阅 Google 云端硬盘 SDK 文档。请注意，云端硬盘服务使用的是 v2 版云端硬盘 API，并且某些查询字段与 v3 版不同。查看 v2 和 v3 之间的字段差异。

// Logs the name of every folder that are children of the current folder and you own and is starred.
const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

参数

名称	类型	说明
`params`	`String`	搜索条件，详见 Google 云端硬盘 SDK 文档。

FolderIterator - 当前文件夹的子文件夹且符合搜索条件的所有文件夹的集合。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setDescription(description)`

设置 Folder 的说明。

参数

名称	类型	说明
`description`	`String`	`Folder` 的新说明

Folder - 此 Folder，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setName(name)`

设置 Folder 的名称。

参数

名称	类型	说明
`name`	`String`	`Folder` 的新名称

Folder - 此 Folder，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setOwner(emailAddress)`

更改 Folder 的所有者。此方法还会向之前的所有者授予对 Folder 的显式修改权限。

参数

名称	类型	说明
`emailAddress`	`String`	应成为新所有者的用户的电子邮件地址

Folder - 此 Folder，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setOwner(user)`

更改 Folder 的所有者。此方法还会向之前的所有者授予对 Folder 的显式修改权限。

参数

名称	类型	说明
`user`	`User`	代表应成为新所有者的用户

Folder - 此 Folder，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setSecurityUpdateEnabled(enabled)`

设置 Folder 在使用链接共享时是否需要资源密钥才能访问。符合条件的文件和文件夹默认处于启用状态。

详细了解 Google 云端硬盘安全更新。

参数

名称	类型	说明
`enabled`	`Boolean`	是否为 `Folder` 启用资源键要求。

Folder - 此 Folder，用于链接。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setShareableByEditors(shareable)`

设置是否允许拥有 Folder 修改权限的用户与其他用户共享或更改权限。新 Folder 的默认值为 true。

参数

名称	类型	说明
`shareable`	`Boolean`	`true`（如果允许具有修改权限的用户与其他用户共享内容或更改权限）；`false`（如果不允许）

Folder - 此 Folder，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setSharing(accessType, permissionType)`

除了已明确授予访问权限的任何个人用户之外，还设置哪类用户可以访问 Folder 以及授予这些用户哪些权限。

// Creates a folder that anyone on the Internet can read from and write to.
// (Domain administrators can prohibit this setting for users of a Google
// Workspace domain.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

参数

名称	类型	说明
`accessType`	`Access`	哪类用户应能够访问 `Folder`
`permissionType`	`Permission`	应向有权访问 `Folder` 的用户授予的权限

Folder - 此 Folder，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setStarred(starred)`

设置 Folder 是否已在用户的云端硬盘中加星标。新 Folder 的默认值为 false。

参数

名称	类型	说明
`starred`	`Boolean`	如果 `Folder` 应在用户的云端硬盘中加星标，则为 `true`；否则为 `false`

Folder - 此 Folder，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setTrashed(trashed)`

设置 Folder 是否位于用户云端硬盘的回收站中。只有所有者可以将 Folder 移至回收站。新 Folder 的默认值为 false。

参数

名称	类型	说明
`trashed`	`Boolean`	`true`（如果应将 `Folder` 移至用户云端硬盘的回收站）；`false`（如果不应）

Folder - 此 Folder，用于链式调用

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

已弃用的方法

`addFile(child)`

已弃用。请改用 File.moveTo(destination) 或 createShortcut(targetId)。

将指定文件添加到当前文件夹。此方法不会将文件移出其现有父文件夹；一个文件可以同时有多个父级。

参数

名称	类型	说明
`child`	`File`	要添加的子文件。

Folder - 作为子项添加的文件的新父级。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`addFolder(child)`

已弃用。请改用 moveTo(destination) 或 createShortcut(targetId)。

将指定的文件夹添加到当前文件夹。此方法不会将文件夹移出其现有父文件夹；一个文件夹可以同时有多个父级。

参数

名称	类型	说明
`child`	`Folder`	要添加的子文件夹。

Folder - 作为子项添加的文件夹的新父级。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`removeFile(child)`

已弃用。而应使用 File.moveTo(destination)。

从当前文件夹中移除给定文件。此方法不会删除文件，但如果文件从其所有父级文件夹中移除，则除非您搜索该文件或使用“所有内容”视图，否则将无法在云端硬盘中看到该文件。

参数

名称	类型	说明
`child`	`File`	要移除的子文件。

Folder - 子项的上一个父项。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`removeFolder(child)`

已弃用。而应使用 moveTo(destination)。

从当前文件夹中移除给定文件夹。此方法不会删除文件夹或其内容，但如果文件夹从其所有父级文件夹中移除，则无法在云端硬盘中看到该文件夹，除非通过搜索或使用“所有内容”视图查看。

参数

名称	类型	说明
`child`	`Folder`	要移除的子文件夹。

Folder - 子项的上一个父项。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

Class Folder 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

方法

已弃用的方法

详细文档

addEditor(emailAddress)

参数

返回

授权

addEditor(user)

参数

返回

授权

addEditors(emailAddresses)

参数

返回

授权

addViewer(emailAddress)

参数

返回

授权

addViewer(user)

参数

返回

授权

addViewers(emailAddresses)

参数

返回

授权

createFile(blob)

参数

返回

授权

createFile(name, content)

参数

返回

授权

createFile(name, content, mimeType)

参数

返回

授权

createFolder(name)

参数

返回

授权

createShortcut(targetId)

参数

返回

授权

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

参数

返回

授权

getAccess(email)

参数

返回

授权

getAccess(user)

参数

返回

授权

getDateCreated()

返回

授权

getDescription()

返回

授权

getEditors()

返回

授权

getFiles()

返回

授权

getFilesByName(name)

参数

返回

授权

getFilesByType(mimeType)

参数

返回

授权

Class Folder

`addEditor(emailAddress)`

`addEditor(user)`

`addEditors(emailAddresses)`

`addViewer(emailAddress)`

`addViewer(user)`

`addViewers(emailAddresses)`

`createFile(blob)`

`createFile(name, content)`

`createFile(name, content, mimeType)`

`createFolder(name)`

`createShortcut(targetId)`

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

`getAccess(email)`

`getAccess(user)`

`getDateCreated()`

`getDescription()`

`getEditors()`

`getFiles()`

`getFilesByName(name)`

`getFilesByType(mimeType)`

`getFolders()`

`getFoldersByName(name)`

`getId()`

`getLastUpdated()`

`getName()`

`getOwner()`

`getParents()`

`getResourceKey()`

`getSecurityUpdateEligible()`

`getSecurityUpdateEnabled()`

`getSharingAccess()`

`getSharingPermission()`

`getSize()`

`getUrl()`

`getViewers()`

`isShareableByEditors()`

`isStarred()`

`isTrashed()`

`moveTo(destination)`

`removeEditor(emailAddress)`

`removeEditor(user)`

`removeViewer(emailAddress)`