Drive Service

云端硬盘

借助此服务,脚本可以在 Google 云端硬盘中创建、查找和修改文件和文件夹。

如果您的脚本使用标准 Cloud 项目而不是默认 Cloud 项目,则必须手动启用 Drive API。在标准 Cloud 项目中,启用 Drive API:

启用 Drive API

以下代码示例展示了如何记录用户的“我的云端硬盘”文件夹中每个文件的名称:
// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

名称简介
Access此枚举表示可以访问某个文件或文件夹的用户所属的类,以及已被明确授予访问权限的任何单个用户。
DriveApp允许脚本在 Google 云端硬盘中创建、查找和修改文件和文件夹。
FileGoogle 云端硬盘中的文件。
FileIterator一种迭代器,可让脚本对潜在的大型文件集合进行迭代。
FolderGoogle 云端硬盘中的文件夹。
FolderIterator可让脚本遍历可能庞大的文件夹集合的对象。
Permission一个枚举,表示向可以访问文件或文件夹的用户授予的权限,而不仅仅是已明确授予访问权限的任何单个用户。
User与 Google 云端硬盘中的文件关联的用户。

Access

属性

媒体资源类型说明
ANYONEEnum互联网上的任何人都可以找到和访问。
ANYONE_WITH_LINKEnum知道链接的任何人都可以访问。
DOMAINEnum您网域中的用户可以查找和访问。
DOMAIN_WITH_LINKEnum您网域中知道此链接的人可以访问。
PRIVATEEnum只有被明确授予权限的人才能访问。

DriveApp

属性

媒体资源类型说明
AccessAccess此枚举表示可以访问某个文件或文件夹的用户所属的类,以及已被明确授予访问权限的任何单个用户。
PermissionPermission一个枚举,表示向可以访问文件或文件夹的用户授予的权限,而不仅仅是已明确授予访问权限的任何单个用户。

方法

方法返回类型简介
continueFileIterator(continuationToken)FileIterator使用来自上一个迭代器的接续令牌恢复文件迭代。
continueFolderIterator(continuationToken)FolderIterator使用来自上一个迭代器的接续令牌恢复文件夹迭代。
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 和资源密钥创建快捷方式,并将其返回。
enforceSingleParent(value)void针对影响项父级的所有调用启用或停用 forceSingleParent 行为。
getFileById(id)File获取具有指定 ID 的文件。
getFileByIdAndResourceKey(id, resourceKey)File获取具有指定 ID 和资源密钥的文件。
getFiles()FileIterator获取用户云端硬盘中所有文件的集合。
getFilesByName(name)FileIterator获取用户云端硬盘中具有指定名称的所有文件的集合。
getFilesByType(mimeType)FileIterator获取用户云端硬盘中具有指定 MIME 类型的所有文件的集合。
getFolderById(id)Folder获取具有指定 ID 的文件夹。
getFolderByIdAndResourceKey(id, resourceKey)Folder获取具有指定 ID 和资源键的文件夹。
getFolders()FolderIterator获取用户云端硬盘中所有文件夹的集合。
getFoldersByName(name)FolderIterator获取用户的云端硬盘中具有指定名称的所有文件夹的集合。
getRootFolder()Folder获取位于用户云端硬盘根目录下的文件夹。
getStorageLimit()Integer获取允许用户在云端硬盘中存储的字节数。
getStorageUsed()Integer获取用户当前在云端硬盘中存储的字节数。
getTrashedFiles()FileIterator获取用户云端硬盘回收站中所有文件的集合。
getTrashedFolders()FolderIterator获取用户云端硬盘回收站中所有文件夹的集合。
searchFiles(params)FileIterator获取用户的云端硬盘中与指定搜索条件匹配的所有文件的集合。
searchFolders(params)FolderIterator获取用户的云端硬盘中与指定搜索条件匹配的所有文件夹的集合。

File

方法

方法返回类型简介
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获取文件所有者。
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)FileFile 的查看者和评论者列表中移除指定用户。
removeViewer(user)FileFile 的查看者和评论者列表中移除指定用户。
revokePermissions(emailAddress)File撤消已授予指定用户的 File 访问权限。
revokePermissions(user)File撤消已授予指定用户的 File 访问权限。
setContent(content)File使用指定的替换项覆盖文件的内容。
setDescription(description)File设置 File 的说明。
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 是否在用户云端硬盘的回收站中。

FileIterator

方法

方法返回类型简介
getContinuationToken()String获取可用于稍后继续此迭代的令牌。
hasNext()Boolean确定调用 next() 是否会返回项。
next()File获取文件或文件夹集合中的下一项。

Folder

方法

方法返回类型简介
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(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 是否在用户云端硬盘的回收站中。

FolderIterator

方法

方法返回类型简介
getContinuationToken()String获取可用于稍后继续此迭代的令牌。
hasNext()Boolean确定调用 next() 是否会返回项。
next()Folder获取文件或文件夹集合中的下一项。

Permission

属性

媒体资源类型说明
VIEWEnum有权访问文件或文件夹的用户只能查看或复制这些内容。
EDITEnum可以访问相关文件或文件夹的用户也能进行编辑。
COMMENTEnum拥有访问权限的用户只能查看、复制或评论文件或文件夹。
OWNEREnum用户是相应文件或文件夹的所有者。
ORGANIZEREnum可以在共享云端硬盘中整理文件和文件夹的用户。
FILE_ORGANIZEREnum可以编辑、将共享云端硬盘中的内容移至回收站以及将其移动的用户。
NONEEnum用户没有任何文件或文件夹的权限。

User

方法

方法返回类型简介
getDomain()String获取与用户账号关联的域名。
getEmail()String获取用户的电子邮件地址。
getName()String获取用户的名称。
getPhotoUrl()String获取用户照片的网址。