Drive Service

Drive

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

Wenn Ihr Skript ein Standard-Cloud-Projekt anstelle eines Cloud-Standardprojekts verwendet, müssen Sie die Drive API manuell aktivieren. Aktivieren Sie in Ihrem Cloud-Standardprojekt die Drive API:

Drive API aktivieren

Im folgenden Codebeispiel wird gezeigt, wie die Namen jeder Datei im Ordner „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
AccessEin Enum, das Klassen von Nutzern darstellt, die auf eine Datei oder einen Ordner zugreifen können, mit Ausnahme einzelner Nutzer, denen explizit Zugriff gewährt wurde.
DriveAppDamit können Skripts Dateien und Ordner in Google Drive erstellen, suchen und ändern.
FileEine Datei in Google Drive
FileIteratorEin Iterator, der Skripts die Iteration über eine potenziell große Sammlung von Dateien ermöglicht.
FolderEin Ordner in Google Drive.
FolderIteratorEin Objekt, das Skripts die Iteration über eine potenziell große Sammlung von Ordnern ermöglicht.
PermissionEin Enum-Wert, der die Berechtigungen darstellt, die den Nutzern gewährt werden, die auf eine Datei oder einen Ordner zugreifen können, mit Ausnahme der einzelnen Nutzer, denen explizit Zugriff gewährt wurde.
UserEin Nutzer, der mit einer Datei in Google Drive verknüpft ist.

Access

Attribute

PropertyTypBeschreibung
ANYONEEnumJeder im Internet ist zur Suche und zum Zugriff berechtigt.
ANYONE_WITH_LINKEnumJeder, der über den Link verfügt, ist zum Zugriff berechtigt.
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

PropertyTypBeschreibung
AccessAccessEin Enum, das Klassen von Nutzern darstellt, die auf eine Datei oder einen Ordner zugreifen können, mit Ausnahme einzelner Nutzer, denen explizit Zugriff gewährt wurde.
PermissionPermissionEin Enum-Wert, der die Berechtigungen darstellt, die den Nutzern gewährt werden, die auf eine Datei oder einen Ordner zugreifen können, mit Ausnahme der einzelnen Nutzer, denen explizit Zugriff gewährt wurde.

Methoden

MethodeRückgabetypKurzbeschreibung
continueFileIterator(continuationToken)FileIteratorSetzt eine Dateiiteration mit einem Fortsetzungstoken von einem vorherigen Iteration fort.
continueFolderIterator(continuationToken)FolderIteratorSetzt eine Ordneriteration mit einem Fortsetzungstoken von einem vorherigen Iteration fort.
createFile(blob)FileErstellt eine Datei im Stammverzeichnis der Ablage des Nutzers aus einem gegebenen Blob beliebiger Daten.
createFile(name, content)FileErstellt im Stammverzeichnis der Ablage des Nutzers eine Textdatei mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt im Stammverzeichnis der Ablage des Nutzers eine Datei mit dem angegebenen Namen, den angegebenen Inhalten und dem angegebenen MIME-Typ.
createFolder(name)FolderErstellt im Stammverzeichnis der Ablage des Nutzers 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 dem Ressourcenschlüssel und gibt sie zurück.
enforceSingleParent(value)voidAktiviert oder deaktiviert die Funktion „ForceSingleParent“ 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 Ressourcenschlüssel ab.
getFiles()FileIteratorRuft eine Sammlung aller Dateien im Google Drive-Konto des Nutzers ab.
getFilesByName(name)FileIteratorRuft eine Sammlung aller Dateien im Google Drive des Nutzers ab, die den angegebenen Namen haben.
getFilesByType(mimeType)FileIteratorRuft eine Sammlung aller Dateien im Drive-Konto 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 im Google Drive des Nutzers ab, die den angegebenen Namen haben.
getRootFolder()FolderOrdner im Stammverzeichnis der Ablage des Nutzers abrufen
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 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-Ordner des Nutzers ab, die den angegebenen Suchkriterien entsprechen.
searchFolders(params)FolderIteratorRuft eine Sammlung aller Ordner im Drive-Konto des Nutzers ab, die den angegebenen Suchkriterien entsprechen.

File

Methoden

MethodeRückgabetypKurzbeschreibung
addCommenter(emailAddress)FileFügen Sie den angegebenen Nutzer der Liste der Kommentatoren für File hinzu.
addCommenter(user)FileFügen Sie den angegebenen Nutzer der Liste der Kommentatoren für File hinzu.
addCommenters(emailAddresses)FileFüge 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 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 Datum ab, an dem File erstellt wurde.
getDescription()StringRuft die Beschreibung für File ab.
getDownloadUrl()StringRuft die URL ab, über die die Datei heruntergeladen werden kann.
getEditors()User[]Ruft die Liste der Bearbeiter für diesen 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 des File ab.
getOwner()UserRuft den Dateieigentümer ab.
getParents()FolderIteratorRuft eine Sammlung von Ordnern ab, die File unmittelbar übergeordnet 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 dieser File berechtigt ist, das Sicherheitsupdate anzuwenden, das einen Ressourcenschlüssel für den Zugriff erfordert, wenn es über einen Link freigegeben wird.
getSecurityUpdateEnabled()BooleanRuft ab, ob für diesen File ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird.
getSharingAccess()AccessRuft ab, welche Klasse von Nutzern auf File zugreifen kann, ausgenommen einzelne Nutzer, denen explizit Zugriff gewährt wurde.
getSharingPermission()PermissionRuft die Berechtigung für die Nutzer ab, die auf File zugreifen können, ausgenommen einzelne Nutzer, denen explizit Zugriff gewährt wurde.
getSize()IntegerRuft die Anzahl der Byte ab, die zum Speichern von File in Drive verwendet werden.
getTargetId()StringBei einer Verknüpfung wird die ID des Elements zurückgegeben, auf das sie verweist.
getTargetMimeType()StringWenn es sich um einen Shortcut handelt, wird der MIME-Typ des Elements zurückgegeben, auf das es verweist.
getTargetResourceKey()StringWenn es sich bei der Datei um eine Verknüpfung handelt, wird der Ressourcenschlüssel des Elements zurückgegeben, auf das sie verweist.
getThumbnail()BlobRuft eine Miniaturansicht für die Datei ab oder null, wenn keine Miniaturansicht vorhanden ist.
getUrl()StringRuft die URL ab, mit der File in einer Google-App wie Drive oder Docs geöffnet werden kann.
getViewers()User[]Liste der Betrachter und Kommentatoren für diesen File abrufen
isShareableByEditors()BooleanBestimmt, ob Nutzer mit Bearbeitungsberechtigungen für 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()BooleanLegt fest, ob sich das File-Element im Papierkorb des Nutzers in 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.
makeCopy(name, destination)FileErstellt im Zielverzeichnis eine Kopie der Datei und gibt ihr einen 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 Bearbeiter für File.
removeEditor(user)FileEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für File.
removeViewer(emailAddress)FileEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für File.
removeViewer(user)FileEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für File.
revokePermissions(emailAddress)FileHebt den Zugriff auf die File auf, die dem jeweiligen Nutzer gewährt wurden.
revokePermissions(user)FileHebt den Zugriff auf die File auf, die dem jeweiligen Nutzer gewährt wurden.
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)FileEigentümer von File ändern
setOwner(user)FileEigentümer von File ändern
setSecurityUpdateEnabled(enabled)FileLegt fest, ob das File für den Zugriff einen Ressourcenschlüssel erfordert, wenn es ü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 Klasse von Nutzern auf File zugreifen kann und welche Berechtigungen diesen Nutzern gewährt werden, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
setStarred(starred)FileLegt fest, ob das File in der Ablage des Nutzers markiert ist.
setTrashed(trashed)FileLegt fest, ob sich das File-Element im Papierkorb des Nutzers in der Ablage 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 Datei- oder Ordnersammlung 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 der Liste der Betrachter für Folder hinzu.
createFile(blob)FileErstellt im aktuellen Ordner eine Datei aus einem gegebenen Blob mit 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 dem 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 Datum ab, an dem Folder erstellt wurde.
getDescription()StringRuft die Beschreibung für Folder ab.
getEditors()User[]Ruft die Liste der Bearbeiter für diesen 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 des Folder ab.
getOwner()UserRuft den Eigentümer von Folder ab.
getParents()FolderIteratorRuft eine Sammlung von Ordnern ab, die Folder unmittelbar übergeordnet 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 dieser Folder berechtigt ist, das Sicherheitsupdate anzuwenden, das einen Ressourcenschlüssel für den Zugriff erfordert, wenn es über einen Link freigegeben wird.
getSecurityUpdateEnabled()BooleanRuft ab, ob für diesen Folder ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird.
getSharingAccess()AccessRuft ab, welche Klasse von Nutzern auf Folder zugreifen kann, ausgenommen einzelne Nutzer, denen explizit Zugriff gewährt wurde.
getSharingPermission()PermissionRuft die Berechtigung für die Nutzer ab, die auf Folder zugreifen können, ausgenommen einzelne Nutzer, denen explizit Zugriff gewährt wurde.
getSize()IntegerRuft die Anzahl der Byte ab, die zum Speichern von Folder in Drive verwendet werden.
getUrl()StringRuft die URL ab, mit der Folder in einer Google-App wie Drive oder Docs geöffnet werden kann.
getViewers()User[]Liste der Betrachter und Kommentatoren für diesen Folder abrufen
isShareableByEditors()BooleanBestimmt, ob Nutzer mit Bearbeitungsberechtigungen für 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()BooleanLegt fest, ob sich das Folder-Element im Papierkorb des Nutzers in der Ablage des Nutzers befindet.
moveTo(destination)FolderVerschiebt dieses 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)FolderEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Folder.
removeViewer(user)FolderEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Folder.
revokePermissions(emailAddress)FolderHebt den Zugriff auf die Folder auf, die dem jeweiligen Nutzer gewährt wurden.
revokePermissions(user)FolderHebt den Zugriff auf die Folder auf, die dem jeweiligen Nutzer gewährt wurden.
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)FolderEigentümer von Folder ändern
setOwner(user)FolderEigentümer von Folder ändern
setSecurityUpdateEnabled(enabled)FolderLegt fest, ob das Folder für den Zugriff einen Ressourcenschlüssel erfordert, wenn es ü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 Klasse von Nutzern auf Folder zugreifen kann und welche Berechtigungen diesen Nutzern gewährt werden, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
setStarred(starred)FolderLegt fest, ob das Folder in der Ablage des Nutzers markiert ist.
setTrashed(trashed)FolderLegt fest, ob sich das Folder-Element im Papierkorb des Nutzers in der Ablage 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 Datei- oder Ordnersammlung ab.

Permission

Attribute

PropertyTypBeschreibung
VIEWEnumNutzer, die Zugriff auf die Datei oder den Ordner haben, können die Datei oder den Ordner nur ansehen oder kopieren.
EDITEnumNutzer, die Zugriff auf die Datei oder den Ordner haben, können sie auch bearbeiten.
COMMENTEnumNutzer mit Zugriff auf die Datei oder den Ordner können die Datei oder den Ordner nur ansehen, kopieren und kommentieren.
OWNEREnumDer Nutzer ist Eigentümer der Datei oder des Ordners.
ORGANIZEREnumNutzer, die Dateien und Ordner in einer geteilten Ablage organisieren dürfen.
FILE_ORGANIZEREnumNutzer, die Inhalte innerhalb einer geteilten Ablage bearbeiten, in den Papierkorb verschieben und in den Papierkorb verschieben dürfen.
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.