Расширенная служба привода

для управления файлами и папками, включая пользовательские свойства и версии.

Расширенная служба Google Drive позволяет использовать API Google Drive в Google Apps Script. Подобно встроенной службе Google Drive в Apps Script, этот API позволяет скриптам создавать, находить и изменять файлы и папки в Google Drive. В большинстве случаев встроенная служба проще в использовании, но эта расширенная служба предоставляет несколько дополнительных функций, включая доступ к пользовательским свойствам файлов, а также к версиям файлов и папок.

Это расширенная услуга, которую необходимо активировать перед использованием .

Ссылка

Подробную информацию об этом сервисе см. в справочной документации по API Google Drive. Как и все расширенные сервисы в Apps Script, расширенный сервис Google Drive использует те же объекты, методы и параметры, что и публичный API. Дополнительную информацию см. в разделе «Как определяются сигнатуры методов» . Кроме того, методы с именем delete в API Google Drive называются remove в расширенном сервисе (например, Drive.Permissions.remove() ), поскольку delete является зарезервированным словом в JavaScript.

Чтобы сообщить о проблемах и получить другую поддержку, см. руководство по поддержке Drive API .

Пример кода

В примерах кода в этом разделе используется версия 3 API.

Загрузка файлов

Приведённый ниже пример кода демонстрирует, как сохранить файл на Диск пользователя.

advanced/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 = {
      name: "google_logo.png",
      mimeType: "image/png",
    };
    // Create a file in the user's Drive.
    file = Drive.Files.create(file, image, { fields: "id,size" });
    console.log("ID: %s, File size (bytes): %s", file.id, file.size);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed to upload file with error %s", err.message);
  }
}

Создайте папку

Приведённый ниже пример кода демонстрирует, как создать папку в Google Диске.

/**
 * Creates a new folder.
 */
function createFolder() {
  var folderMetadata = {
    'name': 'New Folder',
    'mimeType': 'application/vnd.google-apps.folder'
  };
  var folder = Drive.Files.create(folderMetadata);
  Logger.log('Folder ID: ' + folder.id);
}

Поиск файлов

Приведённый ниже пример кода демонстрирует поиск файлов с использованием поисковой строки.

/**
 * Searches for files with a specific name.
 */
function searchFiles() {
  var query = 'name contains "Project Plan" and trashed = false';
  var files = Drive.Files.list({
    'q': query,
    'fields': 'files(id, name, mimeType)'
  });
  if (files.files && files.files.length > 0) {
    for (var i = 0; i < files.files.length; i++) {
      var file = files.files[i];
      Logger.log('%s (ID: %s)', file.name, file.id);
    }
  } else {
    Logger.log('No files found.');
  }
}

Список папок

Приведённый ниже пример кода показывает, как вывести список папок верхнего уровня в Google Диске пользователя. Обратите внимание на использование токенов страниц для доступа к полному списку результатов.

advanced/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,
        pageSize: 100,
        pageToken: pageToken,
      });
      if (!folders.files || folders.files.length === 0) {
        console.log("All folders found.");
        return;
      }
      for (let i = 0; i < folders.files.length; i++) {
        const folder = folders.files[i];
        console.log("%s (ID: %s)", folder.name, folder.id);
      }
      pageToken = folders.nextPageToken;
    } catch (err) {
      // TODO (developer) - Handle exception
      console.log("Failed with error %s", err.message);
    }
  } while (pageToken);
}

Изменения в списке

Приведённый ниже пример кода показывает, как вывести список ревизий для заданного файла. Обратите внимание, что некоторые файлы могут иметь несколько ревизий, и для доступа к полному списку результатов следует использовать токены страниц.

advanced/drive.gs
/**
 * Lists the revisions of a given file.
 * @param {string} fileId The ID of the file to list revisions for.
 */
function listRevisions(fileId) {
  let revisions;
  let pageToken = null;
  do {
    try {
      revisions = Drive.Revisions.list(fileId, {
        fields: "revisions(modifiedTime,size),nextPageToken",
      });
      if (!revisions.revisions || revisions.revisions.length === 0) {
        console.log("All revisions found.");
        return;
      }
      for (let i = 0; i < revisions.revisions.length; i++) {
        const revision = revisions.revisions[i];
        const date = new Date(revision.modifiedTime);
        console.log(
          "Date: %s, File size (bytes): %s",
          date.toLocaleString(),
          revision.size,
        );
      }
      pageToken = revisions.nextPageToken;
    } catch (err) {
      // TODO (developer) - Handle exception
      console.log("Failed with error %s", err.message);
    }
  } while (pageToken);
}

Добавить свойства файла

В приведенном ниже примере кода используется поле appProperties для добавления пользовательского свойства в файл. Это пользовательское свойство видно только скрипту. Чтобы добавить в файл пользовательское свойство, видимое и другим приложениям, используйте вместо этого поле properties . Дополнительную информацию см. в разделе «Добавление пользовательских свойств файла» .

advanced/drive.gs
/**
 * Adds a custom app 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; however, appProperties are only visible to the script.
 * @param {string} fileId The ID of the file to add the app property to.
 */
function addAppProperty(fileId) {
  try {
    let file = {
      appProperties: {
        department: "Sales",
      },
    };
    // Updates a file to add an app property.
    file = Drive.Files.update(file, fileId, null, {
      fields: "id,appProperties",
    });
    console.log(
      "ID: %s, appProperties: %s",
      file.id,
      JSON.stringify(file.appProperties, null, 2),
    );
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log("Failed with error %s", err.message);
  }
}

Добавить пользователя в файл

Приведенный ниже пример кода демонстрирует, как добавить пользователя в качестве редактора файла и отключить отправку уведомлений по электронной почте.

/**
 * Adds a user to a file as an editor without sending an email notification.
 */
function addEditor() {
  var fileId = '1234567890abcdefghijklmnopqrstuvwxyz';
  var userEmail = 'bob@example.com';
  var request = {
    'role': 'writer',
    'type': 'user',
    'emailAddress': userEmail
  };
  Drive.Permissions.create(request, fileId, {
    'sendNotificationEmail': false
  });
}