此页面由 Cloud Translation API 翻译。

Class Folder

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

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var 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 在当前文件夹中创建一个文件。

// 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);

参数

名称	类型	说明
`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 大于 10 MB，则会抛出异常。

// 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)`

获取授予指定用户的权限。

参数

名称	类型	说明
`email`	`String`	要检查其权限的用户的电子邮件地址

弃踢回攻

Permission - 授予用户的权限

授权

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

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

`getAccess(user)`

获取授予指定用户的权限。

参数

名称	类型	说明
`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 (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 (viewer of viewers) {
  console.log(viewer.getName());
}

弃踢回攻

User[] - 如果用户具有编辑访问权限，则为此 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 的 Drive 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.""
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var 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 的 Drive API，并且某些查询字段与 v3 不同。查看 v2 和 v3 之间的字段差异。

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

// Logs 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();
  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.)
var 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`	如果应将 `Folder` 移至用户云端硬盘的回收站，则为 `true`；如果不需要，则为 `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