高级云端硬盘服务

借助高级云端硬盘服务,您可以在 Apps 脚本中使用 Google 云端硬盘 Web API。就像 Apps 脚本的内置云端硬盘服务一样,此 API 允许脚本在 Google 云端硬盘中创建、查找和修改文件和文件夹。在大多数情况下,内置服务更易于使用,但此高级服务提供了一些其他功能,包括对自定义文件属性的访问权限以及文件和文件夹的修订版本。

参考

如需详细了解此服务,请参阅 Google Drive Web API 的参考文档。与 Apps 脚本中的所有高级服务一样,高级云端硬盘服务使用与公共 API 相同的对象、方法和参数。如需了解详情,请参阅如何确定方法签名

如需报告问题并寻求其他支持,请参阅云端硬盘 v2 支持指南

示例代码

以下示例代码使用了该 API 的版本 2

上传文件

以下示例展示了如何将文件保存到用户的云端硬盘。

高级/drive.gs
/**
 * Uploads a new file to the user's Drive.
 */
function uploadFile() {
  try {
    // Makes a request to fetch a URL.
    const image = UrlFetchApp.fetch('http://goo.gl/nd7zjB').getBlob();
    let file = {
      title: 'google_logo.png',
      mimeType: 'image/png'
    };
    // Insert new files to user's Drive
    file = Drive.Files.insert(file, image);
    Logger.log('ID: %s, File size (bytes): %s', file.id, file.fileSize);
  } catch (err) {
    // TODO (developer) - Handle exception
    Logger.log('Failed to upload file with error %s', err.message);
  }
}

列出文件夹

以下示例演示了如何列出用户的云端硬盘中的顶级文件夹。请注意,使用页面令牌来获取完整的结果列表。

高级/drive.gs
/**
 * Lists the top-level folders in the user's Drive.
 */
function listRootFolders() {
  const query = '"root" in parents and trashed = false and ' +
    'mimeType = "application/vnd.google-apps.folder"';
  let folders;
  let pageToken = null;
  do {
    try {
      folders = Drive.Files.list({
        q: query,
        maxResults: 100,
        pageToken: pageToken
      });
      if (!folders.items || folders.items.length === 0) {
        Logger.log('No folders found.');
        return;
      }
      for (let i = 0; i < folders.items.length; i++) {
        const folder = folders.items[i];
        Logger.log('%s (ID: %s)', folder.title, folder.id);
      }
      pageToken = folders.nextPageToken;
    } catch (err) {
      // TODO (developer) - Handle exception
      Logger.log('Failed with error %s', err.message);
    }
  } while (pageToken);
}

商家信息修订版本

以下示例演示了如何列出给定文件的修订版本。请注意,某些修订版本属性仅适用于特定文件类型。例如, Google Workspace 应用文件不会占用 Google 云端硬盘空间,因此返回的文件大小为 0

高级/drive.gs
/**
 * Lists the revisions of a given file. Note that some properties of revisions
 * are only available for certain file types. For example, G Suite application
 * files do not consume space in Google Drive and thus list a file size of 0.
 * @param {string} fileId The ID of the file to list revisions for.
 */
function listRevisions(fileId) {
  try {
    const revisions = Drive.Revisions.list(fileId);
    if (!revisions.items || revisions.items.length === 0) {
      Logger.log('No revisions found.');
      return;
    }
    for (let i = 0; i < revisions.items.length; i++) {
      const revision = revisions.items[i];
      const date = new Date(revision.modifiedDate);
      Logger.log('Date: %s, File size (bytes): %s', date.toLocaleString(),
          revision.fileSize);
    }
  } catch (err) {
    // TODO (developer) - Handle exception
    Logger.log('Failed with error %s', err.message);
  }
}

添加自定义属性

以下示例演示了如何向文件添加自定义属性。与 Apps 脚本的文档属性不同,云端硬盘的自定义文件属性可以在 Apps 脚本之外访问,并且可以通过其他应用访问(如果公开范围设置为 PUBLIC)。

高级/drive.gs
/**
 * Adds a custom property to a file. Unlike Apps Script's DocumentProperties,
 * Drive's custom file properties can be accessed outside of Apps Script and
 * by other applications (if the visibility is set to PUBLIC).
 * @param {string} fileId The ID of the file to add the property to.
 */
function addCustomProperty(fileId) {
  try {
    const property = {
      key: 'department',
      value: 'Sales',
      visibility: 'PUBLIC'
    };
    // Adds a property to a file
    Drive.Properties.insert(property, fileId);
  } catch (err) {
    // TODO (developer) - Handle exception
    Logger.log('Failed with error %s', err.message);
  }
}