Ermöglicht es Scripts, Dateien und Ordner in Google Drive zu erstellen, zu suchen und zu ändern. Der integrierte Drive-Dienst ist zwar einfacher zu verwenden, hat aber einige Einschränkungen. Wenn Sie die neuesten Funktionen und den neuesten Support nutzen und 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()); }
Properties
| Attribut | Typ | Beschreibung |
|---|---|---|
Access | Access | Ein Enum, das Klassen von Nutzern darstellt, die neben allen einzelnen Nutzern, denen explizit Zugriff gewährt wurde, auf eine Datei oder einen Ordner zugreifen können. |
Permission | Permission | Ein Enum, das die Berechtigungen darstellt, die Nutzern gewährt werden, die auf eine Datei oder einen Ordner zugreifen können, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde. |
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
continue | File | Setzt eine Dateiiteration mit einem Fortsetzungstoken aus einem vorherigen Iterator fort. |
continue | Folder | Setzt eine Ordneriteration mit einem Fortsetzungstoken aus einem vorherigen Iterator fort. |
create | File | Erstellt eine Datei im Stammverzeichnis des Drive-Kontos des Nutzers aus einem bestimmten Blob mit beliebigen Daten. |
create | File | Erstellt eine Textdatei im Stammverzeichnis der Ablage des Nutzers mit dem angegebenen Namen und Inhalt. |
create | File | Erstellt eine Datei im Stammverzeichnis des Drive-Kontos des Nutzers mit dem angegebenen Namen, Inhalt und MIME-Typ. |
create | Folder | Erstellt einen Ordner im Stammverzeichnis des Drive 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 zur angegebenen Drive-Element-ID und zum angegebenen 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 Elementen auswirken. |
get | File | Ruft die Datei mit der angegebenen ID ab. |
get | File | Ruft die Datei mit der angegebenen ID und dem angegebenen Ressourcenschlüssel ab. |
get | File | Ruft eine Sammlung aller Dateien im Drive des Nutzers ab. |
get | File | Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Namen haben. |
get | File | Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen MIME-Typ haben. |
get | Folder | Ruft den Ordner mit der angegebenen ID ab. |
get | Folder | Ruft den Ordner mit der angegebenen ID und dem angegebenen Ressourcenschlüssel ab. |
get | Folder | Ruft eine Sammlung aller Ordner im Drive des Nutzers ab. |
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 des Nutzers ab. |
get | Integer | Gibt die Anzahl der Byte zurück, die der Nutzer in Drive speichern darf. |
get | Integer | Gibt die Anzahl der Byte zurück, die der Nutzer derzeit in Drive speichert. |
get | File | Ruft eine Sammlung aller Dateien im Papierkorb des Drive-Kontos des Nutzers ab. |
get | Folder | Ruft eine Sammlung aller Ordner im Papierkorb des Drive-Kontos des Nutzers ab. |
search | File | Ruft eine Sammlung aller Dateien in der Ablage des Nutzers ab, die den angegebenen Suchkriterien entsprechen. |
search | Folder | Ruft eine Sammlung aller Ordner im Drive des Nutzers ab, 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 Iterators 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 Datei-Iterator. |
Rückflug
FileIterator: Eine Sammlung von Dateien, die in einem vorherigen Iterator verblieben sind, als das Fortsetzungstoken generiert wurde.
continueFolderIterator(continuationToken)
Setzt eine Ordneriteration 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 ü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
FolderIterator: Eine Sammlung von Ordnern, die in einem vorherigen Iterator verblieben sind, als das Fortsetzungstoken generiert wurde.
createFile(blob)
Erstellt eine Datei im Stammverzeichnis des Drive-Kontos des Nutzers aus einem 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive
createFile(name, content)
Erstellt eine Textdatei im Stammverzeichnis der Ablage des Nutzers 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
| 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive
createFile(name, content, mimeType)
Erstellt eine Datei im Stammverzeichnis des Drive-Kontos des Nutzers 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
| 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive
createFolder(name)
Erstellt einen Ordner im Stammverzeichnis des Drive 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive
createShortcut(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 Tastenkombination.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)
Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und zum angegebenen 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, die über einen Link freigegeben wurden.
// 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 Tastenkombination.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive
enforceSingleParent(value)
Aktiviert oder deaktiviert das Verhalten „enforceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente von Elementen auswirken.
Weitere Informationen finden Sie im Blogbeitrag Vereinfachung der Ordnerstruktur und der Freigabemodelle von Google Drive.
// 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive
getFileById(id)
Ruft die Datei mit der angegebenen ID ab. Löst eine Skripting-Ausnahme aus, wenn die Datei nicht vorhanden ist oder der Nutzer nicht berechtigt ist, darauf zuzugreifen.
// 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
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 übergeben werden muss, um auf Dateien zuzugreifen, die über einen Link freigegeben wurden.
Löst eine Scripting-Ausnahme aus, wenn die Datei nicht vorhanden ist oder der Nutzer keine Berechtigung für den Zugriff darauf 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
getFiles()
Ruft eine Sammlung aller Dateien im Drive des Nutzers ab.
Rückflug
FileIterator: Eine Sammlung aller Dateien im Drive des Nutzers.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
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
| Name | Typ | Beschreibung |
|---|---|---|
name | String | Der Name der zu suchenden Dateien. |
Rückflug
FileIterator: Eine Sammlung aller Dateien in der Drive-Ablage des Nutzers, die den angegebenen Namen haben.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
getFilesByType(mimeType)
Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen MIME-Typ haben.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
mime | String | Der MIME-Typ der zu suchenden 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
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 Scripting-Ausnahme aus, wenn der Ordner nicht vorhanden ist oder der Nutzer keine Berechtigung für den Zugriff darauf 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
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 übergeben werden muss, um auf Ordner zuzugreifen, die über einen Link freigegeben wurden.
Löst eine Scripting-Ausnahme aus, wenn der Ordner nicht vorhanden ist oder der Nutzer keine Berechtigung für den Zugriff darauf 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
getFolders()
Ruft eine Sammlung aller Ordner im Drive des Nutzers ab.
Rückflug
FolderIterator: Eine Sammlung aller Ordner im Drive des Nutzers.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
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
| Name | Typ | Beschreibung |
|---|---|---|
name | String | Die Namen der zu suchenden Ordner. |
Rückflug
FolderIterator: Eine Sammlung aller Ordner in der Google Drive des Nutzers, die den angegebenen Namen haben.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
getRootFolder()
Ruft den Ordner im Stammverzeichnis des Drive 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: Das Stammverzeichnis des Google Drive-Kontos des Nutzers.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
getStorageLimit()
Gibt die Anzahl der Byte zurück, 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
getStorageUsed()
Gibt die Anzahl der Byte zurück, 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
getTrashedFiles()
Ruft eine Sammlung aller Dateien im Papierkorb des Drive-Kontos des Nutzers 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()); }
Rückflug
FileIterator: Eine Sammlung von Dateien im Papierkorb.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
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.
// 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, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
searchFiles(params)
Ruft eine Sammlung aller Dateien in der Ablage des Nutzers ab, die den angegebenen Suchkriterien entsprechen. Die Suchkriterien sind in der Google Drive SDK-Dokumentation beschrieben. Der Drive-Dienst verwendet Version 2 der Drive API. Einige Abfragefelder unterscheiden sich von Version 3. Unterschiede zwischen v2 und v3 bei Feldern
Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie daher darauf, Anführungszeichen richtig 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."" 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
FileIterator: Eine Sammlung aller Dateien in der Drive des Nutzers, die den Suchkriterien entsprechen.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
searchFolders(params)
Ruft eine Sammlung aller Ordner im Drive des Nutzers ab, die den angegebenen Suchkriterien entsprechen. Die Suchkriterien sind in der Google Drive SDK-Dokumentation beschrieben. Der Drive-Dienst verwendet Version 2 der Drive API. Einige Abfragefelder unterscheiden sich von Version 3. Unterschiede zwischen v2 und v3 bei Feldern
Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie daher darauf, Anführungszeichen richtig 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. 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
FolderIterator: Eine Sammlung aller Ordner im Drive des Nutzers, die den Suchkriterien entsprechen.
Autorisierung
Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive