Class DriveApp

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Google Drive-App

Ermöglicht Skripts das Erstellen, Suchen und Ändern von Dateien und Ordnern in Google Drive

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

Attribute

PropertyTypBeschreibung
AccessAccessEine Aufzählung, die Klassen von Nutzern darstellt, die auf eine Datei oder einen Ordner zugreifen können, neben einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
PermissionPermissionEine Aufzählung, die die Berechtigungen darstellt, die Nutzern erteilt wurden, die auf eine Datei oder einen Ordner zugreifen können, sowie für einzelne Nutzer, denen explizit Zugriff gewährt wurde.

Methoden

MethodeRückgabetypKurzbeschreibung
continueFileIterator(continuationToken)FileIteratorSetzt eine Dateiausführung mit einem Fortsetzungs-Token aus einem vorherigen Iterator fort.
continueFolderIterator(continuationToken)FolderIteratorSetzt eine Ordnerausführung mit einem Fortsetzungstoken aus einem vorherigen Iterator fort.
createFile(blob)FileErstellt eine Datei im Stammverzeichnis des Nutzers Drive aus einem bestimmten Blob mit beliebigen Daten.
createFile(name, content)FileErstellt eine Textdatei im Stammverzeichnis des Nutzers in Google Drive mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt im Stammverzeichnis des Nutzers eine Datei mit dem angegebenen Namen, Inhalt und MIME-Typ.
createFolder(name)FolderErstellt einen Ordner im Stammverzeichnis des Nutzers in Google Drive mit dem angegebenen Namen.
createShortcut(targetId)FileDamit wird eine Verknüpfung zur angegebenen Drive-Element-ID erstellt und zurückgegeben.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileEs wird eine Verknüpfung zur angegebenen Drive-Element-ID und zum angegebenen Ressourcenschlüssel erstellt und zurückgegeben.
enforceSingleParent(value)voidAktiviert oder deaktiviert das Erzwingen von „forceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente beziehen.
getFileById(id)FileRuft die Datei mit der angegebenen ID ab.
getFileByIdAndResourceKey(id, resourceKey)FileRuft die Datei mit der angegebenen ID und dem angegebenen Ressourcenschlüssel ab.
getFiles()FileIteratorRuft eine Sammlung aller Dateien im Google Drive-Konto des Nutzers ab.
getFilesByName(name)FileIteratorRuft eine Sammlung aller Dateien im Drive-Konto 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 angegebenen Ressourcenschlüssel ab.
getFolders()FolderIteratorRuft eine Sammlung aller Ordner im Google Drive-Konto des Nutzers ab.
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner im Drive-Konto des Nutzers ab, die den angegebenen Namen haben.
getRootFolder()FolderRuft den Ordner im Stammverzeichnis des Nutzers in Google Drive ab.
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 gerade in Google 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 Drive-Kontos des Nutzers ab.
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien im Drive-Konto 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 Dateiausführung mit einem Fortsetzungs-Token aus einem vorherigen Iterator fort. Diese Methode ist nützlich, wenn die Verarbeitung eines Iterators in einer Ausführung die maximale Ausführungszeit überschreiten würde. Fortsetzungs-Token sind in der Regel eine Woche lang gültig.

Parameter

NameTypBeschreibung
continuationTokenStringFortsetzungs-Token eines früheren Datei-Iterators

Zurücksenden

FileIterator: Eine Sammlung von Dateien, die in einem vorherigen Iterator geblieben sind, als das Fortsetzungstoken generiert wurde


continueFolderIterator(continuationToken)

Setzt eine Ordnerausführung mit einem Fortsetzungstoken aus einem vorherigen Iterator fort. Diese Methode ist nützlich, wenn die Verarbeitung eines Iterators in einer Ausführung die maximale Ausführungszeit überschreiten würde. Fortsetzungs-Token sind in der Regel eine Woche lang gültig.

Parameter

NameTypBeschreibung
continuationTokenStringFortsetzungs-Token eines früheren Ordner-Iterators

Zurücksenden

FolderIterator: Eine Sammlung von Ordnern, die beim Generieren des Fortsetzungstoken in einem vorherigen Iterator geblieben sind


createFile(blob)

Erstellt eine Datei im Stammverzeichnis des Nutzers Drive aus einem bestimmten Blob mit beliebigen 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.

Zurücksenden

File: Die neue Datei.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

createFile(name, content)

Erstellt eine Textdatei im Stammverzeichnis des Nutzers in Google Drive 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.

Zurücksenden

File: Die neue Datei.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

createFile(name, content, mimeType)

Erstellt im Stammverzeichnis des Nutzers eine Datei mit dem angegebenen Namen, Inhalt und 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.

Zurücksenden

File: Die neue Datei.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

createFolder(name)

Erstellt einen Ordner im Stammverzeichnis des Nutzers in Google Drive mit dem angegebenen Namen.

Parameter

NameTypBeschreibung
nameStringDer Name des neuen Ordners.

Zurücksenden

Folder: Der neue Ordner.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

createShortcut(targetId)

Damit wird eine Verknüpfung zur angegebenen Drive-Element-ID erstellt und zurückgegeben.

Parameter

NameTypBeschreibung
targetIdStringDie Datei-ID der Zieldatei oder des Zielordners.

Zurücksenden

File: Die neue Verknüpfung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Es wird eine Verknüpfung zur angegebenen Drive-Element-ID und zum angegebenen Ressourcenschlüssel erstellt und zurückgegeben. Ressourcenschlüssel sind ein zusätzlicher Parameter, der übergeben werden muss, um auf die Zieldatei oder den Ordner zuzugreifen, der über einen Link freigegeben wurde.

Parameter

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

Zurücksenden

File: Die neue Verknüpfung.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

enforceSingleParent(value)

Aktiviert oder deaktiviert das Erzwingen von „forceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente beziehen.

Weitere Informationen finden Sie im Blog „Google Drive-Ordnerstruktur und -Freigabe vereinfachen“.

Parameter

NameTypBeschreibung
valueBooleanDer neue Status des Flags „singleSingleParent“.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getFileById(id)

Ruft die Datei mit der angegebenen ID ab. Löst eine Ausnahme aus, wenn die Datei nicht vorhanden ist oder der Nutzer keine Zugriffsberechtigung dafür hat.

Parameter

NameTypBeschreibung
idStringID der Datei

Zurücksenden

File: Die Datei mit der angegebenen ID

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 angegebenen Ressourcenschlüssel ab. Ressourcenschlüssel sind ein zusätzlicher Parameter, der an Dateien weitergegeben werden muss, die über einen Link freigegeben wurden.

Löst eine Ausnahme aus, wenn die Datei nicht vorhanden ist oder der Nutzer keine Zugriffsberechtigung hat.

Parameter

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

Zurücksenden

File: Die Datei mit der angegebenen ID.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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.

Zurücksenden

FileIterator: Eine Sammlung aller Dateien im Google Drive-Konto des Nutzers.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getFilesByName(name)

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

Parameter

NameTypBeschreibung
nameStringDer Name der zu suchenden Dateien.

Zurücksenden

FileIterator: Eine Sammlung aller Dateien im Drive-Konto des Nutzers, die den angegebenen Namen haben.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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.

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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
idStringID des Ordners

Zurücksenden

Folder: Der Ordner mit der angegebenen ID.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 angegebenen Ressourcenschlüssel ab. Ressourcenschlüssel sind ein zusätzlicher Parameter, der an Ordner weitergegeben werden muss, die über einen Link freigegeben wurden.

Löst eine Ausnahme aus, wenn der Ordner nicht existiert oder der Nutzer keine Zugriffsberechtigung hat.

Parameter

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

Zurücksenden

Folder: Der Ordner mit der angegebenen ID.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getFolders()

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

Zurücksenden

FolderIterator: Eine Sammlung aller Ordner im Google Drive-Konto des Nutzers.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getFoldersByName(name)

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

Parameter

NameTypBeschreibung
nameStringDer Name der zu suchenden Ordner.

Zurücksenden

FolderIterator: Eine Sammlung aller Ordner im Drive-Konto des Nutzers, die den angegebenen Namen haben.

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getRootFolder()

Ruft den Ordner im Stammverzeichnis des Nutzers in Google Drive ab.

Zurücksenden

Folder: Der Stammordner des Drive-Kontos des Nutzers

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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.

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getStorageUsed()

Ruft die Anzahl der Byte ab, die der Nutzer gerade in Google Drive speichert.

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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.

Zurücksenden

FileIterator: Eine Sammlung von Dateien im Papierkorb

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

getTrashedFolders()

Ruft eine Sammlung aller Ordner im Papierkorb des Drive-Kontos des Nutzers ab.

Zurücksenden

FolderIterator: Eine Sammlung von Ordnern im Papierkorb

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

searchFiles(params)

Ruft eine Sammlung aller Dateien im Drive-Konto des Nutzers ab, die den angegebenen Suchkriterien entsprechen. Die Suchkriterien sind in der Google Drive SDK-Dokumentation ausführlich beschrieben. Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie daher darauf, Anführungszeichen korrekt zu maskieren (z. B. "title contains 'Gulliver\\'s Travels'" oder 'title contains "Gulliver\'s Travels"').

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

Parameter

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

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

  • 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 sind in der Google Drive SDK-Dokumentation ausführlich beschrieben. Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie daher darauf, Anführungszeichen korrekt zu maskieren (z. B. "title contains 'Gulliver\\'s Travels'" oder 'title contains "Gulliver\'s Travels"').

// Log 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();
  Logger.log(folder.getName());
}

Parameter

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

Zurücksenden

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

Autorisierung

Für Skripts, die diese Methode verwenden, ist eine Autorisierung in mindestens einem der folgenden Bereiche erforderlich:

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

Eingestellte Methoden