Zaawansowana usługa Dysku

zarządzać plikami i folderami, w tym właściwościami niestandardowymi i wersjami;

Zaawansowana usługa Dysku umożliwia korzystanie z interfejsu Google Drive API w Google Apps Script. Podobnie jak wbudowana usługa Dysku w Apps Script ten interfejs API umożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google. W większości przypadków usługa wbudowana jest łatwiejsza w użyciu, ale ta usługa zaawansowana zapewnia kilka dodatkowych funkcji, w tym dostęp do niestandardowych właściwości plików oraz wersji plików i folderów.

Jest to usługa zaawansowana, którą należy włączyć przed użyciem.

Dokumentacja

Szczegółowe informacje o tej usłudze znajdziesz w dokumentacji referencyjnej interfejsu Drive API. Podobnie jak wszystkie usługi zaawansowane w Apps Script, zaawansowana usługa Dysku korzysta z tych samych obiektów, metod i parametrów co publiczny interfejs API. Więcej informacji znajdziesz w artykule Jak określane są sygnatury metod. Metody o nazwie delete w interfejsie Drive API mają nazwę remove w usłudze zaawansowanej (np. Drive.Permissions.remove()), ponieważ delete jest słowem zastrzeżonym w JavaScript.

Aby zgłaszać problemy i uzyskać inną pomoc, zapoznaj się z przewodnikiem pomocy dotyczącym interfejsu Drive API.

Przykładowy kod

Przykłady kodu w tej sekcji korzystają z wersji 3 interfejsu API.

Prześlij pliki

Poniższy przykładowy kod pokazuje, jak zapisać plik na Dysku użytkownika.

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);
  }
}

Utwórz folder

Poniższy przykładowy kod pokazuje, jak utworzyć folder na Dysku.

/**
 * 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);
}

Szukanie plików

Poniższy przykładowy kod pokazuje, jak wyszukiwać pliki za pomocą ciągu zapytania.

/**
 * 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.');
  }
}

Wyświetlenie listy folderów

Poniższy przykładowy kod pokazuje, jak wyświetlić listę folderów najwyższego poziomu na Dysku użytkownika. Zwróć uwagę na użycie tokenów strony, aby uzyskać dostęp do pełnej listy wyników.

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);
}

Wyświetlanie listy wersji

Poniższy przykładowy kod pokazuje, jak wyświetlić listę wersji danego pliku. Pamiętaj, że niektóre pliki mogą mieć kilka wersji, a do uzyskania pełnej listy wyników należy używać tokenów strony.

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);
}

Dodawanie właściwości pliku

Poniższy przykładowy kod używa pola appProperties do dodania niestandardowej właściwości do pliku. Właściwość niestandardowa jest widoczna tylko dla skryptu. Aby dodać do pliku właściwość niestandardową, która będzie widoczna również w innych aplikacjach, użyj pola properties. Więcej informacji znajdziesz w artykule Dodawanie niestandardowych właściwości pliku.

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);
  }
}

Dodawanie użytkownika do pliku

Poniższy przykładowy kod pokazuje, jak dodać użytkownika jako edytującego plik i pominąć powiadomienie e-mail.

/**
 * 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
  });
}