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:
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
Name | Kurzbeschreibung |
---|---|
Access | Ein 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. |
DriveApp | Ermöglicht es Scripts, Dateien und Ordner in Google Drive zu erstellen, zu finden und zu ändern. |
File | Eine Datei in Google Drive. |
FileIterator | Ein Iterator, mit dem Scripts eine potenziell große Sammlung von Dateien durchgehen können. |
Folder | Einen Ordner in Google Drive. |
FolderIterator | Ein Objekt, mit dem Scripts eine potenziell große Sammlung von Ordnern durchlaufen können. |
Permission | Ein 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. |
User | Ein Nutzer, der mit einer Datei in Google Drive verknüpft ist. |
Access
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
ANYONE | Enum | Jeder im Internet ist zur Suche und zum Zugriff berechtigt. |
ANYONE_WITH_LINK | Enum | Jeder, der über den Link verfügt, ist zum Zugriff berechtigt. |
DOMAIN | Enum | Nutzer in Ihrer Domain können die Datei suchen und darauf zugreifen. |
DOMAIN_WITH_LINK | Enum | Nutzer in Ihrer Domain, die über den Link verfügen, sind zum Zugriff berechtigt. |
PRIVATE | Enum | Nur Personen, denen die entsprechende Berechtigung ausdrücklich erteilt wurde, sind zum Zugriff befugt. |
DriveApp
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
Access | Access | Ein 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. |
Permission | Permission | Ein 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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | Setzt eine Dateiiteration mit einem Fortsetzungstoken aus einem vorherigen Iterator fort. |
continueFolderIterator(continuationToken) | FolderIterator | Eine Ordneriteration wird mit einem Fortsetzungstoken aus einem vorherigen Iterator fortgesetzt. |
createFile(blob) | File | Erstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers aus einer bestimmten Blob mit beliebigen Daten. |
createFile(name, content) | File | Erstellt eine Textdatei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen und Inhalt. |
createFile(name, content, mimeType) | File | Erstellt eine Datei im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen, Inhalt und MIME-Typ. |
createFolder(name) | Folder | Erstellt einen Ordner im Stammverzeichnis des Drive-Ordners des Nutzers mit dem angegebenen Namen. |
createShortcut(targetId) | File | Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Erstellt eine Verknüpfung mit der angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück. |
enforceSingleParent(value) | void | Aktiviert oder deaktiviert das Verhalten „enforceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente von Artikeln auswirken. |
getFileById(id) | File | Ruft die Datei mit der angegebenen ID ab. |
getFileByIdAndResourceKey(id, resourceKey) | File | Ruft die Datei mit der angegebenen ID und dem Ressourcenschlüssel ab. |
getFiles() | FileIterator | Eine Sammlung aller Dateien im Drive des Nutzers wird abgerufen. |
getFilesByName(name) | FileIterator | Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Namen haben. |
getFilesByType(mimeType) | FileIterator | Stellt eine Sammlung aller Dateien im Drive des Nutzers mit dem angegebenen MIME-Typ bereit. |
getFolderById(id) | Folder | Ruft den Ordner mit der angegebenen ID ab. |
getFolderByIdAndResourceKey(id, resourceKey) | Folder | Ruft den Ordner mit der angegebenen ID und dem Ressourcenschlüssel ab. |
getFolders() | FolderIterator | Eine Sammlung aller Ordner im Drive des Nutzers wird abgerufen. |
getFoldersByName(name) | FolderIterator | Ruft eine Sammlung aller Ordner im Drive des Nutzers mit dem angegebenen Namen ab. |
getRootFolder() | Folder | Ruft den Ordner im Stammverzeichnis des Drive-Ordners des Nutzers ab. |
getStorageLimit() | Integer | Ruft die Anzahl der Byte ab, die der Nutzer in Drive speichern darf. |
getStorageUsed() | Integer | Die Anzahl der Byte, die der Nutzer derzeit in Drive speichert. |
getTrashedFiles() | FileIterator | Stellt eine Sammlung aller Dateien im Papierkorb des Nutzers in Google Drive bereit. |
getTrashedFolders() | FolderIterator | Hiermit wird eine Sammlung aller Ordner im Papierkorb des Drive-Kontos des Nutzers abgerufen. |
searchFiles(params) | FileIterator | Ruft eine Sammlung aller Dateien im Drive des Nutzers ab, die den angegebenen Suchkriterien entsprechen. |
searchFolders(params) | FolderIterator | Stellt eine Sammlung aller Ordner im Drive des Nutzers zurück, die den angegebenen Suchkriterien entsprechen. |
File
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addCommenter(emailAddress) | File | Fügen Sie den angegebenen Nutzer der Liste der Kommentatoren für die File hinzu. |
addCommenter(user) | File | Fügen Sie den angegebenen Nutzer der Liste der Kommentatoren für die File hinzu. |
addCommenters(emailAddresses) | File | Füge der Liste der Kommentatoren für die File das angegebene Array von Nutzern hinzu. |
addEditor(emailAddress) | File | Der angegebene Nutzer wird der Liste der Mitbearbeiter für die File hinzugefügt. |
addEditor(user) | File | Der angegebene Nutzer wird der Liste der Mitbearbeiter für die File hinzugefügt. |
addEditors(emailAddresses) | File | Fügt der Liste der Mitbearbeiter für die File das angegebene Nutzerarray hinzu. |
addViewer(emailAddress) | File | Der angegebene Nutzer wird der Liste der Zuschauer für die File hinzugefügt. |
addViewer(user) | File | Der angegebene Nutzer wird der Liste der Zuschauer für die File hinzugefügt. |
addViewers(emailAddresses) | File | Fügen Sie der Liste der Zuschauer für die File das angegebene Array von Nutzern hinzu. |
getAccess(email) | Permission | Ruft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde. |
getAccess(user) | Permission | Ruft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde. |
getAs(contentType) | Blob | Gibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde. |
getBlob() | Blob | Gibt die Daten in diesem Objekt als Blob zurück. |
getDateCreated() | Date | Das Datum, an dem die File erstellt wurde. |
getDescription() | String | Ruft die Beschreibung für die File ab. |
getDownloadUrl() | String | Ruft die URL ab, über die die Datei heruntergeladen werden kann. |
getEditors() | User[] | Ruft die Liste der Mitbearbeiter für diese File ab. |
getId() | String | Ruft die ID der File ab. |
getLastUpdated() | Date | Das Datum, an dem die File zuletzt aktualisiert wurde. |
getMimeType() | String | Ruft den MIME-Typ der Datei ab. |
getName() | String | Ruft den Namen der File ab. |
getOwner() | User | Ruft den Eigentümer der Datei ab. |
getParents() | FolderIterator | Hiermit wird eine Sammlung von Ordnern abgerufen, die unmittelbar übergeordnete Elemente von File sind. |
getResourceKey() | String | Ruft den Ressourcenschlüssel der File ab, der zum Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden. |
getSecurityUpdateEligible() | Boolean | Gibt 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() | Boolean | Gibt an, ob für diese File ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn sie über einen Link freigegeben wird. |
getSharingAccess() | Access | Gibt an, welche Nutzergruppe neben einzelnen Nutzern, denen explizit Zugriff gewährt wurde, auf das File zugreifen kann. |
getSharingPermission() | Permission | Ruft 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() | Integer | Die Anzahl der Byte, die zum Speichern der File in Drive verwendet werden. |
getTargetId() | String | Wenn es sich um einen Verknüpfung handelt, wird die ID des Elements zurückgegeben, auf das sie verweist. |
getTargetMimeType() | String | Wenn es sich um einen Verknüpfung handelt, wird der MIME-Typ des Elements zurückgegeben, auf das sie verweist. |
getTargetResourceKey() | String | Wenn es sich bei der Datei um einen Verknüpfung handelt, wird der Ressourcenschlüssel des Elements zurückgegeben, auf das sie verweist. |
getThumbnail() | Blob | Hier wird ein Thumbnail-Bild für die Datei abgerufen oder null , wenn kein Thumbnail vorhanden ist. |
getUrl() | String | Die 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() | Boolean | Bestimmt, ob Nutzer mit Bearbeitungsberechtigungen für die File die Inhalte für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
isStarred() | Boolean | Gibt an, ob die File im Drive des Nutzers mit einem Stern markiert wurde. |
isTrashed() | Boolean | Bestimmt, ob sich die File im Papierkorb des Nutzers in Google Drive befindet. |
makeCopy() | File | Erstellt eine Kopie der Datei. |
makeCopy(destination) | File | Erstellt eine Kopie der Datei im Zielverzeichnis. |
makeCopy(name) | File | Erstellt eine Kopie der Datei und benennt sie mit dem angegebenen Namen. |
makeCopy(name, destination) | File | Erstellt eine Kopie der Datei im Zielverzeichnis und benennt sie mit dem angegebenen Namen. |
moveTo(destination) | File | Verschiebt dieses Element in den angegebenen Zielordner. |
removeCommenter(emailAddress) | File | Der angegebene Nutzer wird aus der Liste der Kommentatoren für die File entfernt. |
removeCommenter(user) | File | Der angegebene Nutzer wird aus der Liste der Kommentatoren für die File entfernt. |
removeEditor(emailAddress) | File | Der angegebene Nutzer wird aus der Liste der Mitbearbeiter der File entfernt. |
removeEditor(user) | File | Der angegebene Nutzer wird aus der Liste der Mitbearbeiter der File entfernt. |
removeViewer(emailAddress) | File | Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die File entfernt. |
removeViewer(user) | File | Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die File entfernt. |
revokePermissions(emailAddress) | File | Hiermit wird der dem Nutzer gewährte Zugriff auf File widerrufen. |
revokePermissions(user) | File | Hiermit wird der dem Nutzer gewährte Zugriff auf File widerrufen. |
setContent(content) | File | Überschreibt den Inhalt der Datei mit einem bestimmten Ersatz. |
setDescription(description) | File | Legt die Beschreibung für die File fest. |
setName(name) | File | Legt den Namen der File fest. |
setOwner(emailAddress) | File | Ändert den Inhaber der File . |
setOwner(user) | File | Ändert den Inhaber der File . |
setSecurityUpdateEnabled(enabled) | File | Legt fest, ob für den Zugriff auf die File ein Ressourcenschlüssel erforderlich ist, wenn sie über einen Link freigegeben wird. |
setShareableByEditors(shareable) | File | Hier 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) | File | Hier 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) | File | Gibt an, ob die File im Drive des Nutzers mit einem Stern markiert ist. |
setTrashed(trashed) | File | Gibt an, ob sich die File im Papierkorb des Drive-Kontos des Nutzers befindet. |
FileIterator
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getContinuationToken() | String | Ruft ein Token ab, mit dem diese Iteration zu einem späteren Zeitpunkt fortgesetzt werden kann. |
hasNext() | Boolean | Bestimmt, ob beim Aufrufen von next() ein Element zurückgegeben wird. |
next() | File | Ruft das nächste Element in der Sammlung von Dateien oder Ordnern ab. |
Folder
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addEditor(emailAddress) | Folder | Der angegebene Nutzer wird der Liste der Mitbearbeiter für die Folder hinzugefügt. |
addEditor(user) | Folder | Der angegebene Nutzer wird der Liste der Mitbearbeiter für die Folder hinzugefügt. |
addEditors(emailAddresses) | Folder | Fügt der Liste der Mitbearbeiter für die Folder das angegebene Nutzerarray hinzu. |
addViewer(emailAddress) | Folder | Der angegebene Nutzer wird der Liste der Zuschauer für die Folder hinzugefügt. |
addViewer(user) | Folder | Der angegebene Nutzer wird der Liste der Zuschauer für die Folder hinzugefügt. |
addViewers(emailAddresses) | Folder | Fügen Sie der Liste der Zuschauer für die Folder das angegebene Array von Nutzern hinzu. |
createFile(blob) | File | Erstellt eine Datei im aktuellen Ordner aus einer angegebenen Blob mit beliebigen Daten. |
createFile(name, content) | File | Erstellt eine Textdatei im aktuellen Ordner mit dem angegebenen Namen und Inhalt. |
createFile(name, content, mimeType) | File | Erstellt eine Datei im aktuellen Ordner mit dem angegebenen Namen, Inhalt und MIME-Typ. |
createFolder(name) | Folder | Erstellt im aktuellen Ordner einen Ordner mit dem angegebenen Namen. |
createShortcut(targetId) | File | Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Erstellt eine Verknüpfung mit der angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück. |
getAccess(email) | Permission | Ruft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde. |
getAccess(user) | Permission | Ruft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde. |
getDateCreated() | Date | Das Datum, an dem die Folder erstellt wurde. |
getDescription() | String | Ruft die Beschreibung für die Folder ab. |
getEditors() | User[] | Ruft die Liste der Mitbearbeiter für diese Folder ab. |
getFiles() | FileIterator | Ruft eine Sammlung aller Dateien ab, die untergeordnete Elemente des aktuellen Ordners sind. |
getFilesByName(name) | FileIterator | Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben. |
getFilesByType(mimeType) | FileIterator | Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen MIME-Typ haben. |
getFolders() | FolderIterator | Ruft eine Sammlung aller Ordner ab, die untergeordnet zum aktuellen Ordner sind. |
getFoldersByName(name) | FolderIterator | Ruft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben. |
getId() | String | Ruft die ID der Folder ab. |
getLastUpdated() | Date | Das Datum, an dem die Folder zuletzt aktualisiert wurde. |
getName() | String | Ruft den Namen der Folder ab. |
getOwner() | User | Ruft den Eigentümer dieser Folder ab. |
getParents() | FolderIterator | Hiermit wird eine Sammlung von Ordnern abgerufen, die unmittelbar übergeordnete Elemente von Folder sind. |
getResourceKey() | String | Ruft den Ressourcenschlüssel der Folder ab, der zum Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden. |
getSecurityUpdateEligible() | Boolean | Gibt 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() | Boolean | Gibt an, ob für diese Folder ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn sie über einen Link freigegeben wird. |
getSharingAccess() | Access | Gibt an, welche Nutzergruppe neben einzelnen Nutzern, denen explizit Zugriff gewährt wurde, auf das Folder zugreifen kann. |
getSharingPermission() | Permission | Ruft 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() | Integer | Die Anzahl der Byte, die zum Speichern der Folder in Drive verwendet werden. |
getUrl() | String | Die 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() | Boolean | Bestimmt, ob Nutzer mit Bearbeitungsberechtigungen für die Folder die Inhalte für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
isStarred() | Boolean | Gibt an, ob die Folder im Drive des Nutzers mit einem Stern markiert wurde. |
isTrashed() | Boolean | Bestimmt, ob sich die Folder im Papierkorb des Nutzers in Google Drive befindet. |
moveTo(destination) | Folder | Verschiebt dieses Element in den angegebenen Zielordner. |
removeEditor(emailAddress) | Folder | Der angegebene Nutzer wird aus der Liste der Mitbearbeiter der Folder entfernt. |
removeEditor(user) | Folder | Der angegebene Nutzer wird aus der Liste der Mitbearbeiter der Folder entfernt. |
removeViewer(emailAddress) | Folder | Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Folder entfernt. |
removeViewer(user) | Folder | Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Folder entfernt. |
revokePermissions(emailAddress) | Folder | Hiermit wird der dem Nutzer gewährte Zugriff auf Folder widerrufen. |
revokePermissions(user) | Folder | Hiermit wird der dem Nutzer gewährte Zugriff auf Folder widerrufen. |
searchFiles(params) | FileIterator | Ruft eine Sammlung aller Dateien ab, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Suchkriterien entsprechen. |
searchFolders(params) | FolderIterator | Ruft eine Sammlung aller Ordner ab, die untergeordnet zum aktuellen Ordner sind und den angegebenen Suchkriterien entsprechen. |
setDescription(description) | Folder | Legt die Beschreibung für die Folder fest. |
setName(name) | Folder | Legt den Namen der Folder fest. |
setOwner(emailAddress) | Folder | Ändert den Inhaber der Folder . |
setOwner(user) | Folder | Ändert den Inhaber der Folder . |
setSecurityUpdateEnabled(enabled) | Folder | Legt fest, ob für den Zugriff auf die Folder ein Ressourcenschlüssel erforderlich ist, wenn sie über einen Link freigegeben wird. |
setShareableByEditors(shareable) | Folder | Hier 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) | Folder | Hier 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) | Folder | Gibt an, ob die Folder im Drive des Nutzers mit einem Stern markiert ist. |
setTrashed(trashed) | Folder | Gibt an, ob sich die Folder im Papierkorb des Drive-Kontos des Nutzers befindet. |
FolderIterator
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getContinuationToken() | String | Ruft ein Token ab, mit dem diese Iteration zu einem späteren Zeitpunkt fortgesetzt werden kann. |
hasNext() | Boolean | Bestimmt, ob beim Aufrufen von next() ein Element zurückgegeben wird. |
next() | Folder | Ruft das nächste Element in der Sammlung von Dateien oder Ordnern ab. |
Permission
Attribute
Attribut | Typ | Beschreibung |
---|---|---|
VIEW | Enum | Nutzer, die auf die Datei oder den Ordner zugreifen können, können sie nur aufrufen oder kopieren. |
EDIT | Enum | Nutzer, die auf die Datei oder den Ordner zugreifen können, können sie bearbeiten. |
COMMENT | Enum | Nutzer, die auf die Datei oder den Ordner zugreifen können, können sie nur ansehen, kopieren oder kommentieren. |
OWNER | Enum | Der Nutzer ist der Eigentümer der Datei oder des Ordners. |
ORGANIZER | Enum | Nutzer, die Dateien und Ordner in einer geteilten Ablage organisieren können. |
FILE_ORGANIZER | Enum | Nutzer, die Inhalte in einer geteilten Ablage bearbeiten, in den Papierkorb verschieben und verschieben können. |
NONE | Enum | Der Nutzer hat keine Berechtigungen für die Datei oder den Ordner. |
User
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getDomain() | String | Der Domainname, der mit dem Konto des Nutzers verknüpft ist. |
getEmail() | String | Ruft die E-Mail-Adresse des Nutzers ab. |
getName() | String | Der Name des Nutzers. |
getPhotoUrl() | String | Die URL für das Foto des Nutzers. |