此页面由 Cloud Translation API 翻译。

Drive Service

借助此服务，脚本可以在 Google 云端硬盘中创建、查找和修改文件和文件夹。虽然内置云端硬盘服务更易于使用，但也存在一些限制。如需使用最新的功能和支持服务，以及访问共享云端硬盘中的文件或文件夹，请使用高级云端硬盘服务。

如果您的脚本使用的是标准 Cloud 项目（而非默认 Cloud 项目），您必须手动启用 Drive API。在标准 Cloud 项目中，开启 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 云端硬盘中创建、查找和修改文件和文件夹。
`File`	Google 云端硬盘中的文件。
`FileIterator`	一个迭代器，可让脚本迭代可能非常大的文件集合。
`Folder`	Google 云端硬盘中的文件夹。
`FolderIterator`	一个对象，可让脚本迭代可能非常大的文件夹集合。
`Permission`	一个枚举，表示除了已明确授予访问权限的任何个人用户之外，可访问文件或文件夹的用户所获授权限。
`User`	与 Google 云端硬盘中的文件关联的用户。

`Access`

属性

属性	类型	说明
`ANYONE`	`Enum`	互联网上的任何人都可以查找和访问。
`ANYONE_WITH_LINK`	`Enum`	知道链接的任何人都可以访问。
`DOMAIN`	`Enum`	您网域中的用户可以查找和访问。
`DOMAIN_WITH_LINK`	`Enum`	您网域中知道该链接的人可以访问。
`PRIVATE`	`Enum`	只有被明确授予权限的人才能访问。

`DriveApp`

属性

属性	类型	说明
`Access`	`Access`	一个枚举，表示除了已明确授予访问权限的任何个人用户之外，可以访问文件或文件夹的用户类别。
`Permission`	`Permission`	一个枚举，表示除了已明确授予访问权限的任何个人用户之外，向可以访问文件或文件夹的用户授予的权限。

方法

方法	返回类型	简介
`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`	为影响项父项的所有调用启用或停用 enforceSingleParent 行为。
`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)`	`File`	从 `File` 的评论者列表中移除指定用户。
`removeCommenter(user)`	`File`	从 `File` 的评论者列表中移除指定用户。
`removeEditor(emailAddress)`	`File`	从 `File` 的编辑者列表中移除指定用户。
`removeEditor(user)`	`File`	从 `File` 的编辑者列表中移除指定用户。
`removeViewer(emailAddress)`	`File`	从 `File` 的观看者和评论者列表中移除指定用户。
`removeViewer(user)`	`File`	从 `File` 的观看者和评论者列表中移除指定用户。
`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)`	`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` 是否位于用户云端硬盘的回收站中。

`FolderIterator`

方法

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

`Permission`

属性

属性	类型	说明
`VIEW`	`Enum`	有权访问文件或文件夹的用户只能查看或复制这些内容。
`EDIT`	`Enum`	能够访问相应文件或文件夹的用户可以对其进行修改。
`COMMENT`	`Enum`	有权访问文件或文件夹的用户只能查看、复制或评论这些内容。
`OWNER`	`Enum`	用户是文件或文件夹的所有者。
`ORGANIZER`	`Enum`	可以在共享云端硬盘中整理文件和文件夹的用户。
`FILE_ORGANIZER`	`Enum`	可以在共享云端硬盘中修改、移至回收站和移动内容的用户。
`NONE`	`Enum`	用户对相应文件或文件夹没有任何权限。

`User`

方法

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