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 是否在用户的云端硬盘的回收站中。

详细文档

addEditor(emailAddress)

将指定用户添加到 Folder 的编辑者列表中。如果用户已经 ，则此方法会将该用户从查看者列表中进行升级。

参数

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

返回

Folder - 此 Folder，用于链接。

授权

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

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

addEditor(user)

将指定用户添加到 Folder 的编辑者列表中。如果用户已经 ，则此方法会将该用户从查看者列表中进行升级。

参数

名称类型说明
userUser表示要添加的用户。

返回

Folder - 此 Folder，用于链接。

授权

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

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

addEditors(emailAddresses)

向 Folder 的编辑器列表添加给定的一组用户。如果存在 用户已经存在于查看者列表中，则此方法会将他们从 观看者。

参数

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

返回

Folder - 此 Folder，用于链接。

授权

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

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

addViewer(emailAddress)

将指定用户添加到 Folder 的查看者列表中。如果用户已经 ，则此方法不会产生任何效果。

参数

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

返回

Folder - 此 Folder，用于链接。

授权

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

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

addViewer(user)

将指定用户添加到 Folder 的查看者列表中。如果用户已经 ，则此方法不会产生任何效果。

参数

名称类型说明
userUser表示要添加的用户。

返回

Folder - 此 Folder，用于链接。

授权

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

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

addViewers(emailAddresses)

将指定的一组用户添加到 Folder 的查看者列表。如果存在 用户已经位于编辑者列表中，则此方法对他们没有影响。

参数

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

返回

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

参数

名称类型说明
blobBlobSource新文件的数据。

返回

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!');

参数

名称类型说明
nameString新文件的名称。
contentString新文件的内容。

返回

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

参数

名称类型说明
nameString新文件的名称。
contentString新文件的内容。
mimeTypeString新文件的 MIME 类型。

返回

File - 新文件。

授权

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

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

createFolder(name)

使用给定名称在当前文件夹中创建文件夹。

参数

名称类型说明
nameString新文件夹的名称。

返回

Folder - 新文件夹。

授权

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

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

createShortcut(targetId)

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

参数

名称类型说明
targetIdString目标文件或文件夹的文件 ID。

返回

File - 新的快捷方式。

授权

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

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

为提供的云端硬盘内容 ID 和资源密钥创建快捷方式，并将其返回。资源 key 是一个附加参数，需要传递该参数，以访问 已通过链接共享。 

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

参数

名称类型说明
targetIdString目标文件或文件夹的 ID。
targetResourceKeyString目标文件或文件夹的资源密钥。

返回

File - 新的快捷方式。

授权

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

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

getAccess(email)

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

参数

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

返回

Permission - 授予用户的权限

授权

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

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

getAccess(user)

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

参数

名称类型说明
userUser表示应检查其权限的用户

返回

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)

获取属于当前文件夹的子文件夹且具有指定名称的所有文件的集合。

参数

名称类型说明
nameString要查找的文件的名称。

返回

FileIterator - 属于当前文件夹的子项且具有指定名称的所有文件的集合。

授权

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

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

getFilesByType(mimeType)

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

参数

名称类型说明
mimeTypeString要查找的文件的 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)

获取属于当前文件夹的子文件夹且具有指定名称的所有文件夹的集合。

参数

名称类型说明
nameString要查找的文件夹的名称。

返回

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)

将此项内容移到提供的目标文件夹。

当前用户必须是相应文件的所有者，或者至少拥有该项的编辑权限 当前父级文件夹，从而将该项移至目标文件夹。

参数

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

返回

Folder - 此 Folder，用于链接。

授权

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

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

removeEditor(emailAddress)

从 Folder 的编辑者列表中移除指定用户。此方法 如果用户属于符合以下条件的某个类别，则禁止该用户访问Folder 例如，如果 Folder 与用户的整个 网域，或者如果 Folder 位于用户有权访问的共享云端硬盘中。

对于云端硬盘文件，此操作还会将相应用户从查看者列表中移除。

参数

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

返回

Folder - 此 Folder，用于链接。

授权

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

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

removeEditor(user)

从 Folder 的编辑者列表中移除指定用户。此方法 如果用户属于符合以下条件的某个类别，则禁止该用户访问Folder 例如，如果 Folder 与用户的整个 网域，或者如果 Folder 位于用户有权访问的共享云端硬盘中。

对于云端硬盘文件，此操作还会将相应用户从查看者列表中移除。

参数

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

返回

Folder - 此 Folder，用于链接。

授权

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

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

removeViewer(emailAddress)

从 Folder 的查看者和评论者列表中移除指定用户。本次 方法则不起作用。此方法还会 如果用户属于Folder 具有常规访问权限，例如，如果 Folder 与用户的 也可以指定 Folder 在用户可以访问的共享云端硬盘中。

对于云端硬盘文件，此操作也会将用户从编辑者列表中移除。

参数

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

返回

Folder - 此 Folder，用于链接。

授权

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

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

removeViewer(user)

从 Folder 的查看者和评论者列表中移除指定用户。本次 方法则不起作用。此方法也不会阻止 如果用户属于对具有常规性访问权限的某一类用户，则他们无法访问 Folder。 访问权限 - 例如，如果 Folder 与用户的整个网域共享，或者 如果Folder位于用户可以访问的共享云端硬盘中。

对于云端硬盘文件，此操作也会将用户从编辑者列表中移除。

参数

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

返回

Folder - 此 Folder，用于链接。

授权

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

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

revokePermissions(emailAddress)

撤消向指定用户授予的 Folder 访问权限。此方法 如果用户属于Folder 具有常规访问权限 - 例如，如果 Folder 与用户的 整个网域。

参数

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

返回

Folder - 此 Folder，用于链接。

授权

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

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

revokePermissions(user)

撤消向指定用户授予的 Folder 访问权限。此方法 如果用户属于Folder 具有常规访问权限 - 例如，如果 Folder 与用户的 整个网域。

参数

名称类型说明
userUser表示应撤消其访问权限的用户。

返回

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());
}

参数

名称类型说明
paramsString搜索条件，如 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());
}

参数

名称类型说明
paramsString搜索条件，如 Google 云端硬盘 SDK 文档中所述。

返回

FolderIterator - 属于当前文件夹的子文件夹且与搜索条件匹配的所有文件夹的集合 条件。

授权

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

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

setDescription(description)

设置 Folder 的说明。

参数

名称类型说明
descriptionStringFolder的新说明

返回

Folder - 此 Folder，用于链接

授权

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

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

setName(name)

设置 Folder 的名称。

参数

名称类型说明
nameStringFolder的新名称

返回

Folder - 此 Folder，用于链接

授权

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

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

setOwner(emailAddress)

更改 Folder 的所有者。此方法还会为之前的所有者提供 拥有对 Folder 的明确编辑权限。

参数

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

返回

Folder - 此 Folder，用于链接

授权

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

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

setOwner(user)

更改 Folder 的所有者。此方法还会为之前的所有者提供 拥有对 Folder 的明确编辑权限。

参数

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

返回

Folder - 此 Folder，用于链接

授权

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

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

setSecurityUpdateEnabled(enabled)

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

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

参数

名称类型说明
enabledBoolean是否为 Folder 启用资源密钥要求。

返回

Folder - 此 Folder，用于链接。

授权

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

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

setShareableByEditors(shareable)

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

参数

名称类型说明
shareableBooleantrue（如果允许具有修改权限的用户与以下对象共享内容） 其他用户或更改权限；如果不是，则为 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);

参数

名称类型说明
accessTypeAccess哪类用户应该能够访问Folder
permissionTypePermission应该向有权访问 Folder 的用户授予的权限

返回

Folder - 此 Folder，用于链接

授权

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

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

setStarred(starred)

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

参数

名称类型说明
starredBoolean如果应在用户的trueFolder 云端硬盘；如果不是，则为 false

返回

Folder - 此 Folder，用于链接

授权

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

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

setTrashed(trashed)

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

参数

名称类型说明
trashedBooleantrue（如果应将Folder移至以下位置的回收站： 用户的云端硬盘；如果不是，则为 false

返回

Folder - 此 Folder，用于链接

授权

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

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

已弃用的方法