Drive Service

Drive

Mit diesem Dienst können Scripts Dateien und Ordner in Google Drive erstellen, suchen und ändern.

Wenn in Ihrem Script ein Standard-Cloud-Projekt anstelle eines Standard-Cloud-Projekts verwendet wird, müssen Sie die Drive API manuell aktivieren. Aktivieren Sie in Ihrem Standard-Cloud-Projekt die Drive API:

Drive API aktivieren

Im folgenden Codebeispiel wird gezeigt, wie die Namen aller Dateien im Ordner „Mein Drive“ 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());
}

Klassen

NameKurzbeschreibung
AccessEin Enum, das Nutzergruppen darstellt, die auf eine Datei oder einen Ordner zugreifen können, zusätzlich zu einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
DriveAppErmöglicht es Scripts, Dateien und Ordner in Google Drive zu erstellen, zu finden und zu ändern.
FileEine Datei in Google Drive.
FileIteratorEin Iterator, mit dem Scripts eine potenziell große Sammlung von Dateien durchgehen können.
FolderEinen Ordner in Google Drive.
FolderIteratorEin Objekt, mit dem Scripts eine potenziell große Sammlung von Ordnern durchlaufen können.
PermissionEin Enum, das die Berechtigungen für Nutzer darstellt, die auf eine Datei oder einen Ordner zugreifen können, zusätzlich zu einzelnen Nutzern, die ausdrücklich Zugriff erhalten haben.
UserEin Nutzer, der mit einer Datei in Google Drive verknüpft ist.

Access

Attribute

AttributTypBeschreibung
ANYONEEnumJeder im Internet ist zur Suche und zum Zugriff berechtigt.
ANYONE_WITH_LINKEnumJeder, der über den Link verfügt, ist zum Zugriff berechtigt.
DOMAINEnumNutzer in Ihrer Domain können die Datei suchen und darauf zugreifen.
DOMAIN_WITH_LINKEnumNutzer in Ihrer Domain, die über den Link verfügen, sind zum Zugriff berechtigt.
PRIVATEEnumNur Personen, denen die entsprechende Berechtigung ausdrücklich erteilt wurde, sind zum Zugriff befugt.

DriveApp

Attribute

AttributTypBeschreibung
AccessAccessEin Enum, das Nutzergruppen darstellt, die auf eine Datei oder einen Ordner zugreifen können, zusätzlich zu einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
PermissionPermissionEin Enum, das die Berechtigungen für Nutzer darstellt, die auf eine Datei oder einen Ordner zugreifen können, zusätzlich zu einzelnen Nutzern, die ausdrücklich Zugriff erhalten haben.

Methoden

MethodeRückgabetypKurzbeschreibung
continueFileIterator(continuationToken)FileIteratorSetzt eine Dateiiteration mit einem Fortsetzungstoken aus einem vorherigen Iterator fort.
continueFolderIterator(continuationToken)FolderIteratorEine Ordneriteration wird mit einem Fortsetzungstoken aus einem vorherigen Iterator fortgesetzt.
createFile(blob)FileErstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers aus einer bestimmten Blob mit beliebigen Daten.
createFile(name, content)FileErstellt eine Textdatei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen, Inhalt und MIME-Typ.
createFolder(name)FolderErstellt einen Ordner im Stammverzeichnis des Drive-Ordners 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 mit der angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück.
enforceSingleParent(value)voidAktiviert oder deaktiviert das Verhalten „enforceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente von Artikeln auswirken.
getFileById(id)FileRuft die Datei mit der angegebenen ID ab.
getFileByIdAndResourceKey(id, resourceKey)FileRuft die Datei mit der angegebenen ID und dem Ressourcenschlüssel ab.
getFiles()FileIteratorEine Sammlung aller Dateien im Drive des Nutzers wird abgerufen.
getFilesByName(name)FileIteratorRuft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Namen haben.
getFilesByType(mimeType)FileIteratorStellt eine Sammlung aller Dateien im Drive des Nutzers mit dem angegebenen MIME-Typ bereit.
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()FolderIteratorEine Sammlung aller Ordner im Drive des Nutzers wird abgerufen.
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner im Drive des Nutzers mit dem angegebenen Namen ab.
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()IntegerDie Anzahl der Byte, die der Nutzer derzeit in Drive speichert.
getTrashedFiles()FileIteratorStellt eine Sammlung aller Dateien im Papierkorb des Nutzers in Google Drive bereit.
getTrashedFolders()FolderIteratorHiermit wird eine Sammlung aller Ordner im Papierkorb des Drive-Kontos des Nutzers abgerufen.
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Suchkriterien entsprechen.
searchFolders(params)FolderIteratorStellt eine Sammlung aller Ordner im Drive des Nutzers zurück, die den angegebenen Suchkriterien entsprechen.

File

Methoden

MethodeRückgabetypKurzbeschreibung
addCommenter(emailAddress)FileFügen Sie den angegebenen Nutzer der Liste der Kommentatoren für die File hinzu.
addCommenter(user)FileFügen Sie den angegebenen Nutzer der Liste der Kommentatoren für die File hinzu.
addCommenters(emailAddresses)FileFüge der Liste der Kommentatoren für die File das angegebene Array von Nutzern hinzu.
addEditor(emailAddress)FileDer angegebene Nutzer wird der Liste der Mitbearbeiter für die File hinzugefügt.
addEditor(user)FileDer angegebene Nutzer wird der Liste der Mitbearbeiter für die File hinzugefügt.
addEditors(emailAddresses)FileFügt der Liste der Mitbearbeiter für die File das angegebene Nutzerarray hinzu.
addViewer(emailAddress)FileDer angegebene Nutzer wird der Liste der Zuschauer für die File hinzugefügt.
addViewer(user)FileDer angegebene Nutzer wird der Liste der Zuschauer für die File hinzugefügt.
addViewers(emailAddresses)FileFügen Sie der Liste der Zuschauer für die File das angegebene Array von Nutzern hinzu.
getAccess(email)PermissionRuft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde.
getAccess(user)PermissionRuft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getDateCreated()DateDas Datum, an dem die File erstellt wurde.
getDescription()StringRuft die Beschreibung für die File ab.
getDownloadUrl()StringRuft die URL ab, über die die Datei heruntergeladen werden kann.
getEditors()User[]Ruft die Liste der Mitbearbeiter für diese File ab.
getId()StringRuft die ID der File ab.
getLastUpdated()DateDas Datum, an dem die File zuletzt aktualisiert wurde.
getMimeType()StringRuft den MIME-Typ der Datei ab.
getName()StringRuft den Namen der File ab.
getOwner()UserRuft den Eigentümer der Datei ab.
getParents()FolderIteratorHiermit wird eine Sammlung von Ordnern abgerufen, die unmittelbar übergeordnete Elemente von File sind.
getResourceKey()StringRuft den Ressourcenschlüssel der File ab, der zum Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden.
getSecurityUpdateEligible()BooleanGibt an, ob für diese File das Sicherheitsupdate angewendet werden kann, für das ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn die Datei über einen Link freigegeben wird.
getSecurityUpdateEnabled()BooleanGibt an, ob für diese File ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn sie über einen Link freigegeben wird.
getSharingAccess()AccessGibt an, welche Nutzergruppe neben einzelnen Nutzern, denen explizit Zugriff gewährt wurde, auf das File zugreifen kann.
getSharingPermission()PermissionRuft die Berechtigung ab, die Nutzern gewährt wurde, die auf die File zugreifen können, sowie die Berechtigung einzelner Nutzer, denen explizit Zugriff gewährt wurde.
getSize()IntegerDie Anzahl der Byte, die zum Speichern der File in Drive verwendet werden.
getTargetId()StringWenn es sich um einen Verknüpfung handelt, wird die ID des Elements zurückgegeben, auf das sie verweist.
getTargetMimeType()StringWenn es sich um einen Verknüpfung handelt, wird der MIME-Typ des Elements zurückgegeben, auf das sie verweist.
getTargetResourceKey()StringWenn es sich bei der Datei um einen Verknüpfung handelt, wird der Ressourcenschlüssel des Elements zurückgegeben, auf das sie verweist.
getThumbnail()BlobHier wird ein Thumbnail-Bild für die Datei abgerufen oder null, wenn kein Thumbnail vorhanden ist.
getUrl()StringDie URL, mit der die File in einer Google-App wie Drive oder Docs geöffnet werden kann.
getViewers()User[]Ruft die Liste der Betrachter und Kommentatoren für diese File ab.
isShareableByEditors()BooleanBestimmt, ob Nutzer mit Bearbeitungsberechtigungen für die File die Inhalte für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
isStarred()BooleanGibt an, ob die File im Drive des Nutzers mit einem Stern markiert wurde.
isTrashed()BooleanBestimmt, ob sich die File im Papierkorb des Nutzers in Google Drive befindet.
makeCopy()FileErstellt eine Kopie der Datei.
makeCopy(destination)FileErstellt eine Kopie der Datei im Zielverzeichnis.
makeCopy(name)FileErstellt eine Kopie der Datei und benennt sie mit dem angegebenen Namen.
makeCopy(name, destination)FileErstellt eine Kopie der Datei im Zielverzeichnis und benennt sie mit dem angegebenen Namen.
moveTo(destination)FileVerschiebt dieses Element in den angegebenen Zielordner.
removeCommenter(emailAddress)FileDer angegebene Nutzer wird aus der Liste der Kommentatoren für die File entfernt.
removeCommenter(user)FileDer angegebene Nutzer wird aus der Liste der Kommentatoren für die File entfernt.
removeEditor(emailAddress)FileDer angegebene Nutzer wird aus der Liste der Mitbearbeiter der File entfernt.
removeEditor(user)FileDer angegebene Nutzer wird aus der Liste der Mitbearbeiter der File entfernt.
removeViewer(emailAddress)FileDer angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die File entfernt.
removeViewer(user)FileDer angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die File entfernt.
revokePermissions(emailAddress)FileHiermit wird der dem Nutzer gewährte Zugriff auf File widerrufen.
revokePermissions(user)FileHiermit wird der dem Nutzer gewährte Zugriff auf File widerrufen.
setContent(content)FileÜberschreibt den Inhalt der Datei mit einem bestimmten Ersatz.
setDescription(description)FileLegt die Beschreibung für die File fest.
setName(name)FileLegt den Namen der File fest.
setOwner(emailAddress)FileÄndert den Inhaber der File.
setOwner(user)FileÄndert den Inhaber der File.
setSecurityUpdateEnabled(enabled)FileLegt fest, ob für den Zugriff auf die File ein Ressourcenschlüssel erforderlich ist, wenn sie über einen Link freigegeben wird.
setShareableByEditors(shareable)FileHier legen Sie fest, ob Nutzer mit Bearbeitungsberechtigungen für die File die Inhalte für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
setSharing(accessType, permissionType)FileHier wird festgelegt, welche Nutzergruppe auf die File zugreifen kann und welche Berechtigungen diesen Nutzern gewährt werden, zusätzlich zu einzelnen Nutzern, die ausdrücklich Zugriff erhalten haben.
setStarred(starred)FileGibt an, ob die File im Drive des Nutzers mit einem Stern markiert ist.
setTrashed(trashed)FileGibt an, ob sich die File im Papierkorb des Drive-Kontos des Nutzers befindet.

FileIterator

Methoden

MethodeRückgabetypKurzbeschreibung
getContinuationToken()StringRuft ein Token ab, mit dem diese Iteration zu einem späteren Zeitpunkt fortgesetzt werden kann.
hasNext()BooleanBestimmt, ob beim Aufrufen 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 angegebene Nutzer wird der Liste der Mitbearbeiter für die Folder hinzugefügt.
addEditor(user)FolderDer angegebene Nutzer wird der Liste der Mitbearbeiter für die Folder hinzugefügt.
addEditors(emailAddresses)FolderFügt der Liste der Mitbearbeiter für die Folder das angegebene Nutzerarray hinzu.
addViewer(emailAddress)FolderDer angegebene Nutzer wird der Liste der Zuschauer für die Folder hinzugefügt.
addViewer(user)FolderDer angegebene Nutzer wird der Liste der Zuschauer für die Folder hinzugefügt.
addViewers(emailAddresses)FolderFügen Sie der Liste der Zuschauer für die Folder das angegebene Array von Nutzern hinzu.
createFile(blob)FileErstellt eine Datei im aktuellen Ordner aus einer angegebenen 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 MIME-Typ.
createFolder(name)FolderErstellt im aktuellen Ordner einen 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 mit der angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück.
getAccess(email)PermissionRuft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde.
getAccess(user)PermissionRuft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde.
getDateCreated()DateDas Datum, an dem die Folder erstellt wurde.
getDescription()StringRuft die Beschreibung für die Folder ab.
getEditors()User[]Ruft die Liste der Mitbearbeiter für diese Folder ab.
getFiles()FileIteratorRuft eine Sammlung aller Dateien ab, die untergeordnete Elemente des aktuellen Ordners 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 untergeordnet zum aktuellen Ordner sind.
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben.
getId()StringRuft die ID der Folder ab.
getLastUpdated()DateDas Datum, an dem die Folder zuletzt aktualisiert wurde.
getName()StringRuft den Namen der Folder ab.
getOwner()UserRuft den Eigentümer dieser Folder ab.
getParents()FolderIteratorHiermit wird eine Sammlung von Ordnern abgerufen, die unmittelbar übergeordnete Elemente von Folder sind.
getResourceKey()StringRuft den Ressourcenschlüssel der Folder ab, der zum Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden.
getSecurityUpdateEligible()BooleanGibt an, ob für diese Folder das Sicherheitsupdate angewendet werden kann, für das ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn die Datei über einen Link freigegeben wird.
getSecurityUpdateEnabled()BooleanGibt an, ob für diese Folder ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn sie über einen Link freigegeben wird.
getSharingAccess()AccessGibt an, welche Nutzergruppe neben einzelnen Nutzern, denen explizit Zugriff gewährt wurde, auf das Folder zugreifen kann.
getSharingPermission()PermissionRuft die Berechtigung ab, die Nutzern gewährt wurde, die auf die Folder zugreifen können, sowie die Berechtigung einzelner Nutzer, denen explizit Zugriff gewährt wurde.
getSize()IntegerDie Anzahl der Byte, die zum Speichern der Folder in Drive verwendet werden.
getUrl()StringDie URL, mit der die Folder in einer Google-App wie Drive oder Docs geöffnet werden kann.
getViewers()User[]Ruft die Liste der Betrachter und Kommentatoren für diese Folder ab.
isShareableByEditors()BooleanBestimmt, ob Nutzer mit Bearbeitungsberechtigungen für die Folder die Inhalte für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
isStarred()BooleanGibt an, ob die Folder im Drive des Nutzers mit einem Stern markiert wurde.
isTrashed()BooleanBestimmt, ob sich die Folder im Papierkorb des Nutzers in Google Drive befindet.
moveTo(destination)FolderVerschiebt dieses Element in den angegebenen Zielordner.
removeEditor(emailAddress)FolderDer angegebene Nutzer wird aus der Liste der Mitbearbeiter der Folder entfernt.
removeEditor(user)FolderDer angegebene Nutzer wird aus der Liste der Mitbearbeiter der Folder entfernt.
removeViewer(emailAddress)FolderDer angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Folder entfernt.
removeViewer(user)FolderDer angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Folder entfernt.
revokePermissions(emailAddress)FolderHiermit wird der dem Nutzer gewährte Zugriff auf Folder widerrufen.
revokePermissions(user)FolderHiermit wird der dem Nutzer gewährte Zugriff auf Folder widerrufen.
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien ab, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Suchkriterien entsprechen.
searchFolders(params)FolderIteratorRuft eine Sammlung aller Ordner ab, die untergeordnet zum aktuellen Ordner sind und den angegebenen Suchkriterien entsprechen.
setDescription(description)FolderLegt die Beschreibung für die Folder fest.
setName(name)FolderLegt den Namen der Folder fest.
setOwner(emailAddress)FolderÄndert den Inhaber der Folder.
setOwner(user)FolderÄndert den Inhaber der Folder.
setSecurityUpdateEnabled(enabled)FolderLegt fest, ob für den Zugriff auf die Folder ein Ressourcenschlüssel erforderlich ist, wenn sie über einen Link freigegeben wird.
setShareableByEditors(shareable)FolderHier legen Sie fest, ob Nutzer mit Bearbeitungsberechtigungen für die Folder die Inhalte für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
setSharing(accessType, permissionType)FolderHier wird festgelegt, welche Nutzergruppe auf die Folder zugreifen kann und welche Berechtigungen diesen Nutzern gewährt werden, zusätzlich zu einzelnen Nutzern, die ausdrücklich Zugriff erhalten haben.
setStarred(starred)FolderGibt an, ob die Folder im Drive des Nutzers mit einem Stern markiert ist.
setTrashed(trashed)FolderGibt an, ob sich die Folder im Papierkorb des Drive-Kontos des Nutzers befindet.

FolderIterator

Methoden

MethodeRückgabetypKurzbeschreibung
getContinuationToken()StringRuft ein Token ab, mit dem diese Iteration zu einem späteren Zeitpunkt fortgesetzt werden kann.
hasNext()BooleanBestimmt, ob beim Aufrufen 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 aufrufen oder kopieren.
EDITEnumNutzer, die auf die Datei oder den Ordner zugreifen können, 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 der 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()StringDer Domainname, der mit dem Konto des Nutzers verknüpft ist.
getEmail()StringRuft die E-Mail-Adresse des Nutzers ab.
getName()StringDer Name des Nutzers.
getPhotoUrl()StringDie URL für das Foto des Nutzers.