Drive Service

云端硬盘

此服务允许脚本在 Google 云端硬盘中创建、查找和修改文件和文件夹。

// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  Logger.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获取 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)FileFile 的查看者和评论者列表中删除指定用户。
removeViewer(user)FileFile 的查看者和评论者列表中删除指定用户。
revokePermissions(user)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(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 是否位于用户的云端硬盘的回收站中。

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获取用户照片的网址。