此页面由 Cloud Translation API 翻译。

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 云端硬盘中创建、查找和修改文件和文件夹。
`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`	为影响项父级的所有调用启用或停用 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)`	`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`	获取用户照片的网址。