Mit diesem Dienst können Skripts Dateien und Ordner in Google Drive erstellen, suchen und ändern.
Wenn Ihr Skript ein Cloud-Standardprojekt anstelle eines Cloud-Standardprojekts verwendet, müssen Sie die Drive API manuell aktivieren. Aktivieren Sie die Drive API in Ihrem Cloud-Standardprojekt:
Im folgenden Codebeispiel sehen Sie, wie die Namen der einzelnen Dateien im Ordner „My Drive“ (Meine Ablage) des Nutzers protokolliert werden:// 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());
}
Kurse
Name | Kurzbeschreibung |
---|---|
Access | Eine Aufzählung, die Klassen von Nutzern darstellt, die auf eine Datei oder einen Ordner zugreifen können. Ausgenommen sind einzelne Nutzer, denen ausdrücklich Zugriff gewährt wurde. |
DriveApp | Ermöglicht es Skripts, Dateien und Ordner in Google Drive zu erstellen, zu suchen und zu ändern. |
File | Eine Datei in Google Drive |
FileIterator | Ein Iterator, mit dem Skripts eine potenziell große Dateisammlung iterieren können. |
Folder | Ein Ordner in Google Drive |
FolderIterator | Ein Objekt, mit dem Skripts eine potenziell große Sammlung von Ordnern iterieren können. |
Permission | Eine Aufzählung, die die Berechtigungen darstellt, die Nutzern gewährt werden, die auf eine Datei oder einen Ordner zugreifen können, mit Ausnahme einzelner Nutzer, denen explizit Zugriff gewährt wurde. |
User | Ein Nutzer, der einer Datei in Google Drive zugeordnet ist. |
Access
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
ANYONE | Enum | Jeder im Internet kann das Element finden und darauf zugreifen. |
ANYONE_WITH_LINK | Enum | Jeder, der über den Link verfügt, hat Zugriff. |
DOMAIN | Enum | Personen in Ihrer Domain können die Datei finden und darauf zugreifen. |
DOMAIN_WITH_LINK | Enum | Personen in Ihrer Domain, die über den Link verfügen, haben Zugriff. |
PRIVATE | Enum | Nur Personen, denen die entsprechende Berechtigung ausdrücklich erteilt wurde, sind zum Zugriff befugt. |
DriveApp
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
Access | Access | Eine Aufzählung, die Klassen von Nutzern darstellt, die auf eine Datei oder einen Ordner zugreifen können. Ausgenommen sind einzelne Nutzer, denen ausdrücklich Zugriff gewährt wurde. |
Permission | Permission | Eine Aufzählung, die die Berechtigungen darstellt, die Nutzern gewährt werden, die auf eine Datei oder einen Ordner zugreifen können, mit Ausnahme einzelner Nutzer, denen explizit Zugriff gewährt wurde. |
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | Setzt eine Datei Iteration mithilfe eines Fortsetzungstokens aus einem vorherigen Iterator fort. |
continueFolderIterator(continuationToken) | FolderIterator | Setzt eine Ordneriteration mit einem Fortsetzungstoken aus einem vorherigen Iterator fort. |
createFile(blob) | File | Erstellt eine Datei im Stammverzeichnis des Drive-Nutzers aus einer gegebenen Blob mit beliebigen Daten. |
createFile(name, content) | File | Erstellt eine Textdatei im Stammverzeichnis der Ablage des Nutzers mit dem angegebenen Namen und Inhalt. |
createFile(name, content, mimeType) | File | Erstellt eine Datei im Stammverzeichnis der Ablage des Nutzers mit dem angegebenen Namen, Inhalt und MIME-Typ. |
createFolder(name) | Folder | Erstellt einen Ordner im Stammverzeichnis der Drive-Ablage des Nutzers mit dem angegebenen Namen. |
createShortcut(targetId) | File | Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und zum Ressourcenschlüssel und gibt sie zurück |
enforceSingleParent(value) | void | Aktiviert oder deaktiviert das Verhalten von „SingleSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente auswirken. |
getFileById(id) | File | Ruft die Datei mit der angegebenen ID ab |
getFileByIdAndResourceKey(id, resourceKey) | File | Ruft die Datei mit der angegebenen ID und dem angegebenen Ressourcenschlüssel ab. |
getFiles() | FileIterator | Ruft eine Sammlung aller Dateien in der Ablage des Nutzers ab |
getFilesByName(name) | FileIterator | Ruft eine Sammlung aller Dateien in der Ablage des Nutzers ab, die den angegebenen Namen haben |
getFilesByType(mimeType) | FileIterator | Ruft eine Sammlung aller Dateien in der Ablage des Nutzers ab, die den angegebenen MIME-Typ haben |
getFolderById(id) | Folder | Ruft den Ordner mit der angegebenen ID ab |
getFolderByIdAndResourceKey(id, resourceKey) | Folder | Ruft den Ordner mit der angegebenen ID und dem Ressourcenschlüssel ab |
getFolders() | FolderIterator | Ruft eine Sammlung aller Ordner in der Ablage des Nutzers ab |
getFoldersByName(name) | FolderIterator | Ruft eine Sammlung aller Ordner in der Ablage des Nutzers ab, die den angegebenen Namen haben |
getRootFolder() | Folder | Ruft den Ordner im Stammverzeichnis des Drive-Ordners des Nutzers ab. |
getStorageLimit() | Integer | Ruft die Anzahl der Byte ab, die der Nutzer in Drive speichern darf. |
getStorageUsed() | Integer | Ruft die Anzahl der Byte ab, die der Nutzer derzeit in Drive speichert. |
getTrashedFiles() | FileIterator | Ruft eine Sammlung aller Dateien im Papierkorb der Ablage des Nutzers ab |
getTrashedFolders() | FolderIterator | Ruft eine Sammlung aller Ordner im Papierkorb des Drive-Nutzers ab |
searchFiles(params) | FileIterator | Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Suchkriterien entsprechen. |
searchFolders(params) | FolderIterator | Ruft eine Sammlung aller Ordner in der Ablage des Nutzers ab, die den angegebenen Suchkriterien entsprechen |
File
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addCommenter(emailAddress) | File | Fügen Sie den angegebenen Nutzer zur Liste der Kommentatoren für File hinzu. |
addCommenter(user) | File | Fügen Sie den angegebenen Nutzer zur Liste der Kommentatoren für File hinzu. |
addCommenters(emailAddresses) | File | Füge das angegebene Array der Nutzer der Liste der Kommentatoren für File hinzu. |
addEditor(emailAddress) | File | Der entsprechende Nutzer wird der Liste der Mitbearbeiter für File hinzugefügt. |
addEditor(user) | File | Der entsprechende Nutzer wird der Liste der Mitbearbeiter für File hinzugefügt. |
addEditors(emailAddresses) | File | Fügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für File hinzu. |
addViewer(emailAddress) | File | Der entsprechende Nutzer wird der Liste der Betrachter für File hinzugefügt. |
addViewer(user) | File | Der entsprechende Nutzer wird der Liste der Betrachter für File hinzugefügt. |
addViewers(emailAddresses) | File | Fügt das angegebene Array von Nutzern der Liste der Betrachter für File hinzu. |
getAccess(email) | Permission | Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde. |
getAccess(user) | Permission | Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde. |
getAs(contentType) | Blob | Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. |
getBlob() | Blob | Gibt die Daten in diesem Objekt als Blob zurück. |
getDateCreated() | Date | Ruft das Erstellungsdatum der File ab. |
getDescription() | String | Ruft die Beschreibung für File ab |
getDownloadUrl() | String | Ruft die URL ab, die zum Herunterladen der Datei verwendet werden kann. |
getEditors() | User[] | Ruft die Liste der Editoren für dieses File ab. |
getId() | String | Ruft die ID von File ab |
getLastUpdated() | Date | Ruft das Datum ab, an dem File zuletzt aktualisiert wurde. |
getMimeType() | String | Ruft den MIME-Typ der Datei ab |
getName() | String | Ruft den Namen von File ab |
getOwner() | User | Ruft den Dateieigentümer ab |
getParents() | FolderIterator | Ruft eine Sammlung von Ordnern ab, die unmittelbare übergeordnete Elemente von File sind. |
getResourceKey() | String | Ruft den Ressourcenschlüssel von File ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden |
getSecurityUpdateEligible() | Boolean | Ruft ab, ob dieses File das Sicherheitsupdate anwenden kann, für das ein Ressourcenschlüssel erforderlich ist, wenn er über einen Link freigegeben wird. |
getSecurityUpdateEnabled() | Boolean | Ruft ab, ob dieser File einen Ressourcenschlüssel für den Zugriff benötigt, wenn er über einen Link freigegeben wird. |
getSharingAccess() | Access | Ruft ab, welche Klasse von Nutzern auf File zugreifen kann, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde. |
getSharingPermission() | Permission | Ruft die Berechtigung ab, die diesen Nutzern gewährt wird, die auf File zugreifen können – mit Ausnahme der einzelnen Nutzer, denen explizit Zugriff gewährt wurde. |
getSize() | Integer | Ruft die Anzahl der Bytes ab, die zum Speichern der File in Drive verwendet werden |
getTargetId() | String | Wenn es ein Shortcut ist, wird die ID des Elements zurückgegeben, auf das es verweist. |
getTargetMimeType() | String | Wenn es ein Shortcut ist, wird der MIME-Typ des Elements zurückgegeben, auf das es verweist. |
getTargetResourceKey() | String | Wenn die Datei eine Verknüpfung ist, wird der Ressourcenschlüssel des Elements zurückgegeben, auf das sie verweist. |
getThumbnail() | Blob | Ruft ein Thumbnail für die Datei ab oder null , wenn kein Thumbnail vorhanden ist |
getUrl() | String | Ruft die URL ab, mit der die File in einer Google-App wie Google Drive oder Google Docs geöffnet werden kann. |
getViewers() | User[] | Ruft die Liste der Betrachter und Kommentatoren für dieses File ab. |
isShareableByEditors() | Boolean | Bestimmt, ob Nutzer mit Bearbeitungsberechtigungen für File diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
isStarred() | Boolean | Bestimmt, ob das File in der Ablage des Nutzers markiert wurde. |
isTrashed() | Boolean | Bestimmt, ob sich die File im Papierkorb der Ablage des Nutzers befindet. |
makeCopy() | File | Erstellt eine Kopie der Datei. |
makeCopy(destination) | File | Erstellt eine Kopie der Datei im Zielverzeichnis. |
makeCopy(name) | File | Erstellt eine Kopie der Datei und gibt ihr einen Namen mit dem angegebenen Namen. |
makeCopy(name, destination) | File | Erstellt eine Kopie der Datei im Zielverzeichnis und benannt sie mit dem angegebenen Namen. |
moveTo(destination) | File | Verschiebt dieses Element in den angegebenen Zielordner. |
removeCommenter(emailAddress) | File | Entfernt den angegebenen Nutzer aus der Liste der Kommentatoren für File . |
removeCommenter(user) | File | Entfernt den angegebenen Nutzer aus der Liste der Kommentatoren für File . |
removeEditor(emailAddress) | File | Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für File . |
removeEditor(user) | File | Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für File . |
removeViewer(emailAddress) | File | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von File . |
removeViewer(user) | File | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von File . |
revokePermissions(emailAddress) | File | Hiermit wird der Zugriff auf die File widerrufen, die dem angegebenen Nutzer gewährt wurde. |
revokePermissions(user) | File | Hiermit wird der Zugriff auf die File widerrufen, die dem angegebenen Nutzer gewährt wurde. |
setContent(content) | File | Überschreibt den Inhalt der Datei mit einem bestimmten Ersatz. |
setDescription(description) | File | Legt die Beschreibung für File fest. |
setName(name) | File | Legt den Namen von File fest. |
setOwner(emailAddress) | File | Ändert den Inhaber von File . |
setOwner(user) | File | Ändert den Inhaber von File . |
setSecurityUpdateEnabled(enabled) | File | Legt fest, ob für den File ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird. |
setShareableByEditors(shareable) | File | Legt fest, ob Nutzer mit Bearbeitungsberechtigungen für File diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
setSharing(accessType, permissionType) | File | Legt fest, welche Nutzerklasse auf File zugreifen und welche Berechtigungen diese Nutzer neben den einzelnen Nutzern, denen explizit Zugriff gewährt wurde, gewähren. |
setStarred(starred) | File | Legt fest, ob das File in der Ablage des Nutzers markiert ist. |
setTrashed(trashed) | File | Legt fest, ob sich die File im Papierkorb der Ablage des Nutzers befindet. |
FileIterator
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getContinuationToken() | String | Ruft ein Token ab, mit dem diese Iteration später fortgesetzt werden kann |
hasNext() | Boolean | Legt fest, ob beim Aufruf von next() ein Element zurückgegeben wird. |
next() | File | Ruft das nächste Element in der Sammlung von Dateien oder Ordnern ab |
Folder
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addEditor(emailAddress) | Folder | Der entsprechende Nutzer wird der Liste der Mitbearbeiter für Folder hinzugefügt. |
addEditor(user) | Folder | Der entsprechende Nutzer wird der Liste der Mitbearbeiter für Folder hinzugefügt. |
addEditors(emailAddresses) | Folder | Fügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für Folder hinzu. |
addViewer(emailAddress) | Folder | Der entsprechende Nutzer wird der Liste der Betrachter für Folder hinzugefügt. |
addViewer(user) | Folder | Der entsprechende Nutzer wird der Liste der Betrachter für Folder hinzugefügt. |
addViewers(emailAddresses) | Folder | Fügt das angegebene Array von Nutzern der Liste der Betrachter für Folder hinzu. |
createFile(blob) | File | Erstellt eine Datei im aktuellen Ordner aus einem bestimmten Blob mit beliebigen Daten. |
createFile(name, content) | File | Erstellt eine Textdatei im aktuellen Ordner mit dem angegebenen Namen und Inhalt. |
createFile(name, content, mimeType) | File | Erstellt eine Datei im aktuellen Ordner mit dem angegebenen Namen, Inhalt und dem MIME-Typ. |
createFolder(name) | Folder | Erstellt einen Ordner im aktuellen Ordner mit dem angegebenen Namen. |
createShortcut(targetId) | File | Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und zum Ressourcenschlüssel und gibt sie zurück |
getAccess(email) | Permission | Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde. |
getAccess(user) | Permission | Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde. |
getDateCreated() | Date | Ruft das Erstellungsdatum der Folder ab. |
getDescription() | String | Ruft die Beschreibung für Folder ab |
getEditors() | User[] | Ruft die Liste der Editoren für dieses Folder ab. |
getFiles() | FileIterator | Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind |
getFilesByName(name) | FileIterator | Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben |
getFilesByType(mimeType) | FileIterator | Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen MIME-Typ haben |
getFolders() | FolderIterator | Ruft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind |
getFoldersByName(name) | FolderIterator | Ruft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben |
getId() | String | Ruft die ID von Folder ab |
getLastUpdated() | Date | Ruft das Datum ab, an dem Folder zuletzt aktualisiert wurde. |
getName() | String | Ruft den Namen von Folder ab |
getOwner() | User | Ruft den Inhaber dieses Folder ab. |
getParents() | FolderIterator | Ruft eine Sammlung von Ordnern ab, die unmittelbare übergeordnete Elemente von Folder sind. |
getResourceKey() | String | Ruft den Ressourcenschlüssel von Folder ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden |
getSecurityUpdateEligible() | Boolean | Ruft ab, ob dieses Folder das Sicherheitsupdate anwenden kann, für das ein Ressourcenschlüssel erforderlich ist, wenn er über einen Link freigegeben wird. |
getSecurityUpdateEnabled() | Boolean | Ruft ab, ob dieser Folder einen Ressourcenschlüssel für den Zugriff benötigt, wenn er über einen Link freigegeben wird. |
getSharingAccess() | Access | Ruft ab, welche Klasse von Nutzern auf Folder zugreifen kann, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde. |
getSharingPermission() | Permission | Ruft die Berechtigung ab, die diesen Nutzern gewährt wird, die auf Folder zugreifen können – mit Ausnahme der einzelnen Nutzer, denen explizit Zugriff gewährt wurde. |
getSize() | Integer | Ruft die Anzahl der Bytes ab, die zum Speichern der Folder in Drive verwendet werden |
getUrl() | String | Ruft die URL ab, mit der die Folder in einer Google-App wie Google Drive oder Google Docs geöffnet werden kann. |
getViewers() | User[] | Ruft die Liste der Betrachter und Kommentatoren für dieses Folder ab. |
isShareableByEditors() | Boolean | Bestimmt, ob Nutzer mit Bearbeitungsberechtigungen für Folder diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
isStarred() | Boolean | Bestimmt, ob das Folder in der Ablage des Nutzers markiert wurde. |
isTrashed() | Boolean | Bestimmt, ob sich die Folder im Papierkorb der Ablage des Nutzers befindet. |
moveTo(destination) | Folder | Verschiebt dieses Element in den angegebenen Zielordner. |
removeEditor(emailAddress) | Folder | Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Folder . |
removeEditor(user) | Folder | Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Folder . |
removeViewer(emailAddress) | Folder | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Folder . |
removeViewer(user) | Folder | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Folder . |
revokePermissions(emailAddress) | Folder | Hiermit wird der Zugriff auf die Folder widerrufen, die dem angegebenen Nutzer gewährt wurde. |
revokePermissions(user) | Folder | Hiermit wird der Zugriff auf die Folder widerrufen, die dem angegebenen Nutzer gewährt wurde. |
searchFiles(params) | FileIterator | Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Suchkriterien entsprechen |
searchFolders(params) | FolderIterator | Ruft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Suchkriterien entsprechen |
setDescription(description) | Folder | Legt die Beschreibung für Folder fest. |
setName(name) | Folder | Legt den Namen von Folder fest. |
setOwner(emailAddress) | Folder | Ändert den Inhaber von Folder . |
setOwner(user) | Folder | Ändert den Inhaber von Folder . |
setSecurityUpdateEnabled(enabled) | Folder | Legt fest, ob für den Folder ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird. |
setShareableByEditors(shareable) | Folder | Legt fest, ob Nutzer mit Bearbeitungsberechtigungen für Folder diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
setSharing(accessType, permissionType) | Folder | Legt fest, welche Nutzerklasse auf Folder zugreifen und welche Berechtigungen diese Nutzer neben den einzelnen Nutzern, denen explizit Zugriff gewährt wurde, gewähren. |
setStarred(starred) | Folder | Legt fest, ob das Folder in der Ablage des Nutzers markiert ist. |
setTrashed(trashed) | Folder | Legt fest, ob sich die Folder im Papierkorb der Ablage des Nutzers befindet. |
FolderIterator
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getContinuationToken() | String | Ruft ein Token ab, mit dem diese Iteration später fortgesetzt werden kann |
hasNext() | Boolean | Legt fest, ob beim Aufruf von next() ein Element zurückgegeben wird. |
next() | Folder | Ruft das nächste Element in der Sammlung von Dateien oder Ordnern ab |
Permission
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
VIEW | Enum | Nutzer, die auf die Datei oder den Ordner zugreifen können, können sie nur ansehen oder kopieren. |
EDIT | Enum | Nutzer, die Zugriff auf die Datei oder den Ordner haben, können sie bearbeiten. |
COMMENT | Enum | Nutzer, die auf die Datei oder den Ordner zugreifen können, können sie nur ansehen, kopieren oder kommentieren. |
OWNER | Enum | Der Nutzer ist Eigentümer der Datei oder des Ordners. |
ORGANIZER | Enum | Nutzer, die Dateien und Ordner in einer geteilten Ablage organisieren können |
FILE_ORGANIZER | Enum | Nutzer, die Inhalte in einer geteilten Ablage bearbeiten, in den Papierkorb verschieben und verschieben können |
NONE | Enum | Der Nutzer hat keine Berechtigungen für die Datei oder den Ordner. |
User
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getDomain() | String | Ruft den Domainnamen ab, der dem Konto des Nutzers zugeordnet ist. |
getEmail() | String | Ruft die E-Mail-Adresse des Nutzers ab |
getName() | String | Ruft den Namen des Nutzers ab. |
getPhotoUrl() | String | Ruft die URL für das Foto des Nutzers ab |