此页面由 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 大于 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)`

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

参数

名称	类型	说明
`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，否则为 falsetrue

授权

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

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 文档。请注意，云端硬盘服务使用 Drive API 的 v2，并且某些查询字段与 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 文档。请注意，云端硬盘服务使用 Drive API 的 v2，并且某些查询字段与 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`	`true`（如果 `Folder` 应在用户的云端硬盘中加星标；否则，则为 `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