Class DriveApp

DriveApp

Damit können Skripts Dateien und Ordner in Google Drive erstellen, suchen und ändern. Für den Zugriff auf Dateien oder Ordner in geteilten Ablagen verwenden Sie den erweiterten Dienst für Google Drive.

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

Attribute

PropertyTypBeschreibung
AccessAccessEin Enum, das Klassen von Nutzern darstellt, die auf eine Datei oder einen Ordner zugreifen können, mit Ausnahme einzelner Nutzer, denen explizit Zugriff gewährt wurde.
PermissionPermissionEin Enum-Wert, der die Berechtigungen darstellt, die den Nutzern gewährt werden, die auf eine Datei oder einen Ordner zugreifen können, mit Ausnahme der einzelnen Nutzer, denen explizit Zugriff gewährt wurde.

Methoden

MethodeRückgabetypKurzbeschreibung
continueFileIterator(continuationToken)FileIteratorSetzt eine Dateiiteration mit einem Fortsetzungstoken von einem vorherigen Iteration fort.
continueFolderIterator(continuationToken)FolderIteratorSetzt eine Ordneriteration mit einem Fortsetzungstoken von einem vorherigen Iteration fort.
createFile(blob)FileErstellt eine Datei im Stammverzeichnis der Ablage des Nutzers aus einem gegebenen Blob beliebiger Daten.
createFile(name, content)FileErstellt im Stammverzeichnis der Ablage des Nutzers eine Textdatei mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt im Stammverzeichnis der Ablage des Nutzers eine Datei mit dem angegebenen Namen, den angegebenen Inhalten und dem angegebenen MIME-Typ.
createFolder(name)FolderErstellt im Stammverzeichnis der Ablage des Nutzers einen Ordner 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 zur angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück.
enforceSingleParent(value)voidAktiviert oder deaktiviert die Funktion „ForceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente 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()FileIteratorRuft eine Sammlung aller Dateien im Google Drive-Konto des Nutzers ab.
getFilesByName(name)FileIteratorRuft eine Sammlung aller Dateien im Google Drive des Nutzers ab, die den angegebenen Namen haben.
getFilesByType(mimeType)FileIteratorRuft eine Sammlung aller Dateien im Drive-Konto des Nutzers ab, die den angegebenen MIME-Typ haben.
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()FolderIteratorRuft eine Sammlung aller Ordner in der Ablage des Nutzers ab.
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner im Google Drive des Nutzers ab, die den angegebenen Namen haben.
getRootFolder()FolderOrdner im Stammverzeichnis der Ablage des Nutzers abrufen
getStorageLimit()IntegerRuft die Anzahl der Byte ab, die der Nutzer in Google Drive speichern darf.
getStorageUsed()IntegerRuft die Anzahl der Byte ab, die der Nutzer derzeit in Drive speichert.
getTrashedFiles()FileIteratorRuft eine Sammlung aller Dateien im Papierkorb des Nutzers in Google Drive ab.
getTrashedFolders()FolderIteratorRuft eine Sammlung aller Ordner im Papierkorb des Nutzers in Google Drive ab.
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien im Drive-Ordner des Nutzers ab, die den angegebenen Suchkriterien entsprechen.
searchFolders(params)FolderIteratorRuft eine Sammlung aller Ordner im Drive-Konto des Nutzers ab, die den angegebenen Suchkriterien entsprechen.

Detaillierte Dokumentation

continueFileIterator(continuationToken)

Setzt eine Dateiiteration mit einem Fortsetzungstoken von einem vorherigen Iteration fort. Diese Methode ist nützlich, wenn die Verarbeitung eines Iterators in einer Ausführung die maximale Ausführungszeit überschreitet. Fortsetzungs-Tokens sind normalerweise 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 von einem vorherigen Datei-iterator.

Return

FileIterator – Eine Sammlung von Dateien, die beim Generieren des Fortsetzungstokens in einem vorherigen Iterator verblieben sind.


continueFolderIterator(continuationToken)

Setzt eine Ordneriteration mit einem Fortsetzungstoken von einem vorherigen Iteration fort. Diese Methode ist nützlich, wenn die Verarbeitung eines Iterators in einer Ausführung die maximale Ausführungszeit überschreitet. Fortsetzungs-Tokens sind normalerweise 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 von einem vorherigen Ordner-Iterator.

Return

FolderIterator: Eine Sammlung von Ordnern, die zum Zeitpunkt der Generierung des Fortsetzungstokens in einem vorherigen Iterator verblieben sind.


createFile(blob)

Erstellt eine Datei im Stammverzeichnis der Ablage des Nutzers aus einem gegebenen Blob beliebiger Daten.

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.createFile(blob);

Parameter

NameTypBeschreibung
blobBlobSourceDie Daten für die neue Datei.

Return

File: Die neue Datei.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createFile(name, content)

Erstellt im Stammverzeichnis der Ablage des Nutzers eine Textdatei mit dem angegebenen Namen und Inhalt. Löst eine Ausnahme aus, 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.

Return

File: Die neue Datei.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createFile(name, content, mimeType)

Erstellt im Stammverzeichnis der Ablage des Nutzers eine Datei mit dem angegebenen Namen, den angegebenen Inhalten und dem angegebenen MIME-Typ. Löst eine Ausnahme aus, 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.

Return

File: Die neue Datei.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createFolder(name)

Erstellt im Stammverzeichnis der Ablage des Nutzers einen Ordner mit dem angegebenen Namen.

Parameter

NameTypBeschreibung
nameStringDer Name des neuen Ordners.

Return

Folder: Der neue Ordner.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.

Return

File: Das neue Tastenkürzel.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück. Ein Ressourcenschlüssel ist ein zusätzlicher Parameter, der übergeben werden muss, um auf die Zieldatei oder den Zielordner zuzugreifen, 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.

Return

File: Das neue Tastenkürzel.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

enforceSingleParent(value)

Aktiviert oder deaktiviert die Funktion „ForceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente auswirken.

Weitere Informationen finden Sie im Blog Vereinfachung der Ordnerstruktur und Freigabemodelle von Google Drive.

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

Parameter

NameTypBeschreibung
valueBooleanDer neue Status des Flags „forceSingleParent“.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFileById(id)

Ruft die Datei mit der angegebenen ID ab. Löst eine Skriptausnahme aus, wenn die Datei nicht vorhanden ist oder der Nutzer keine Zugriffsberechtigung dafür 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.

Return

File: Die Datei mit der angegebenen ID.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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.

Löst eine Skriptausnahme aus, 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.

Return

File: Die Datei mit der angegebenen ID.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFiles()

Ruft eine Sammlung aller Dateien im Google Drive-Konto des Nutzers ab.

Return

FileIterator: Eine Sammlung aller Dateien in der Ablage des Nutzers.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFilesByName(name)

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

Parameter

NameTypBeschreibung
nameStringDer Name der zu suchenden Dateien.

Return

FileIterator: Eine Sammlung aller Dateien im Google Drive des Nutzers, die diesen Namen haben.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFilesByType(mimeType)

Ruft eine Sammlung aller Dateien im Drive-Konto des Nutzers ab, die den angegebenen MIME-Typ haben.

Parameter

NameTypBeschreibung
mimeTypeStringDer MIME-Typ der zu suchenden Dateien.

Return

FileIterator: Eine Sammlung aller Dateien im Google Drive des Nutzers, die den angegebenen MIME-Typ haben.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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. Löst eine Skriptausnahme aus, wenn der Ordner nicht vorhanden ist oder der Nutzer keine Zugriffsberechtigung dafür hat.

Parameter

NameTypBeschreibung
idStringDie ID des Ordners.

Return

Folder: Der Ordner mit der angegebenen ID.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 übergeben werden muss, um auf Ordner zuzugreifen, die über einen Link freigegeben wurden.

Löst eine Skriptausnahme aus, wenn der Ordner nicht vorhanden ist oder der Nutzer keine Zugriffsberechtigung dafür hat.

Parameter

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

Return

Folder: Der Ordner mit der angegebenen ID.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFolders()

Ruft eine Sammlung aller Ordner in der Ablage des Nutzers ab.

Return

FolderIterator: Eine Sammlung aller Ordner in der Ablage des Nutzers.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFoldersByName(name)

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

Parameter

NameTypBeschreibung
nameStringDer Name der zu suchenden Ordner.

Return

FolderIterator: Eine Sammlung aller Ordner in der Ablage des Nutzers, die diesen Namen haben.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getRootFolder()

Ordner im Stammverzeichnis der Ablage des Nutzers abrufen

// 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());

Return

Folder: Der Stammordner im Drive-Konto des Nutzers.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 Google Drive speichern darf.

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

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getStorageUsed()

Ruft die Anzahl der Byte ab, 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());

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getTrashedFiles()

Ruft eine Sammlung aller Dateien im Papierkorb des Nutzers in Google Drive ab.

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

Return

FileIterator: Eine Sammlung von Dateien im Papierkorb.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getTrashedFolders()

Ruft eine Sammlung aller Ordner im Papierkorb des Nutzers in Google Drive ab.

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

Return

FolderIterator: Eine Sammlung von Ordnern im Papierkorb.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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-Ordner des Nutzers ab, die den angegebenen Suchkriterien entsprechen. Die Suchkriterien werden in der Google Drive SDK-Dokumentation ausführlich beschrieben. Hinweis: Der Drive-Dienst verwendet Version 2 der Drive API und einige Abfragefelder unterscheiden sich von Version 3. Sehen Sie sich die Unterschiede zwischen den Feldern in Version 2 und Version 3 an.

Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie deshalb darauf, Anführungszeichen korrekt zu maskieren (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.""
var files = DriveApp.searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

Parameter

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

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

searchFolders(params)

Ruft eine Sammlung aller Ordner im Drive-Konto des Nutzers ab, die den angegebenen Suchkriterien entsprechen. Die Suchkriterien werden in der Google Drive SDK-Dokumentation ausführlich beschrieben. Hinweis: Der Drive-Dienst verwendet Version 2 der Drive API und einige Abfragefelder unterscheiden sich von Version 3. Sehen Sie sich die Unterschiede zwischen den Feldern in Version 2 und Version 3 an.

Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie deshalb darauf, Anführungszeichen korrekt zu maskieren (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.
var folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  console.log(folder.getName());
}

Parameter

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

Return

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Verworfene Methoden