Drive Service

Drive

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:

Drive API aktivieren

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

NameKurzbeschreibung
AccessEine 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.
DriveAppErmöglicht es Skripts, Dateien und Ordner in Google Drive zu erstellen, zu suchen und zu ändern.
FileEine Datei in Google Drive
FileIteratorEin Iterator, mit dem Skripts eine potenziell große Dateisammlung iterieren können.
FolderEin Ordner in Google Drive
FolderIteratorEin Objekt, mit dem Skripts eine potenziell große Sammlung von Ordnern iterieren können.
PermissionEine 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.
UserEin Nutzer, der einer Datei in Google Drive zugeordnet ist.

Access

Attribute

AttributTypBeschreibung
ANYONEEnumJeder im Internet kann das Element finden und darauf zugreifen.
ANYONE_WITH_LINKEnumJeder, der über den Link verfügt, hat Zugriff.
DOMAINEnumPersonen in Ihrer Domain können die Datei finden und darauf zugreifen.
DOMAIN_WITH_LINKEnumPersonen in Ihrer Domain, die über den Link verfügen, haben Zugriff.
PRIVATEEnumNur Personen, denen die entsprechende Berechtigung ausdrücklich erteilt wurde, sind zum Zugriff befugt.

DriveApp

Attribute

AttributTypBeschreibung
AccessAccessEine 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.
PermissionPermissionEine 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

MethodeRückgabetypKurzbeschreibung
continueFileIterator(continuationToken)FileIteratorSetzt eine Datei Iteration mithilfe eines Fortsetzungstokens aus einem vorherigen Iterator fort.
continueFolderIterator(continuationToken)FolderIteratorSetzt eine Ordneriteration mit einem Fortsetzungstoken aus einem vorherigen Iterator fort.
createFile(blob)FileErstellt eine Datei im Stammverzeichnis des Drive-Nutzers aus einer gegebenen Blob mit beliebigen Daten.
createFile(name, content)FileErstellt eine Textdatei im Stammverzeichnis der Ablage des Nutzers mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt eine Datei im Stammverzeichnis der Ablage des Nutzers mit dem angegebenen Namen, Inhalt und MIME-Typ.
createFolder(name)FolderErstellt einen Ordner im Stammverzeichnis der Drive-Ablage des Nutzers 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 zum Ressourcenschlüssel und gibt sie zurück
enforceSingleParent(value)voidAktiviert oder deaktiviert das Verhalten von „SingleSingleParent“ 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 angegebenen Ressourcenschlüssel ab.
getFiles()FileIteratorRuft eine Sammlung aller Dateien in der Ablage des Nutzers ab
getFilesByName(name)FileIteratorRuft eine Sammlung aller Dateien in der Ablage des Nutzers ab, die den angegebenen Namen haben
getFilesByType(mimeType)FileIteratorRuft eine Sammlung aller Dateien in der Ablage 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 in der Ablage des Nutzers ab, die den angegebenen Namen haben
getRootFolder()FolderRuft den Ordner im Stammverzeichnis des Drive-Ordners des Nutzers ab.
getStorageLimit()IntegerRuft die Anzahl der Byte ab, die der Nutzer in 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 der Ablage des Nutzers ab
getTrashedFolders()FolderIteratorRuft eine Sammlung aller Ordner im Papierkorb des Drive-Nutzers ab
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Suchkriterien entsprechen.
searchFolders(params)FolderIteratorRuft eine Sammlung aller Ordner in der Ablage des Nutzers ab, die den angegebenen Suchkriterien entsprechen

File

Methoden

MethodeRückgabetypKurzbeschreibung
addCommenter(emailAddress)FileFügen Sie den angegebenen Nutzer zur Liste der Kommentatoren für File hinzu.
addCommenter(user)FileFügen Sie den angegebenen Nutzer zur Liste der Kommentatoren für File hinzu.
addCommenters(emailAddresses)FileFüge das angegebene Array der Nutzer der Liste der Kommentatoren für File hinzu.
addEditor(emailAddress)FileDer entsprechende Nutzer wird der Liste der Mitbearbeiter für File hinzugefügt.
addEditor(user)FileDer entsprechende Nutzer wird der Liste der Mitbearbeiter für File hinzugefügt.
addEditors(emailAddresses)FileFügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für File hinzu.
addViewer(emailAddress)FileDer entsprechende Nutzer wird der Liste der Betrachter für File hinzugefügt.
addViewer(user)FileDer entsprechende Nutzer wird der Liste der Betrachter für File hinzugefügt.
addViewers(emailAddresses)FileFügt das angegebene Array von Nutzern der Liste der Betrachter für File hinzu.
getAccess(email)PermissionRuft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde.
getAccess(user)PermissionRuft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getDateCreated()DateRuft das Erstellungsdatum der File ab.
getDescription()StringRuft die Beschreibung für File ab
getDownloadUrl()StringRuft die URL ab, die zum Herunterladen der Datei verwendet werden kann.
getEditors()User[]Ruft die Liste der Editoren für dieses File ab.
getId()StringRuft die ID von File ab
getLastUpdated()DateRuft das Datum ab, an dem File zuletzt aktualisiert wurde.
getMimeType()StringRuft den MIME-Typ der Datei ab
getName()StringRuft den Namen von File ab
getOwner()UserRuft den Dateieigentümer ab
getParents()FolderIteratorRuft eine Sammlung von Ordnern ab, die unmittelbare übergeordnete Elemente von File sind.
getResourceKey()StringRuft den Ressourcenschlüssel von File ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden
getSecurityUpdateEligible()BooleanRuft ab, ob dieses File das Sicherheitsupdate anwenden kann, für das ein Ressourcenschlüssel erforderlich ist, wenn er über einen Link freigegeben wird.
getSecurityUpdateEnabled()BooleanRuft ab, ob dieser File einen Ressourcenschlüssel für den Zugriff benötigt, wenn er über einen Link freigegeben wird.
getSharingAccess()AccessRuft ab, welche Klasse von Nutzern auf File zugreifen kann, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
getSharingPermission()PermissionRuft 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()IntegerRuft die Anzahl der Bytes ab, die zum Speichern der File in Drive verwendet werden
getTargetId()StringWenn es ein Shortcut ist, wird die ID des Elements zurückgegeben, auf das es verweist.
getTargetMimeType()StringWenn es ein Shortcut ist, wird der MIME-Typ des Elements zurückgegeben, auf das es verweist.
getTargetResourceKey()StringWenn die Datei eine Verknüpfung ist, wird der Ressourcenschlüssel des Elements zurückgegeben, auf das sie verweist.
getThumbnail()BlobRuft ein Thumbnail für die Datei ab oder null, wenn kein Thumbnail vorhanden ist
getUrl()StringRuft 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()BooleanBestimmt, ob Nutzer mit Bearbeitungsberechtigungen für File diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
isStarred()BooleanBestimmt, ob das File in der Ablage des Nutzers markiert wurde.
isTrashed()BooleanBestimmt, ob sich die File im Papierkorb der Ablage des Nutzers befindet.
makeCopy()FileErstellt eine Kopie der Datei.
makeCopy(destination)FileErstellt eine Kopie der Datei im Zielverzeichnis.
makeCopy(name)FileErstellt eine Kopie der Datei und gibt ihr einen Namen mit dem angegebenen Namen.
makeCopy(name, destination)FileErstellt eine Kopie der Datei im Zielverzeichnis und benannt sie mit dem angegebenen Namen.
moveTo(destination)FileVerschiebt dieses Element in den angegebenen Zielordner.
removeCommenter(emailAddress)FileEntfernt den angegebenen Nutzer aus der Liste der Kommentatoren für File.
removeCommenter(user)FileEntfernt den angegebenen Nutzer aus der Liste der Kommentatoren für File.
removeEditor(emailAddress)FileEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für File.
removeEditor(user)FileEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für File.
removeViewer(emailAddress)FileEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von File.
removeViewer(user)FileEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von File.
revokePermissions(emailAddress)FileHiermit wird der Zugriff auf die File widerrufen, die dem angegebenen Nutzer gewährt wurde.
revokePermissions(user)FileHiermit 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)FileLegt die Beschreibung für File fest.
setName(name)FileLegt den Namen von File fest.
setOwner(emailAddress)FileÄndert den Inhaber von File.
setOwner(user)FileÄndert den Inhaber von File.
setSecurityUpdateEnabled(enabled)FileLegt fest, ob für den File ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird.
setShareableByEditors(shareable)FileLegt fest, ob Nutzer mit Bearbeitungsberechtigungen für File diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
setSharing(accessType, permissionType)FileLegt 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)FileLegt fest, ob das File in der Ablage des Nutzers markiert ist.
setTrashed(trashed)FileLegt fest, ob sich die File im Papierkorb der Ablage des Nutzers befindet.

FileIterator

Methoden

MethodeRückgabetypKurzbeschreibung
getContinuationToken()StringRuft ein Token ab, mit dem diese Iteration später fortgesetzt werden kann
hasNext()BooleanLegt fest, ob beim Aufruf von next() ein Element zurückgegeben wird.
next()FileRuft das nächste Element in der Sammlung von Dateien oder Ordnern ab

Folder

Methoden

MethodeRückgabetypKurzbeschreibung
addEditor(emailAddress)FolderDer entsprechende Nutzer wird der Liste der Mitbearbeiter für Folder hinzugefügt.
addEditor(user)FolderDer entsprechende Nutzer wird der Liste der Mitbearbeiter für Folder hinzugefügt.
addEditors(emailAddresses)FolderFügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für Folder hinzu.
addViewer(emailAddress)FolderDer entsprechende Nutzer wird der Liste der Betrachter für Folder hinzugefügt.
addViewer(user)FolderDer entsprechende Nutzer wird der Liste der Betrachter für Folder hinzugefügt.
addViewers(emailAddresses)FolderFügt das angegebene Array von Nutzern der Liste der Betrachter für Folder hinzu.
createFile(blob)FileErstellt eine Datei im aktuellen Ordner aus einem bestimmten Blob mit beliebigen Daten.
createFile(name, content)FileErstellt eine Textdatei im aktuellen Ordner mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt eine Datei im aktuellen Ordner mit dem angegebenen Namen, Inhalt und dem MIME-Typ.
createFolder(name)FolderErstellt einen Ordner im aktuellen 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 zum Ressourcenschlüssel und gibt sie zurück
getAccess(email)PermissionRuft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde.
getAccess(user)PermissionRuft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde.
getDateCreated()DateRuft das Erstellungsdatum der Folder ab.
getDescription()StringRuft die Beschreibung für Folder ab
getEditors()User[]Ruft die Liste der Editoren für dieses Folder ab.
getFiles()FileIteratorRuft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind
getFilesByName(name)FileIteratorRuft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben
getFilesByType(mimeType)FileIteratorRuft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen MIME-Typ haben
getFolders()FolderIteratorRuft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben
getId()StringRuft die ID von Folder ab
getLastUpdated()DateRuft das Datum ab, an dem Folder zuletzt aktualisiert wurde.
getName()StringRuft den Namen von Folder ab
getOwner()UserRuft den Inhaber dieses Folder ab.
getParents()FolderIteratorRuft eine Sammlung von Ordnern ab, die unmittelbare übergeordnete Elemente von Folder sind.
getResourceKey()StringRuft den Ressourcenschlüssel von Folder ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden
getSecurityUpdateEligible()BooleanRuft ab, ob dieses Folder das Sicherheitsupdate anwenden kann, für das ein Ressourcenschlüssel erforderlich ist, wenn er über einen Link freigegeben wird.
getSecurityUpdateEnabled()BooleanRuft ab, ob dieser Folder einen Ressourcenschlüssel für den Zugriff benötigt, wenn er über einen Link freigegeben wird.
getSharingAccess()AccessRuft ab, welche Klasse von Nutzern auf Folder zugreifen kann, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
getSharingPermission()PermissionRuft 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()IntegerRuft die Anzahl der Bytes ab, die zum Speichern der Folder in Drive verwendet werden
getUrl()StringRuft 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()BooleanBestimmt, ob Nutzer mit Bearbeitungsberechtigungen für Folder diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
isStarred()BooleanBestimmt, ob das Folder in der Ablage des Nutzers markiert wurde.
isTrashed()BooleanBestimmt, ob sich die Folder im Papierkorb der Ablage des Nutzers befindet.
moveTo(destination)FolderVerschiebt dieses Element in den angegebenen Zielordner.
removeEditor(emailAddress)FolderEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Folder.
removeEditor(user)FolderEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für Folder.
removeViewer(emailAddress)FolderEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Folder.
removeViewer(user)FolderEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von Folder.
revokePermissions(emailAddress)FolderHiermit wird der Zugriff auf die Folder widerrufen, die dem angegebenen Nutzer gewährt wurde.
revokePermissions(user)FolderHiermit wird der Zugriff auf die Folder widerrufen, die dem angegebenen Nutzer gewährt wurde.
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Suchkriterien entsprechen
searchFolders(params)FolderIteratorRuft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Suchkriterien entsprechen
setDescription(description)FolderLegt die Beschreibung für Folder fest.
setName(name)FolderLegt den Namen von Folder fest.
setOwner(emailAddress)FolderÄndert den Inhaber von Folder.
setOwner(user)FolderÄndert den Inhaber von Folder.
setSecurityUpdateEnabled(enabled)FolderLegt fest, ob für den Folder ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird.
setShareableByEditors(shareable)FolderLegt fest, ob Nutzer mit Bearbeitungsberechtigungen für Folder diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
setSharing(accessType, permissionType)FolderLegt 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)FolderLegt fest, ob das Folder in der Ablage des Nutzers markiert ist.
setTrashed(trashed)FolderLegt fest, ob sich die Folder im Papierkorb der Ablage des Nutzers befindet.

FolderIterator

Methoden

MethodeRückgabetypKurzbeschreibung
getContinuationToken()StringRuft ein Token ab, mit dem diese Iteration später fortgesetzt werden kann
hasNext()BooleanLegt fest, ob beim Aufruf von next() ein Element zurückgegeben wird.
next()FolderRuft das nächste Element in der Sammlung von Dateien oder Ordnern ab

Permission

Attribute

AttributTypBeschreibung
VIEWEnumNutzer, die auf die Datei oder den Ordner zugreifen können, können sie nur ansehen oder kopieren.
EDITEnumNutzer, die Zugriff auf die Datei oder den Ordner haben, können sie bearbeiten.
COMMENTEnumNutzer, die auf die Datei oder den Ordner zugreifen können, können sie nur ansehen, kopieren oder kommentieren.
OWNEREnumDer Nutzer ist Eigentümer der Datei oder des Ordners.
ORGANIZEREnumNutzer, die Dateien und Ordner in einer geteilten Ablage organisieren können
FILE_ORGANIZEREnumNutzer, die Inhalte in einer geteilten Ablage bearbeiten, in den Papierkorb verschieben und verschieben können
NONEEnumDer Nutzer hat keine Berechtigungen für die Datei oder den Ordner.

User

Methoden

MethodeRückgabetypKurzbeschreibung
getDomain()StringRuft den Domainnamen ab, der dem Konto des Nutzers zugeordnet ist.
getEmail()StringRuft die E-Mail-Adresse des Nutzers ab
getName()StringRuft den Namen des Nutzers ab.
getPhotoUrl()StringRuft die URL für das Foto des Nutzers ab