Drive Service

Drive

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

// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

Kurse

NameKurzbeschreibung
AccessEin Enum-Wert, der Klassen von Nutzern 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 Skripts, Dateien und Ordner in Google Drive zu erstellen, zu suchen und zu ändern.
FileEine Datei in Google Drive.
FileIteratorEin Iterator, der es Skripts ermöglicht, über eine möglicherweise große Sammlung von Dateien zu iterieren
FolderEin Ordner in Google Drive.
FolderIteratorEin Objekt, mit dem Skripts eine potenziell große Sammlung von Ordnern durchlaufen können.
PermissionEin Enum-Wert, der die Berechtigungen für Nutzer darstellt, die auf eine Datei oder einen Ordner zugreifen können, sowie auf einzelne Nutzer, denen explizit Zugriff gewährt wurde.
UserEin Nutzer, der einer Datei in Google Drive zugeordnet ist.

Access

Attribute

AttributTypBeschreibung
ANYONEEnumJeder im Internet kann die Elemente finden und darauf zugreifen.
ANYONE_WITH_LINKEnumJeder, der über den Link verfügt, hat Zugriff.
DOMAINEnumPersonen in Ihrer Domain sind zur Suche und zum Zugriff berechtigt.
DOMAIN_WITH_LINKEnumPersonen 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-Wert, der Klassen von Nutzern darstellt, die auf eine Datei oder einen Ordner zugreifen können, zusätzlich zu einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
PermissionPermissionEin Enum-Wert, der die Berechtigungen für Nutzer darstellt, die auf eine Datei oder einen Ordner zugreifen können, sowie auf einzelne Nutzer, denen explizit Zugriff gewährt wurde.

Methoden

MethodeRückgabetypKurzbeschreibung
continueFileIterator(continuationToken)FileIteratorSetzt eine Datei Iteration mit einem Fortsetzungs-Token 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 der Ablage des Nutzers aus einer angegebenen Blob mit beliebigen Daten.
createFile(name, content)FileErstellt eine Textdatei im Stammverzeichnis des Nutzers mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt im Stammverzeichnis des Nutzers eine Datei mit dem angegebenen Namen, Inhalt und MIME-Typ.
createFolder(name)FolderEin Ordner im Stammverzeichnis der Ablage in Google Drive mit dem angegebenen Namen wird erstellt.
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 angegebenen Ressourcenschlüssel und gibt sie zurück
enforceSingleParent(value)voidAktiviert oder deaktiviert das Erzwingen 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 Google Drive mit dem angegebenen Namen ab.
getFilesByType(mimeType)FileIteratorRuft eine Sammlung aller Dateien in der Drive-Ablage des Nutzers ab, die den angegebenen MIME-Typ aufweisen.
getFolderById(id)FolderRuft den Ordner mit der angegebenen ID ab.
getFolderByIdAndResourceKey(id, resourceKey)FolderRuft den Ordner mit der angegebenen ID und dem angegebenen Ressourcenschlüssel ab.
getFolders()FolderIteratorRuft eine Sammlung aller Ordner in der Ablage des Nutzers ab.
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner in Google Drive mit dem angegebenen Namen ab.
getRootFolder()FolderRuft den Ordner im Stammverzeichnis des Nutzers in Google Drive ab.
getStorageLimit()IntegerRuft die Anzahl der Byte ab, die der Nutzer in Google Drive speichern darf.
getStorageUsed()IntegerRuft die Anzahl der Byte ab, die der Nutzer derzeit in Google Drive speichert.
getTrashedFiles()FileIteratorRuft eine Sammlung aller Dateien im Papierkorb des Nutzers in Google Drive ab.
getTrashedFolders()FolderIteratorRuft eine Sammlung aller Ordner im Papierkorb des Nutzers in Google Drive ab.
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien im Drive-Konto des Nutzers ab, die den angegebenen Suchkriterien entsprechen.
searchFolders(params)FolderIteratorRuft eine Sammlung aller Ordner im Drive des Nutzers ab, die den angegebenen Suchkriterien entsprechen.

File

Methoden

MethodeRückgabetypKurzbeschreibung
addCommenter(emailAddress)FileFügt den angegebenen Nutzer der Liste der Kommentatoren für File hinzu.
addCommenter(user)FileFügt den angegebenen Nutzer der Liste der Kommentatoren für File hinzu.
addCommenters(emailAddresses)FileFügt das angegebene Array von Nutzern der Liste der Kommentatoren für File hinzu.
addEditor(emailAddress)FileFügt den angegebenen Nutzer der Liste der Bearbeiter für File hinzu.
addEditor(user)FileFügt den angegebenen Nutzer der Liste der Bearbeiter für File hinzu.
addEditors(emailAddresses)FileFügt das angegebene Array von Nutzern der Liste der Bearbeiter für File hinzu.
addViewer(emailAddress)FileFügt den angegebenen Nutzer der Liste der Betrachter für File hinzu.
addViewer(user)FileFügt den angegebenen Nutzer der Liste der Betrachter für File hinzu.
addViewers(emailAddresses)FileFügt das angegebene Array von Nutzern zur Liste der Betrachter für File hinzu.
getAccess(email)PermissionRuft die dem angegebenen Nutzer gewährte Berechtigung ab.
getAccess(user)PermissionRuft die dem angegebenen Nutzer gewährte Berechtigung ab.
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 Datum ab, an dem File erstellt wurde.
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 Bearbeiter für dieses File ab.
getId()StringRuft die ID von File ab.
getLastUpdated()DateRuft das Datum der letzten Aktualisierung von File ab.
getMimeType()StringRuft den MIME-Typ der Datei ab.
getName()StringRuft den Namen des File ab.
getOwner()UserRuft den Dateieigentümer ab.
getParents()FolderIteratorRuft eine Sammlung von Ordnern ab, die direkte ü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 für den Zugriff 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 Nutzerklasse auf die File zugreifen kann, abgesehen von den 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, abgesehen von den einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
getSize()IntegerRuft die Anzahl der Byte ab, die zum Speichern von File in Google Drive verwendet werden.
getTargetId()StringWenn es sich um eine Verknüpfung handelt, wird die ID des Elements zurückgegeben, auf das es verweist.
getTargetMimeType()StringWenn dies eine Verknüpfung 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 es verweist.
getThumbnail()BlobRuft eine Miniaturansicht für die Datei oder null ab, wenn keine Miniaturansicht vorhanden ist.
getUrl()StringRuft die URL ab, mit der 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 File ab.
isShareableByEditors()BooleanBestimmt, ob Nutzer mit Bearbeitungsberechtigungen für die File Dateien für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
isStarred()BooleanErmittelt, ob File in der Ablage des Nutzers markiert wurde.
isTrashed()BooleanBestimmt, ob sich die File im Papierkorb des Drive-Kontos 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 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 das Element in den angegebenen Zielordner.
removeCommenter(emailAddress)FileDer angegebene Nutzer wird aus der Liste der Kommentatoren für File entfernt.
removeCommenter(user)FileDer angegebene Nutzer wird aus der Liste der Kommentatoren für File entfernt.
removeEditor(emailAddress)FileEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für File.
removeEditor(user)FileEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für File.
removeViewer(emailAddress)FileDer Nutzer wird aus der Liste der Betrachter und Kommentatoren für File entfernt.
removeViewer(user)FileDer Nutzer wird aus der Liste der Betrachter und Kommentatoren für File entfernt.
revokePermissions(emailAddress)FileHebt den Zugriff auf den File auf, der dem Nutzer zugewiesen wurde.
revokePermissions(user)FileHebt den Zugriff auf den File auf, der dem Nutzer zugewiesen 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 File einen Ressourcenschlüssel für den Zugriff benötigt, wenn er über einen Link freigegeben wird.
setShareableByEditors(shareable)FileLegt fest, ob Nutzer mit Bearbeitungsberechtigungen für File Dateien für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
setSharing(accessType, permissionType)FileLegt fest, welche Nutzer auf die File zugreifen und welche Berechtigungen ihnen diese Nutzer erteilen können, abgesehen von den einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
setStarred(starred)FileLegt fest, ob File in der Ablage des Nutzers markiert ist.
setTrashed(trashed)FileGibt an, ob sich 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 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)FolderFügt den angegebenen Nutzer der Liste der Bearbeiter für Folder hinzu.
addEditor(user)FolderFügt den angegebenen Nutzer der Liste der Bearbeiter für Folder hinzu.
addEditors(emailAddresses)FolderFügt das angegebene Array von Nutzern der Liste der Bearbeiter für Folder hinzu.
addViewer(emailAddress)FolderFügt den angegebenen Nutzer der Liste der Betrachter für Folder hinzu.
addViewer(user)FolderFügt den angegebenen Nutzer der Liste der Betrachter für Folder hinzu.
addViewers(emailAddresses)FolderFügt das angegebene Array von Nutzern zur Liste der Betrachter für Folder hinzu.
createFile(blob)FileErstellt eine Datei im aktuellen Ordner aus einer angegebenen Blob von beliebigen Daten.
createFile(name, content)FileErstellt im aktuellen Ordner eine Textdatei mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt im aktuellen Ordner eine Datei 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 zur angegebenen Drive-Element-ID und zum angegebenen Ressourcenschlüssel und gibt sie zurück
getAccess(email)PermissionRuft die dem angegebenen Nutzer gewährte Berechtigung ab.
getAccess(user)PermissionRuft die dem angegebenen Nutzer gewährte Berechtigung ab.
getDateCreated()DateRuft das Datum ab, an dem Folder erstellt wurde.
getDescription()StringRuft die Beschreibung für Folder ab.
getEditors()User[]Ruft die Liste der Bearbeiter 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 der letzten Aktualisierung von Folder ab.
getName()StringRuft den Namen des Folder ab.
getOwner()UserRuft den Inhaber von Folder ab.
getParents()FolderIteratorRuft eine Sammlung von Ordnern ab, die direkte ü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 für den Zugriff 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 Nutzerklasse auf die Folder zugreifen kann, abgesehen von den 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, abgesehen von den einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
getSize()IntegerRuft die Anzahl der Byte ab, die zum Speichern von Folder in Google Drive verwendet werden.
getUrl()StringRuft die URL ab, mit der 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 Folder ab.
isShareableByEditors()BooleanBestimmt, ob Nutzer mit Bearbeitungsberechtigungen für die Folder Dateien für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
isStarred()BooleanErmittelt, ob Folder in der Ablage des Nutzers markiert wurde.
isTrashed()BooleanBestimmt, ob sich die Folder im Papierkorb des Drive-Kontos des Nutzers befindet.
moveTo(destination)FolderVerschiebt das Element in den angegebenen Zielordner.
removeEditor(emailAddress)FolderEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Folder.
removeEditor(user)FolderEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Folder.
removeViewer(emailAddress)FolderDer Nutzer wird aus der Liste der Betrachter und Kommentatoren für Folder entfernt.
removeViewer(user)FolderDer Nutzer wird aus der Liste der Betrachter und Kommentatoren für Folder entfernt.
revokePermissions(emailAddress)FolderHebt den Zugriff auf den Folder auf, der dem Nutzer zugewiesen wurde.
revokePermissions(user)FolderHebt den Zugriff auf den Folder auf, der dem Nutzer zugewiesen 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 Folder einen Ressourcenschlüssel für den Zugriff benötigt, wenn er über einen Link freigegeben wird.
setShareableByEditors(shareable)FolderLegt fest, ob Nutzer mit Bearbeitungsberechtigungen für Folder Dateien für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
setSharing(accessType, permissionType)FolderLegt fest, welche Nutzer auf die Folder zugreifen und welche Berechtigungen ihnen diese Nutzer erteilen können, abgesehen von den einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
setStarred(starred)FolderLegt fest, ob Folder in der Ablage des Nutzers markiert ist.
setTrashed(trashed)FolderGibt an, ob sich 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 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 ansehen oder kopieren.
EDITEnumNutzer, die auf die Datei oder den Ordner zugreifen können, können sie auch 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 mit dem Konto des Nutzers verknüpften Domainnamen ab.
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.