Erweiterter Drive-Dienst

Dateien und Ordner verwalten, einschließlich benutzerdefinierter Attribute und Überarbeitungen.

Mit dem erweiterten Drive-Dienst können Sie die Google Drive API in Google Apps Script verwenden. Ähnlich wie beim integrierten Drive-Dienst von Apps Script können mit dieser API Dateien und Ordner in Google Drive erstellt, gesucht und geändert werden. In den meisten Fällen ist der integrierte Dienst einfacher zu verwenden. Dieser erweiterte Dienst bietet jedoch einige zusätzliche Funktionen, darunter den Zugriff auf benutzerdefinierte Dateieigenschaften sowie auf Revisionen für Dateien und Ordner.

Dies ist ein erweiterter Dienst, der vor der Verwendung aktiviert werden muss.

Referenz

Ausführliche Informationen zu diesem Dienst finden Sie in der Referenzdokumentation für die Drive API. Wie alle erweiterten Dienste in Apps Script verwendet der erweiterte Drive-Dienst dieselben Objekte, Methoden und Parameter wie die öffentliche API. Weitere Informationen finden Sie unter Methodensignaturen. Außerdem werden Methoden mit dem Namen delete in der Drive API im erweiterten Dienst (z. B. Drive.Permissions.remove()) als remove bezeichnet, da delete ein reserviertes Wort in JavaScript ist.

Informationen zum Melden von Problemen und zu Supportoptionen finden Sie im Drive API-Supportleitfaden.

Beispielcode

In den Codebeispielen in diesem Abschnitt wird Version 3 der API verwendet.

Dateien hochladen

Das folgende Codebeispiel zeigt, wie eine Datei in Google Drive eines Nutzers gespeichert wird.

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

Ordner erstellen

Das folgende Codebeispiel zeigt, wie Sie einen Ordner in Drive erstellen.

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

Nach Dateien suchen

Im folgenden Codebeispiel wird gezeigt, wie Sie mit einem Abfragestring nach Dateien suchen.

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

Ordner auflisten

Das folgende Codebeispiel zeigt, wie die Ordner der obersten Ebene im Drive des Nutzers aufgelistet werden. Beachten Sie die Verwendung von Seitentokens, um auf die vollständige Liste der Ergebnisse zuzugreifen.

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

Versionen auflisten

Im folgenden Codebeispiel wird gezeigt, wie Sie die Überarbeitungen für eine bestimmte Datei auflisten. Einige Dateien können mehrere Überarbeitungen haben. Verwenden Sie Seitentokens, um auf die vollständige Liste der Ergebnisse zuzugreifen.

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

Dateieigenschaften hinzufügen

Im folgenden Codebeispiel wird das Feld appProperties verwendet, um einer Datei eine benutzerdefinierte Eigenschaft hinzuzufügen. Die benutzerdefinierte Eigenschaft ist nur für das Script sichtbar. Wenn Sie der Datei eine benutzerdefinierte Property hinzufügen möchten, die auch für andere Apps sichtbar ist, verwenden Sie stattdessen das Feld properties. Weitere Informationen finden Sie unter Benutzerdefinierte Dateieigenschaften hinzufügen.

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

Nutzer einer Datei hinzufügen

Das folgende Codebeispiel zeigt, wie Sie einen Nutzer als Mitbearbeiter einer Datei hinzufügen und die E‑Mail-Benachrichtigung unterdrücken.

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