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)FolderFolder 的编辑器列表中移除指定用户。
removeEditor(user)FolderFolder 的编辑器列表中移除指定用户。
removeViewer(emailAddress)FolderFolder 的查看者和评论者列表中删除指定用户。
removeViewer(user)FolderFolder 的查看者和评论者列表中删除指定用户。
revokePermissions(user)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 和资源键的快捷方式,并将其返回。资源键是一个额外的参数,需要传递此参数才能访问使用链接共享的目标文件或文件夹。

参数

名称类型说明
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 的编辑权限,则此方法会返回一个空数组。

返回

User[] - 具有编辑权限的用户数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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 的所有者。

返回

User - 表示所有者的 User 对象

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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 的编辑权限,此方法会返回一个空数组。

返回

User[] - 具有查看或评论权限的用户数组。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

  • 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(user)

撤消已授予指定用户的 Folder 的访问权限。如果用户所属的类别具有常规访问权限(例如,如果与整个网域共享 Folder),则此方法不会阻止用户访问 Folder

参数

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

返回

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 文档。请注意,params 参数是可能包含字符串值的查询字符串,因此请务必正确转义引号(例如 "title contains 'Gulliver\\'s Travels'"'title contains "Gulliver\'s Travels"')。

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

参数

名称类型说明
paramsString搜索条件,详见 Google 云端硬盘 SDK 文档

返回

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

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

searchFolders(params)

获取属于当前文件夹的子文件且与给定搜索条件匹配的所有文件夹的集合。如需详细了解搜索条件,请参阅 Google 云端硬盘 SDK 文档。请注意,params 参数是可能包含字符串值的查询字符串,因此请务必正确转义引号(例如 "title contains 'Gulliver\\'s Travels'"'title contains "Gulliver\'s Travels"')。

// Log 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();
  Logger.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

参数

名称类型说明
shareableBoolean如果具有编辑权限的用户应与其他用户共享或更改权限,则为 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);

参数

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

返回

Folder - 此 Folder,用于串联

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

setStarred(starred)

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

参数

名称类型说明
starredBoolean如果应在用户的云端硬盘中为 Folder 加星标,则为 true;否则为 false

返回

Folder - 此 Folder,用于串联

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

setTrashed(trashed)

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

参数

名称类型说明
trashedBoolean如果应将 Folder 移至用户云端硬盘的回收站,则为 true;否则为 false

返回

Folder - 此 Folder,用于串联

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权:

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

已废弃的方法