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
Attribut | Typ | Beschreibung |
---|---|---|
Access | Access | Ein Enum, das Nutzergruppen darstellt, die neben einzelnen Nutzern, denen explizit Zugriff gewährt wurde, auf eine Datei oder einen Ordner zugreifen können. |
Permission | Permission | Ein 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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
continue | File | Setzt eine Dateiiteration mit einem Fortsetzungstoken aus einem vorherigen Iterator fort. |
continue | Folder | Eine Ordneriteration wird mit einem Fortsetzungstoken aus einem vorherigen Iterator fortgesetzt. |
create | File | Erstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers aus einer bestimmten Blob mit beliebigen Daten. |
create | File | Erstellt eine Textdatei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen und Inhalt. |
create | File | Erstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen, Inhalt und MIME-Typ. |
create | Folder | Erstellt einen Ordner im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen. |
create | File | Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück. |
create | File | Erstellt eine Verknüpfung mit der angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück. |
enforce | void | Aktiviert oder deaktiviert das Verhalten „enforceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente von Artikeln auswirken. |
get | File | Ruft die Datei mit der angegebenen ID ab. |
get | File | Ruft die Datei mit der angegebenen ID und dem Ressourcenschlüssel ab. |
get | File | Eine Sammlung aller Dateien im Drive des Nutzers wird abgerufen. |
get | File | Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Namen haben. |
get | File | Stellt eine Sammlung aller Dateien im Drive des Nutzers mit dem angegebenen MIME-Typ bereit. |
get | Folder | Ruft den Ordner mit der angegebenen ID ab. |
get | Folder | Ruft den Ordner mit der angegebenen ID und dem Ressourcenschlüssel ab. |
get | Folder | Eine Sammlung aller Ordner im Drive des Nutzers wird abgerufen. |
get | Folder | Ruft eine Sammlung aller Ordner im Drive des Nutzers ab, die den angegebenen Namen haben. |
get | Folder | Ruft den Ordner im Stammverzeichnis des Drive-Ordners des Nutzers ab. |
get | Integer | Ruft die Anzahl der Byte ab, die der Nutzer in Drive speichern darf. |
get | Integer | Die Anzahl der Byte, die der Nutzer derzeit in Drive speichert. |
get | File | Stellt eine Sammlung aller Dateien im Papierkorb des Nutzers in Google Drive bereit. |
get | Folder | Hiermit wird eine Sammlung aller Ordner im Papierkorb des Drive-Kontos des Nutzers abgerufen. |
search | File | Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Suchkriterien entsprechen. |
search | Folder | Stellt eine Sammlung aller Ordner im Drive des Nutzers zurück, die den angegebenen Suchkriterien entsprechen. |
Detaillierte Dokumentation
continue File Iterator(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
Name | Typ | Beschreibung |
---|---|---|
continuation | String | Ein Fortsetzungstoken aus einem vorherigen Dateiiterator. |
Rückflug
File
: Eine Sammlung von Dateien, die in einem vorherigen Iterable verblieben sind, als das Fortsetzungstoken generiert wurde.
continue Folder Iterator(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
Name | Typ | Beschreibung |
---|---|---|
continuation | String | Ein Fortsetzungstoken aus einem vorherigen Ordner-Iterator. |
Rückflug
Folder
: Eine Sammlung von Ordnern, die in einem vorherigen Iterationsschritt übrig geblieben sind, als das Fortsetzungstoken generiert wurde.
create File(blob)
Erstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers aus einer bestimmten Blob
mit beliebigen Daten.
Parameter
Name | Typ | Beschreibung |
---|---|---|
blob | Blob | Die 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
create File(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
Name | Typ | Beschreibung |
---|---|---|
name | String | Der Name der neuen Datei. |
content | String | Der 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
create File(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
Name | Typ | Beschreibung |
---|---|---|
name | String | Der Name der neuen Datei. |
content | String | Der Inhalt der neuen Datei. |
mime | String | Der 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
create Folder(name)
Erstellt einen Ordner im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Der 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
create Shortcut(targetId)
Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück.
Parameter
Name | Typ | Beschreibung |
---|---|---|
target | String | Die 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
create Shortcut For Target Id And Resource Key(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
Name | Typ | Beschreibung |
---|---|---|
target | String | Die ID der Zieldatei oder des Zielordners. |
target | String | Der 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
enforce Single Parent(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
Name | Typ | Beschreibung |
---|---|---|
value | Boolean | Der 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
get File By Id(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
Name | Typ | Beschreibung |
---|---|---|
id | String | Die 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
get File By Id And Resource Key(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
Name | Typ | Beschreibung |
---|---|---|
id | String | Die ID der Datei. |
resource | String | Der 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
get Files()
Eine Sammlung aller Dateien im Drive des Nutzers wird abgerufen.
Rückflug
File
: 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
get Files By Name(name)
Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Namen haben.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Der Name der zu suchenden Dateien. |
Rückflug
File
: 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
get Files By Type(mimeType)
Stellt eine Sammlung aller Dateien im Drive des Nutzers mit dem angegebenen MIME-Typ bereit.
Parameter
Name | Typ | Beschreibung |
---|---|---|
mime | String | Der MIME-Typ der zu findenden Dateien. |
Rückflug
File
: 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
get Folder By Id(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
Name | Typ | Beschreibung |
---|---|---|
id | String | Die 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
get Folder By Id And Resource Key(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
Name | Typ | Beschreibung |
---|---|---|
id | String | Die ID des Ordners. |
resource | String | Der 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
get Folders()
Eine Sammlung aller Ordner im Drive des Nutzers wird abgerufen.
Rückflug
Folder
: 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
get Folders By Name(name)
Ruft eine Sammlung aller Ordner im Drive des Nutzers ab, die den angegebenen Namen haben.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Der Name der zu suchenden Ordner. |
Rückflug
Folder
: 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
get Root Folder()
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
get Storage Limit()
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
get Storage Used()
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
get Trashed Files()
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
File
– 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
get Trashed Folders()
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
Folder
: 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
search Files(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
Name | Typ | Beschreibung |
---|---|---|
params | String | Die Suchkriterien, wie in der Google Drive SDK-Dokumentation beschrieben. |
Rückflug
File
: 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
search Folders(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
Name | Typ | Beschreibung |
---|---|---|
params | String | Die Suchkriterien, wie in der Google Drive SDK-Dokumentation beschrieben. |
Rückflug
Folder
: 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