Drive Service

Drive

Mit diesem Dienst können Skripts Dateien und Ordner in Google Drive erstellen, suchen und ändern. Der integrierte Drive-Dienst ist zwar einfacher zu verwenden, hat aber einige Einschränkungen. Wenn Sie die neuesten Funktionen und den neuesten Support nutzen und auf Dateien oder Ordner in geteilten Ablagen zugreifen möchten, verwenden Sie den erweiterten Drive-Dienst.

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

Drive API aktivieren

Das folgende Codebeispiel zeigt, wie Sie die Namen jeder Datei im Ordner „Meine Ablage“ des Nutzers protokollieren:
// 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
AccessEine Enumeration, die Nutzerklassen darstellt, die neben einzelnen Nutzern, denen explizit Zugriff gewährt wurde, auf eine Datei oder einen Ordner zugreifen können.
DriveAppErmöglicht es Scripts, Dateien und Ordner in Google Drive zu erstellen, zu suchen und zu ändern.
FileEine Datei in Google Drive
FileIteratorEin Iterator, mit dem in Skripts über eine potenziell große Sammlung von Dateien iteriert werden kann.
FolderEin Ordner in Google Drive.
FolderIteratorEin Objekt, mit dem Skripts eine potenziell große Sammlung von Ordnern durchlaufen können.
PermissionEin Enum, das die Berechtigungen darstellt, die Nutzern gewährt werden, die auf eine Datei oder einen Ordner zugreifen können, abgesehen von einzelnen Nutzern, 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, darf das Element öffnen.
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
AccessAccessEine Enumeration, die Nutzerklassen darstellt, die neben einzelnen Nutzern, denen explizit Zugriff gewährt wurde, auf eine Datei oder einen Ordner zugreifen können.
PermissionPermissionEin Enum, das die Berechtigungen darstellt, die Nutzern gewährt werden, die auf eine Datei oder einen Ordner zugreifen können, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.

Methoden

MethodeRückgabetypKurzbeschreibung
continueFileIterator(continuationToken)FileIteratorSetzt eine Dateiiteration mit einem Fortsetzungstoken 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-Kontos des Nutzers aus einem bestimmten 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 des Nutzers in Drive mit dem angegebenen Namen, Inhalt und MIME-Typ.
createFolder(name)FolderErstellt einen Ordner im Stammverzeichnis des Drive 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 angegebenen 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 Elementen 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 im Drive des Nutzers ab.
getFilesByName(name)FileIteratorRuft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Namen haben.
getFilesByType(mimeType)FileIteratorRuft eine Sammlung aller Dateien im Drive 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 angegebenen Ressourcenschlüssel ab.
getFolders()FolderIteratorRuft eine Sammlung aller Ordner im Drive des Nutzers ab.
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner im Drive des Nutzers ab, die den angegebenen Namen haben.
getRootFolder()FolderRuft den Ordner im Stammverzeichnis des Drive des Nutzers ab.
getStorageLimit()IntegerGibt die Anzahl der Byte zurück, die der Nutzer in Drive speichern darf.
getStorageUsed()IntegerGibt die Anzahl der Byte zurück, die der Nutzer derzeit in Drive speichert.
getTrashedFiles()FileIteratorRuft eine Sammlung aller Dateien im Papierkorb des Drive-Kontos des Nutzers ab.
getTrashedFolders()FolderIteratorRuft eine Sammlung aller Ordner im Papierkorb des Drive-Kontos des Nutzers ab.
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien in der Ablage 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ü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 Nutzer-Array 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 Nutzer-Array der Liste der Bearbeiter für File hinzu.
addViewer(emailAddress)FileFügt den angegebenen Nutzer der Liste der Zuschauer für File hinzu.
addViewer(user)FileFügt den angegebenen Nutzer der Liste der Zuschauer für File hinzu.
addViewers(emailAddresses)FileFügt das angegebene Nutzer-Array der Liste der Betrachter für File 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, das in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getDateCreated()DateGibt das Datum zurück, an dem File erstellt wurde.
getDescription()StringRuft die Beschreibung für die File ab.
getDownloadUrl()StringRuft die URL ab, die zum Herunterladen der Datei verwendet werden kann.
getEditors()User[]Ruft die Liste der Mitbearbeiter für diese File ab.
getId()StringRuft die ID des File ab.
getLastUpdated()DateGibt das Datum zurück, 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 unmittelbar übergeordnete Elemente von File sind.
getResourceKey()StringRuft den Ressourcenschlüssel des File ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden.
getSecurityUpdateEligible()BooleanGibt an, ob für dieses File das Sicherheitsupdate angewendet werden kann, für das ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn es über einen Link freigegeben wird.
getSecurityUpdateEnabled()BooleanGibt an, ob für den Zugriff auf diese File ein Ressourcenschlüssel erforderlich ist, wenn sie über einen Link freigegeben wird.
getSharingAccess()AccessRuft ab, welche Nutzerklasse auf die File zugreifen kann, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
getSharingPermission()PermissionRuft die Berechtigung ab, die Nutzern mit Zugriff auf File gewährt wird, mit Ausnahme von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
getSize()IntegerGibt die Anzahl der Byte zurück, die zum Speichern des File in Drive verwendet werden.
getTargetId()StringWenn es sich um eine Verknüpfung handelt, wird die ID des Elements zurückgegeben, auf das sie verweist.
getTargetMimeType()StringWenn es sich um eine Verknüpfung handelt, wird der MIME-Typ des Elements zurückgegeben, auf das sie verweist.
getTargetResourceKey()StringWenn die Datei eine Verknüpfung ist, wird der Ressourcenschlüssel des Elements zurückgegeben, auf das sie verweist.
getThumbnail()Blob|nullRuft eine Miniaturansicht für die Datei ab oder null, wenn keine Miniaturansicht vorhanden ist.
getUrl()StringRuft die URL ab, 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 Datei für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
isStarred()BooleanGibt an, ob das File in Google Drive des Nutzers mit einem Sternchen markiert wurde.
isTrashed()BooleanGibt an, 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 dieses Element in den angegebenen Zielordner.
removeCommenter(emailAddress)FileEntfernt den angegebenen Nutzer aus der Liste der Kommentatoren für die File.
removeCommenter(user)FileEntfernt den angegebenen Nutzer aus der Liste der Kommentatoren für die File.
removeEditor(emailAddress)FileEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die File.
removeEditor(user)FileEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die File.
removeViewer(emailAddress)FileEntfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die File.
removeViewer(user)FileEntfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die File.
revokePermissions(emailAddress)FileWiderruft den Zugriff auf File, der dem angegebenen Nutzer gewährt wurde.
revokePermissions(user)FileWiderruft den Zugriff auf File, der dem angegebenen Nutzer gewährt wurde.
setContent(content)FileÜberschreibt den Inhalt der Datei mit einem angegebenen Ersatz.
setDescription(description)FileLegt die Beschreibung für File fest.
setName(name)FileLegt den Namen des 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 Zugriff auf File ein Ressourcenschlüssel erforderlich ist, wenn die Datei über einen Link freigegeben wird.
setShareableByEditors(shareable)FileGibt an, ob Nutzer mit Bearbeitungsberechtigungen für die File die Datei für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
setSharing(accessType, permissionType)FileLegt fest, welche Nutzerklasse auf File zugreifen kann und welche Berechtigungen diesen Nutzern erteilt werden, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
setStarred(starred)FileLegt fest, ob die File in Google Drive des Nutzers mit einem Sternchen markiert ist.
setTrashed(trashed)FileLegt fest, ob sich die File im Papierkorb des Drive-Kontos des Nutzers befindet.

FileIterator

Methoden

MethodeRückgabetypKurzbeschreibung
getContinuationToken()StringRuft ein Token ab, das verwendet werden kann, um diese Iteration zu einem späteren Zeitpunkt fortzusetzen.
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 Nutzer-Array der Liste der Bearbeiter für Folder hinzu.
addViewer(emailAddress)FolderFügt den angegebenen Nutzer der Liste der Zuschauer für Folder hinzu.
addViewer(user)FolderFügt den angegebenen Nutzer der Liste der Zuschauer für Folder hinzu.
addViewers(emailAddresses)FolderFügt das angegebene Nutzer-Array der Liste der Betrachter für Folder hinzu.
createFile(blob)FileErstellt eine Datei im aktuellen Ordner aus einem angegebenen Blob mit beliebigen Daten.
createFile(name, content)FileErstellt im aktuellen Ordner eine Textdatei 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 zur angegebenen Drive-Element-ID und zum angegebenen 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()DateGibt das Datum zurück, an dem 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 untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Namen haben.
getFilesByType(mimeType)FileIteratorRuft eine Sammlung aller Dateien ab, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen MIME-Typ haben.
getFolders()FolderIteratorRuft eine Sammlung aller Ordner ab, die untergeordnete Elemente des aktuellen Ordners sind.
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner ab, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Namen haben.
getId()StringRuft die ID des Folder ab.
getLastUpdated()DateGibt das Datum zurück, an dem Folder zuletzt aktualisiert wurde.
getName()StringRuft den Namen des Folder ab.
getOwner()UserRuft den Eigentümer dieses Folder ab.
getParents()FolderIteratorRuft eine Sammlung von Ordnern ab, die unmittelbar übergeordnete Elemente von Folder sind.
getResourceKey()StringRuft den Ressourcenschlüssel des Folder ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden.
getSecurityUpdateEligible()BooleanGibt an, ob für dieses Folder das Sicherheitsupdate angewendet werden kann, für das ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn es über einen Link freigegeben wird.
getSecurityUpdateEnabled()BooleanGibt an, ob für den Zugriff auf diese Folder ein Ressourcenschlüssel erforderlich ist, wenn sie über einen Link freigegeben wird.
getSharingAccess()AccessRuft ab, welche Nutzerklasse auf die Folder zugreifen kann, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
getSharingPermission()PermissionRuft die Berechtigung ab, die Nutzern mit Zugriff auf Folder gewährt wird, mit Ausnahme von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
getSize()IntegerGibt die Anzahl der Byte zurück, die zum Speichern des Folder in Drive verwendet werden.
getUrl()StringRuft die URL ab, 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 Datei für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
isStarred()BooleanGibt an, ob das Folder in Google Drive des Nutzers mit einem Sternchen markiert wurde.
isTrashed()BooleanGibt an, ob sich die Folder im Papierkorb des Drive-Kontos 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 die Folder.
removeEditor(user)FolderEntfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die Folder.
removeViewer(emailAddress)FolderEntfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Folder.
removeViewer(user)FolderEntfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Folder.
revokePermissions(emailAddress)FolderWiderruft den Zugriff auf Folder, der dem angegebenen Nutzer gewährt wurde.
revokePermissions(user)FolderWiderruft den Zugriff auf Folder, der dem angegebenen Nutzer gewährt wurde.
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 untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Suchkriterien entsprechen.
setDescription(description)FolderLegt die Beschreibung für Folder fest.
setName(name)FolderLegt den Namen des 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 Zugriff auf Folder ein Ressourcenschlüssel erforderlich ist, wenn die Datei über einen Link freigegeben wird.
setShareableByEditors(shareable)FolderGibt an, ob Nutzer mit Bearbeitungsberechtigungen für die Folder die Datei für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.
setSharing(accessType, permissionType)FolderLegt fest, welche Nutzerklasse auf Folder zugreifen kann und welche Berechtigungen diesen Nutzern erteilt werden, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
setStarred(starred)FolderLegt fest, ob die Folder in Google Drive des Nutzers mit einem Sternchen markiert ist.
setTrashed(trashed)FolderLegt fest, ob sich die Folder im Papierkorb des Drive-Kontos des Nutzers befindet.

FolderIterator

Methoden

MethodeRückgabetypKurzbeschreibung
getContinuationToken()StringRuft ein Token ab, das verwendet werden kann, um diese Iteration zu einem späteren Zeitpunkt fortzusetzen.
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 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()String|nullRuft den Domainnamen ab, der mit dem Konto des Nutzers verknüpft ist.
getEmail()String|nullRuft die E-Mail-Adresse des Nutzers ab.
getName()String|nullRuft den Namen des Nutzers ab.
getPhotoUrl()String|nullRuft die URL für das Foto des Nutzers ab.