Class DriveApp

DriveApp

Ermöglicht es Scripts, Dateien und Ordner in Google Drive zu erstellen, zu finden und zu ändern. Wenn Sie auf Dateien oder Ordner in geteilten Ablagen zugreifen möchten, verwenden Sie den erweiterten Drive-Dienst.

// Logs the name of every file in the user's Drive.
const files = DriveApp.getFiles();
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

Attribute

AttributTypBeschreibung
AccessAccessEin Enum, das Nutzergruppen darstellt, die neben einzelnen Nutzern, denen explizit Zugriff gewährt wurde, auf eine Datei oder einen Ordner zugreifen können.
PermissionPermissionEin Enum, das die Berechtigungen für Nutzer darstellt, die auf eine Datei oder einen Ordner zugreifen können, zusätzlich zu einzelnen Nutzern, denen ausdrücklich Zugriff gewährt wurde.

Methoden

MethodeRückgabetypKurzbeschreibung
continueFileIterator(continuationToken)FileIteratorSetzt eine Dateiiteration mit einem Fortsetzungstoken aus einem vorherigen Iterator fort.
continueFolderIterator(continuationToken)FolderIteratorEine Ordneriteration wird mit einem Fortsetzungstoken aus einem vorherigen Iterator fortgesetzt.
createFile(blob)FileErstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers aus einer bestimmten Blob mit beliebigen Daten.
createFile(name, content)FileErstellt eine Textdatei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen, Inhalt und MIME-Typ.
createFolder(name)FolderErstellt einen Ordner im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen.
createShortcut(targetId)FileErstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileErstellt eine Verknüpfung mit der angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück.
enforceSingleParent(value)voidAktiviert oder deaktiviert das Verhalten „enforceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente von Artikeln auswirken.
getFileById(id)FileRuft die Datei mit der angegebenen ID ab.
getFileByIdAndResourceKey(id, resourceKey)FileRuft die Datei mit der angegebenen ID und dem Ressourcenschlüssel ab.
getFiles()FileIteratorEine Sammlung aller Dateien im Drive des Nutzers wird abgerufen.
getFilesByName(name)FileIteratorRuft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Namen haben.
getFilesByType(mimeType)FileIteratorStellt eine Sammlung aller Dateien im Drive des Nutzers mit dem angegebenen MIME-Typ bereit.
getFolderById(id)FolderRuft den Ordner mit der angegebenen ID ab.
getFolderByIdAndResourceKey(id, resourceKey)FolderRuft den Ordner mit der angegebenen ID und dem Ressourcenschlüssel ab.
getFolders()FolderIteratorEine Sammlung aller Ordner im Drive des Nutzers wird abgerufen.
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner im Drive des Nutzers ab, die den angegebenen Namen haben.
getRootFolder()FolderRuft den Ordner im Stammverzeichnis des Drive-Ordners des Nutzers ab.
getStorageLimit()IntegerRuft die Anzahl der Byte ab, die der Nutzer in Drive speichern darf.
getStorageUsed()IntegerDie Anzahl der Byte, die der Nutzer derzeit in Drive speichert.
getTrashedFiles()FileIteratorStellt eine Sammlung aller Dateien im Papierkorb des Nutzers in Google Drive bereit.
getTrashedFolders()FolderIteratorHiermit wird eine Sammlung aller Ordner im Papierkorb des Drive-Kontos des Nutzers abgerufen.
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Suchkriterien entsprechen.
searchFolders(params)FolderIteratorStellt eine Sammlung aller Ordner im Drive des Nutzers zurück, die den angegebenen Suchkriterien entsprechen.

Detaillierte Dokumentation

continueFileIterator(continuationToken)

Setzt eine Dateiiteration mit einem Fortsetzungstoken aus einem vorherigen Iterator fort. Diese Methode ist nützlich, wenn die Verarbeitung eines Iterationsobjekts in einer Ausführung die maximale Ausführungszeit überschreitet. Fortsetzungstokens sind in der Regel eine Woche lang gültig.

// Continues getting a list of all 'Untitled document' files in the user's
// Drive. Creates a file iterator named 'previousIterator'.
const previousIterator = DriveApp.getFilesByName('Untitled document');

// Gets continuation token from the previous file iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous file
// iterator.
const newIterator = DriveApp.continueFileIterator(continuationToken);

// Resumes the file iteration using a continuation token from 'firstIterator'
// and logs the file name.
if (newIterator.hasNext()) {
  const file = newIterator.next();
  console.log(file.getName());
}

Parameter

NameTypBeschreibung
continuationTokenStringEin Fortsetzungstoken aus einem vorherigen Dateiiterator.

Rückflug

FileIterator: Eine Sammlung von Dateien, die in einem vorherigen Iterable verblieben sind, als das Fortsetzungstoken generiert wurde.


continueFolderIterator(continuationToken)

Eine Ordneriteration wird mit einem Fortsetzungstoken aus einem vorherigen Iterator fortgesetzt. Diese Methode ist nützlich, wenn die Verarbeitung eines Iterationsobjekts in einer Ausführung die maximale Ausführungszeit überschreitet. Fortsetzungstokens sind in der Regel eine Woche lang gültig.

// Continues getting a list of all folders in user's Drive.
// Creates a folder iterator named 'previousIterator'.
const previousIterator = DriveApp.getFolders();

// Gets continuation token from the previous folder iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous folder
// iterator.
const newIterator = DriveApp.continueFolderIterator(continuationToken);

// Resumes the folder iteration using a continuation token from the previous
// iterator and logs the folder name.
if (newIterator.hasNext()) {
  const folder = newIterator.next();
  console.log(folder.getName());
}

Parameter

NameTypBeschreibung
continuationTokenStringEin Fortsetzungstoken aus einem vorherigen Ordner-Iterator.

Rückflug

FolderIterator: Eine Sammlung von Ordnern, die in einem vorherigen Iterationsschritt übrig geblieben sind, als das Fortsetzungstoken generiert wurde.


createFile(blob)

Erstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers aus einer bestimmten Blob mit beliebigen Daten.

Parameter

NameTypBeschreibung
blobBlobSourceDie Daten für die neue Datei.

Rückflug

File: Die neue Datei.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive

createFile(name, content)

Erstellt eine Textdatei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen und Inhalt. Es wird eine Ausnahme ausgelöst, wenn content größer als 50 MB ist.

// Create a text file with the content "Hello, world!"
DriveApp.createFile('New Text File', 'Hello, world!');

Parameter

NameTypBeschreibung
nameStringDer Name der neuen Datei.
contentStringDer Inhalt der neuen Datei.

Rückflug

File: Die neue Datei.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive

createFile(name, content, mimeType)

Erstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen, Inhalt und MIME-Typ. Es wird eine Ausnahme ausgelöst, wenn content größer als 10 MB ist.

// Create an HTML file with the content "Hello, world!"
DriveApp.createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

Parameter

NameTypBeschreibung
nameStringDer Name der neuen Datei.
contentStringDer Inhalt der neuen Datei.
mimeTypeStringDer MIME-Typ der neuen Datei.

Rückflug

File: Die neue Datei.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive

createFolder(name)

Erstellt einen Ordner im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen.

Parameter

NameTypBeschreibung
nameStringDer Name des neuen Ordners.

Rückflug

Folder: Der neue Ordner.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive

createShortcut(targetId)

Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück.

Parameter

NameTypBeschreibung
targetIdStringDie Datei-ID der Zieldatei oder des Zielordners.

Rückflug

File: Die neue Verknüpfung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Erstellt eine Verknüpfung mit der angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück. Ein Ressourcenschlüssel ist ein zusätzlicher Parameter, der für den Zugriff auf die Zieldatei oder den Zielordner übergeben werden muss, die bzw. der über einen Link freigegeben wurde.

// Creates shortcuts for all folders in the user's drive that have a specific
// name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your
// drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and
  // returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(
      folder.getId(),
      folder.getResourceKey(),
  );
}

Parameter

NameTypBeschreibung
targetIdStringDie ID der Zieldatei oder des Zielordners.
targetResourceKeyStringDer Ressourcenschlüssel der Zieldatei oder des Zielordners.

Rückflug

File: Die neue Verknüpfung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive

enforceSingleParent(value)

Aktiviert oder deaktiviert das Verhalten „enforceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente von Artikeln auswirken.

Weitere Informationen finden Sie im Blogpost Die Ordnerstruktur und Freigabemodelle von Google Drive vereinfachen.

// Enables enforceSingleParent behavior for all calls affecting item parents.
DriveApp.enforceSingleParent(true);

Parameter

NameTypBeschreibung
valueBooleanDer neue Status des Flags „enforceSingleParent“.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive

getFileById(id)

Ruft die Datei mit der angegebenen ID ab. Löst eine Scripting-Ausnahme aus, wenn die Datei nicht vorhanden ist oder der Nutzer keine Berechtigung zum Zugriff darauf hat.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'Test' with your file name.
const files = DriveApp.getFilesByName('Test');

if (files.hasNext()) {
  // Gets the ID of each file in the list.
  const fileId = files.next().getId();

  // Gets the file name using its ID and logs it to the console.
  console.log(DriveApp.getFileById(fileId).getName());
}

Parameter

NameTypBeschreibung
idStringDie ID der Datei.

Rückflug

File: Die Datei mit der angegebenen ID.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFileByIdAndResourceKey(id, resourceKey)

Ruft die Datei mit der angegebenen ID und dem Ressourcenschlüssel ab. Ressourcenschlüssel sind ein zusätzlicher Parameter, der übergeben werden muss, um auf Dateien zuzugreifen, die über einen Link freigegeben wurden.

Es wird eine Scripting-Ausnahme geworfen, wenn die Datei nicht vorhanden ist oder der Nutzer keine Zugriffsberechtigung hat.

// Gets a list of all files in Drive with the given name.
// TODO(developer): Replace 'Test' with your file name.
const files = DriveApp.getFilesByName('Test');
if (files.hasNext()) {
  // Gets the first file in the list.
  const file = files.next();

  // Gets the ID and resource key.
  const key = file.getResourceKey();
  const id = file.getId();

  // Logs the file name to the console using its ID and resource key.
  console.log(DriveApp.getFileByIdAndResourceKey(id, key).getName());
}

Parameter

NameTypBeschreibung
idStringDie ID der Datei.
resourceKeyStringDer Ressourcenschlüssel des Ordners.

Rückflug

File: Die Datei mit der angegebenen ID.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFiles()

Eine Sammlung aller Dateien im Drive des Nutzers wird abgerufen.

Rückflug

FileIterator: Eine Sammlung aller Dateien im Drive des Nutzers.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFilesByName(name)

Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Namen haben.

Parameter

NameTypBeschreibung
nameStringDer Name der zu suchenden Dateien.

Rückflug

FileIterator: Eine Sammlung aller Dateien im Drive des Nutzers mit dem angegebenen Namen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFilesByType(mimeType)

Stellt eine Sammlung aller Dateien im Drive des Nutzers mit dem angegebenen MIME-Typ bereit.

Parameter

NameTypBeschreibung
mimeTypeStringDer MIME-Typ der zu findenden Dateien.

Rückflug

FileIterator: Eine Sammlung aller Dateien in der Drive-Ablage des Nutzers mit dem angegebenen MIME-Typ.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFolderById(id)

Ruft den Ordner mit der angegebenen ID ab. Es wird eine Scripting-Ausnahme geworfen, wenn der Ordner nicht vorhanden ist oder der Nutzer keine Zugriffsberechtigung für ihn hat.

Parameter

NameTypBeschreibung
idStringDie ID des Ordners.

Rückflug

Folder: Der Ordner mit der angegebenen ID.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFolderByIdAndResourceKey(id, resourceKey)

Ruft den Ordner mit der angegebenen ID und dem Ressourcenschlüssel ab. Ressourcenschlüssel sind ein zusätzlicher Parameter, der für den Zugriff auf Ordner übergeben werden muss, die über einen Link freigegeben wurden.

Es wird eine Scripting-Ausnahme geworfen, wenn der Ordner nicht vorhanden ist oder der Nutzer keine Zugriffsberechtigung hat.

Parameter

NameTypBeschreibung
idStringDie ID des Ordners.
resourceKeyStringDer Ressourcenschlüssel des Ordners.

Rückflug

Folder: Der Ordner mit der angegebenen ID.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFolders()

Eine Sammlung aller Ordner im Drive des Nutzers wird abgerufen.

Rückflug

FolderIterator: Eine Sammlung aller Ordner im Drive des Nutzers.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFoldersByName(name)

Ruft eine Sammlung aller Ordner im Drive des Nutzers ab, die den angegebenen Namen haben.

Parameter

NameTypBeschreibung
nameStringDer Name der zu suchenden Ordner.

Rückflug

FolderIterator: Eine Sammlung aller Ordner im Drive des Nutzers mit dem angegebenen Namen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getRootFolder()

Ruft den Ordner im Stammverzeichnis des Drive-Ordners des Nutzers ab.

// Gets the user's My Drive folder and logs its name to the console.
console.log(DriveApp.getRootFolder().getName());

// Logs the Drive owner's name to the console.
console.log(DriveApp.getRootFolder().getOwner().getName());

Rückflug

Folder: Der Stammordner des Drive-Ordners des Nutzers.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getStorageLimit()

Ruft die Anzahl der Byte ab, die der Nutzer in Drive speichern darf.

// Gets the number of bytes the user can store in Drive and logs it to the
// console.
console.log(DriveApp.getStorageLimit());

Rückflug

Integer – Die Anzahl der Byte, die der Nutzer in Drive speichern darf.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getStorageUsed()

Die Anzahl der Byte, die der Nutzer derzeit in Drive speichert.

// Gets the number of bytes the user is currently storing in Drive and logs it
// to the console.
console.log(DriveApp.getStorageUsed());

Rückflug

Integer: Die Anzahl der Byte, die der Nutzer derzeit in Drive speichert.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getTrashedFiles()

Stellt eine Sammlung aller Dateien im Papierkorb des Nutzers in Google Drive bereit.

// Gets a list of all the files in the trash of the user's Drive.
const trashFiles = DriveApp.getTrashedFiles();

// Logs the trash file names to the console.
while (trashFiles.hasNext()) {
  const file = trashFiles.next();
  console.log(file.getName());
}

Rückflug

FileIterator – Eine Sammlung von Dateien im Papierkorb.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getTrashedFolders()

Hiermit wird eine Sammlung aller Ordner im Papierkorb des Drive-Kontos des Nutzers abgerufen.

// Gets a collection of all the folders in the trash of the user's Drive.
const trashFolders = DriveApp.getTrashedFolders();

// Logs the trash folder names to the console.
while (trashFolders.hasNext()) {
  const folder = trashFolders.next();
  console.log(folder.getName());
}

Rückflug

FolderIterator: Eine Sammlung von Ordnern im Papierkorb.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

searchFiles(params)

Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Suchkriterien entsprechen. Die Suchkriterien werden in der Google Drive SDK-Dokumentation beschrieben. Der Drive-Dienst verwendet Version 2 der Drive API. Einige Abfragefelder unterscheiden sich von Version 3. Weitere Informationen zu den Unterschieden zwischen Version 2 und Version 3

Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie daher darauf, Anführungszeichen korrekt zu escapen (z. B. "title contains 'Gulliver\\'s Travels'" oder 'title contains "Gulliver\'s Travels"').

// Logs the name of every file in the user's Drive that modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

Parameter

NameTypBeschreibung
paramsStringDie Suchkriterien, wie in der Google Drive SDK-Dokumentation beschrieben.

Rückflug

FileIterator: Eine Sammlung aller Dateien im Drive des Nutzers, die den Suchkriterien entsprechen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

searchFolders(params)

Stellt eine Sammlung aller Ordner im Drive des Nutzers zurück, die den angegebenen Suchkriterien entsprechen. Die Suchkriterien werden in der Google Drive SDK-Dokumentation beschrieben. Der Drive-Dienst verwendet Version 2 der Drive API. Einige Abfragefelder unterscheiden sich von Version 3. Weitere Informationen zu den Unterschieden zwischen Version 2 und Version 3

Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie daher darauf, Anführungszeichen korrekt zu escapen (z. B. "title contains 'Gulliver\\'s Travels'" oder 'title contains "Gulliver\'s Travels"').

// Logs the name of every folder in the user's Drive that you own and is starred.
const folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

Parameter

NameTypBeschreibung
paramsStringDie Suchkriterien, wie in der Google Drive SDK-Dokumentation beschrieben.

Rückflug

FolderIterator: Eine Sammlung aller Ordner im Drive-Konto des Nutzers, die den Suchkriterien entsprechen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

Eingestellte Methoden