Class File

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

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

// Trash every untitled spreadsheet that hasn't been updated in a week.
var files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  var file = files.next();
  if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) {
    file.setTrashed(true);
  }
}

方法

方法返回类型简介
addCommenter(emailAddress)File将指定用户添加到 File 的评论者列表中。
addCommenter(user)File将指定用户添加到 File 的评论者列表中。
addCommenters(emailAddresses)File将指定用户数组添加到 File 的评论者列表中。
addEditor(emailAddress)File将指定用户添加到 File 的编辑器列表中。
addEditor(user)File将指定用户添加到 File 的编辑器列表中。
addEditors(emailAddresses)File将指定用户数组添加到 File 的编辑器列表中。
addViewer(emailAddress)File将指定用户添加到 File 的查看者列表中。
addViewer(user)File将指定用户添加到 File 的查看者列表中。
addViewers(emailAddresses)File将指定用户数组添加到 File 的查看者列表中。
getAccess(email)Permission获取授予指定用户的权限。
getAccess(user)Permission获取授予指定用户的权限。
getAs(contentType)Blob以转换为指定内容类型的 blob 的形式返回此对象内的数据。
getBlob()Blob以 blob 形式返回此对象内的数据。
getDateCreated()Date获取 File 的创建日期。
getDescription()String获取 File 的说明。
getDownloadUrl()String获取可用于下载文件的网址。
getEditors()User[]获取此 File 的编辑器列表。
getId()String获取 File 的 ID。
getLastUpdated()Date获取 File 的上次更新日期。
getMimeType()String获取文件的 MIME 类型。
getName()String获取 File 的名称。
getOwner()User获取 File 的所有者。
getParents()FolderIterator获取文件夹集合,这些文件夹是 File 的直接父级。
getResourceKey()String获取访问使用链接共享的项所需的 File 的资源键。
getSecurityUpdateEligible()Boolean获取此 File 是否符合应用通过资源共享时需要使用资源密钥的安全更新的条件。
getSecurityUpdateEnabled()Boolean获取通过链接共享时,此 File 是否需要资源密钥进行访问。
getSharingAccess()Access获取哪类用户除了已明确获得访问权限的各个用户外,还可以访问 File
getSharingPermission()Permission获取有权访问 File 的用户(任何明确获得访问权限的用户除外)的权限。
getSize()Integer获取用于在云端硬盘中存储 File 的字节数。
getTargetId()String如果这是一个快捷方式,则返回它所指向的项的 ID。
getTargetMimeType()String如果这是快捷方式,则返回所指内容的 MIME 类型。
getTargetResourceKey()String如果该文件为快捷方式,则返回其所指向项的资源键。
getThumbnail()Blob获取文件的缩略图,如果不存在缩略图,则返回 null
getUrl()String获取可用于在 Google 应用(例如云端硬盘或文档)中打开 File 的网址。
getViewers()User[]获取此 File 的查看者和评论者列表。
isShareableByEditors()Boolean确定拥有 File 修改权限的用户是否可以与其他用户共享或更改权限。
isStarred()Boolean确定 File 是否已在用户的云端硬盘中加注星标。
isTrashed()Boolean决定 File 是否在用户的云端硬盘回收站中。
makeCopy()File创建文件的副本。
makeCopy(destination)File在目标目录中创建文件的副本。
makeCopy(name)File创建文件的副本,并使用提供的名称为其命名。
makeCopy(name, destination)File在目标目录中创建文件的副本,并使用提供的名称为其命名。
moveTo(destination)File将该项移动到提供的目标文件夹中。
removeCommenter(emailAddress)FileFile 的评论者列表中移除指定用户。
removeCommenter(user)FileFile 的评论者列表中移除指定用户。
removeEditor(emailAddress)FileFile 的编辑器列表中移除给定用户。
removeEditor(user)FileFile 的编辑器列表中移除给定用户。
removeViewer(emailAddress)File将指定用户从 File 的查看者和评论者列表中移除。
removeViewer(user)File将指定用户从 File 的查看者和评论者列表中移除。
revokePermissions(emailAddress)File撤消授予指定用户的 File 的访问权限。
revokePermissions(user)File撤消授予指定用户的 File 的访问权限。
setContent(content)File使用指定的替换项覆盖文件的内容。
setDescription(description)FileFile 设置说明。
setName(name)File设置 File 的名称。
setOwner(emailAddress)File更改 File 的所有者。
setOwner(user)File更改 File 的所有者。
setSecurityUpdateEnabled(enabled)File设置 File 在使用链接共享时是否需要资源密钥进行访问。
setShareableByEditors(shareable)File设置是否允许对 File 拥有编辑权限的用户与其他用户共享或更改权限。
setSharing(accessType, permissionType)File设置除了已明确获得访问权限的各个用户之外,哪些用户可以访问 File 以及这些用户具有哪些权限。
setStarred(starred)File设置是否在用户的云端硬盘中为 File 加注星标。
setTrashed(trashed)File设置 File 是否在用户的云端硬盘回收站中。

详细文档

addCommenter(emailAddress)

将指定用户添加到 File 的评论者列表中。如果用户已位于查看者列表中,则此方法会将该用户从查看者列表中升级。

参数

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

返回

File - 此 File,用于串联。

授权

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

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

addCommenter(user)

将指定用户添加到 File 的评论者列表中。如果用户已位于查看者列表中,则此方法会将该用户从查看者列表中升级。

参数

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

返回

File - 此 File,用于串联。

授权

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

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

addCommenters(emailAddresses)

将指定用户数组添加到 File 的评论者列表中。如果其中有任何用户已经在查看者列表中,此方法会将他们从查看者列表中升级出来。

参数

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

返回

File - 此 File,用于串联。

授权

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

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

addEditor(emailAddress)

将指定用户添加到 File 的编辑器列表中。如果用户已位于查看者列表中,则此方法会将该用户从查看者列表中升级。

参数

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

返回

File - 此 File,用于串联。

授权

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

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

addEditor(user)

将指定用户添加到 File 的编辑器列表中。如果用户已位于查看者列表中,则此方法会将该用户从查看者列表中升级。

参数

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

返回

File - 此 File,用于串联。

授权

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

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

addEditors(emailAddresses)

将指定用户数组添加到 File 的编辑器列表中。如果其中有任何用户已经在查看者列表中,此方法会将他们从查看者列表中升级。

参数

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

返回

File - 此 File,用于串联。

授权

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

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

addViewer(emailAddress)

将指定用户添加到 File 的查看者列表中。如果用户已经在编辑器列表中,则此方法不会产生任何影响。

参数

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

返回

File - 此 File,用于串联。

授权

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

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

addViewer(user)

将指定用户添加到 File 的查看者列表中。如果用户已经在编辑器列表中,则此方法不会产生任何影响。

参数

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

返回

File - 此 File,用于串联。

授权

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

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

addViewers(emailAddresses)

将指定用户数组添加到 File 的查看者列表中。如果任何用户已经在编辑器列表中,此方法对他们没有影响。

参数

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

返回

File - 此 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

getAs(contentType)

以转换为指定内容类型的 blob 的形式返回此对象内的数据。此方法会在文件名中添加适当的扩展名,例如“myfile.pdf”。不过,其中假定文件名中最后一个句号后面的部分(如果有)是应替换的现有扩展名。因此,“ShoppingList.12.25.2014”将变为“ShoppingList.12.25.pdf”。

如需查看转化次数的每日配额,请参阅 Google 服务的配额。新创建的 Google Workspace 网域可能暂时受到更严格的配额约束。

参数

名称类型说明
contentTypeString要转换为的 MIME 类型。对于大多数 blob,'application/pdf' 是唯一有效的选项。对于 BMP、GIF、JPEG 或 PNG 格式的图片,'image/bmp''image/gif''image/jpeg''image/png' 中的任何一种也有效。

返回

Blob - 表示 blob 的数据。


getBlob()

以 blob 形式返回此对象内的数据。

返回

Blob - 表示 blob 的数据。


getDateCreated()

获取 File 的创建日期。

返回

Date - File 的创建日期

授权

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

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

getDescription()

获取 File 的说明。

返回

String - File 的说明

授权

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

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

getDownloadUrl()

获取可用于下载文件的网址。只有有权在 Google 云端硬盘中打开文件的用户才能访问该网址您可以在浏览器中使用此网址下载文件,但无法使用 UrlFetchApp 提取该文件。如果您需要在脚本中包含文件内容,请使用 getBlob()

返回

String - 可用于下载文件的网址。

授权

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

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

getEditors()

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

返回

User[] - 具有修改权限的用户数组。

授权

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

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

getId()

获取 File 的 ID。

返回

String - File 的 ID

授权

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

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

getLastUpdated()

获取 File 的上次更新日期。

返回

Date - File 的上次更新日期

授权

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

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

getMimeType()

获取文件的 MIME 类型。

返回

String - 文件的 MIME 类型。

授权

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

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

getName()

获取 File 的名称。

返回

String - File 的名称

授权

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

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

getOwner()

获取 File 的所有者。

返回

User - 表示所有者的 User 对象

授权

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

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

getParents()

获取文件夹集合,这些文件夹是 File 的直接父级。

返回

FolderIterator - 文件夹的集合,文件夹是 File 的直接父级

授权

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

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

getResourceKey()

获取访问使用链接共享的项所需的 File 的资源键。

返回

String - File 的资源键。

授权

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

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

getSecurityUpdateEligible()

获取此 File 是否符合应用通过资源共享时需要使用资源密钥的安全更新的条件。

云端硬盘需要资源密钥才能访问使用链接共享的某些文件或文件夹。此更改属于安全更新的一部分。默认情况下,符合条件的文件和文件夹会开启更新功能。如需为符合条件的文件启用或停用资源密钥要求,请使用 setSecurityUpdateEnabled

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

返回

Boolean - 可否为 File 应用资源密钥要求。

授权

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

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

getSecurityUpdateEnabled()

获取通过链接共享时,此 File 是否需要资源密钥进行访问。默认情况下,系统会为符合条件的文件和文件夹启用此要求。 如需为符合条件的文件启用或停用资源密钥要求,请使用 setSecurityUpdateEnabled

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

返回

Boolean - 表示是否为此 File 启用了资源密钥要求。

授权

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

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

getSharingAccess()

获取哪类用户除了已明确获得访问权限的各个用户外,还可以访问 File

返回

Access - 哪种类型的用户可以访问 File

授权

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

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

getSharingPermission()

获取有权访问 File 的用户(任何明确获得访问权限的用户除外)的权限。

返回

Permission - 授予有权访问 File 的用户的权限

授权

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

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

getSize()

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

返回

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

授权

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

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

getTargetId()

如果这是一个快捷方式,则返回它所指向的项的 ID。

否则,它会返回 null

返回

String - 目标项 ID。


getTargetMimeType()

如果这是快捷方式,则返回所指内容的 MIME 类型。

否则,它会返回 null

返回

String - 目标内容的 MIME 类型。


getTargetResourceKey()

如果该文件为快捷方式,则返回其所指向项的资源键。资源键是需要通过访问传递给使用链接共享的文件的额外参数。

如果文件不是快捷方式,它会返回 null

返回

String - 目标项的资源键或 null(如果文件不是快捷方式)。

授权

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

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

getThumbnail()

获取文件的缩略图,如果不存在缩略图,则返回 null

返回

Blob - 文件的缩略图。

授权

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

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

getUrl()

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

返回

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

授权

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

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

getViewers()

获取此 File 的查看者和评论者列表。如果执行脚本的用户没有 File 的修改权限,则此方法会返回空数组。

返回

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

授权

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

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

isShareableByEditors()

确定拥有 File 修改权限的用户是否可以与其他用户共享或更改权限。

返回

Boolean - 如果允许具有编辑权限的用户共享或更改权限,则为 true;否则,返回 false

授权

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

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

isStarred()

确定 File 是否已在用户的云端硬盘中加注星标。

返回

Boolean - 如果用户的云端硬盘中已加星标File,则为 true;如果未加星标,则为 false

授权

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

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

isTrashed()

决定 File 是否在用户的云端硬盘回收站中。

返回

Boolean - 如果 File 位于用户云端硬盘的回收站中,则为 true;如果未位于用户的云端硬盘,则为 false

授权

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

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

makeCopy()

创建文件的副本。

返回

File - 新副本。

授权

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

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

makeCopy(destination)

在目标目录中创建文件的副本。

参数

名称类型说明
destinationFolder要将文件复制到的目录。

返回

File - 新副本。

授权

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

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

makeCopy(name)

创建文件的副本,并使用提供的名称为其命名。

参数

名称类型说明
nameString应应用于新副本的文件名。

返回

File - 新副本。

授权

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

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

makeCopy(name, destination)

在目标目录中创建文件的副本,并使用提供的名称为其命名。

参数

名称类型说明
nameString应应用于新副本的文件名。
destinationFolder要将文件复制到的目录。

返回

File - 新副本。

授权

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

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

moveTo(destination)

将该项移动到提供的目标文件夹中。

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

参数

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

返回

File - 此 File,用于串联。

授权

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

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

removeCommenter(emailAddress)

File 的评论者列表中移除指定用户。如果用户所属的类别具有常规访问权限(例如,如果与用户的整个网域共享 File),则此方法不会阻止用户访问 File

参数

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

返回

File - 此 File,用于串联。

授权

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

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

removeCommenter(user)

File 的评论者列表中移除指定用户。如果用户所属的类别具有常规访问权限(例如,如果与用户的整个网域共享 File),则此方法不会阻止用户访问 File

参数

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

返回

File - 此 File,用于串联。

授权

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

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

removeEditor(emailAddress)

File 的编辑器列表中移除给定用户。如果用户属于具有常规访问权限的一类用户(例如,与用户的整个网域共享 File,或用户可访问的 File 位于共享云端硬盘中),则此方法不会阻止用户访问 File

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

参数

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

返回

File - 此 File,用于串联。

授权

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

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

removeEditor(user)

File 的编辑器列表中移除给定用户。如果用户属于具有常规访问权限的一类用户(例如,与用户的整个网域共享 File,或用户可访问的 File 位于共享云端硬盘中),则此方法不会阻止用户访问 File

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

参数

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

返回

File - 此 File,用于串联。

授权

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

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

removeViewer(emailAddress)

将指定用户从 File 的查看者和评论者列表中移除。如果用户是编辑者,而不是查看者或评论者,则此方法不会产生任何影响。如果用户所属的类别具有常规访问权限(例如,如果与用户的整个网域共享了 File,或者 File 位于用户可以访问的共享云端硬盘中),则此方法也不会阻止用户访问 File

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

参数

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

返回

File - 用于串联的 File

授权

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

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

removeViewer(user)

将指定用户从 File 的查看者和评论者列表中移除。如果用户是编辑者,而非查看者,则此方法无效。如果用户所属的类别具有常规访问权限(例如,如果与用户的整个网域共享了 File,或者 File 位于用户可以访问的共享云端硬盘中),则此方法也不会阻止用户访问 File

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

参数

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

返回

File - 用于串联的 File

授权

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

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

revokePermissions(emailAddress)

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

参数

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

返回

File - 此 File,用于串联。

授权

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

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

revokePermissions(user)

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

参数

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

返回

File - 此 File,用于串联。

授权

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

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

setContent(content)

使用指定的替换项覆盖文件的内容。如果 content 大于 10MB,则会抛出异常。

参数

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

返回

File - 此 File,用于串联。

授权

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

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

setDescription(description)

File 设置说明。

参数

名称类型说明
descriptionStringFile的新说明

返回

File - 此 File,用于连锁

授权

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

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

setName(name)

设置 File 的名称。

参数

名称类型说明
nameStringFile 的新名称

返回

File - 此 File,用于连锁

授权

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

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

setOwner(emailAddress)

更改 File 的所有者。此方法还为前任所有者提供了对 File 的明确编辑权限。

参数

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

返回

File - 此 File,用于连锁

授权

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

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

setOwner(user)

更改 File 的所有者。此方法还为前任所有者提供了对 File 的明确编辑权限。

参数

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

返回

File - 此 File,用于连锁

授权

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

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

setSecurityUpdateEnabled(enabled)

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

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

参数

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

返回

File - 此 File,用于串联。

授权

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

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

setShareableByEditors(shareable)

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

参数

名称类型说明
shareableBoolean如果允许具有编辑权限的用户与其他用户共享或更改权限,则为 true;否则不允许 false

返回

File - 此 File,用于连锁

授权

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

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

setSharing(accessType, permissionType)

设置除了已明确获得访问权限的各个用户之外,还有哪些用户可以访问 File 以及这些用户具有哪些权限。

// 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哪类用户应该能够访问File
permissionTypePermission应授予可访问 File 的用户的权限

返回

File - 此 File,用于连锁

授权

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

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

setStarred(starred)

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

参数

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

返回

File - 此 File,用于连锁

授权

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

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

setTrashed(trashed)

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

参数

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

返回

File - 此 File,用于连锁

授权

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

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