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:
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
Name | Kurzbeschreibung |
---|---|
Access | Ein 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. |
DriveApp | Damit können Skripts Dateien und Ordner in Google Drive erstellen, suchen und ändern. |
File | Eine Datei in Google Drive |
FileIterator | Ein Iterator, der Skripts die Iteration über eine potenziell große Sammlung von Dateien ermöglicht. |
Folder | Ein Ordner in Google Drive. |
FolderIterator | Ein Objekt, das Skripts die Iteration über eine potenziell große Sammlung von Ordnern ermöglicht. |
Permission | Ein 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. |
User | Ein Nutzer, der mit einer Datei in Google Drive verknüpft ist. |
Access
Attribute
Property | 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 | Personen in Ihrer Domain sind zur Suche und zum Zugriff berechtigt. |
DOMAIN_WITH_LINK | Enum | Personen 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
Property | Typ | Beschreibung |
---|---|---|
Access | Access | Ein 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. |
Permission | Permission | Ein 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
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | Setzt eine Dateiiteration mit einem Fortsetzungstoken von einem vorherigen Iteration fort. |
continueFolderIterator(continuationToken) | FolderIterator | Setzt eine Ordneriteration mit einem Fortsetzungstoken von einem vorherigen Iteration fort. |
createFile(blob) | File | Erstellt eine Datei im Stammverzeichnis der Ablage des Nutzers aus einem gegebenen Blob beliebiger Daten. |
createFile(name, content) | File | Erstellt im Stammverzeichnis der Ablage des Nutzers eine Textdatei mit dem angegebenen Namen und Inhalt. |
createFile(name, content, mimeType) | File | Erstellt im Stammverzeichnis der Ablage des Nutzers eine Datei mit dem angegebenen Namen, den angegebenen Inhalten und dem angegebenen MIME-Typ. |
createFolder(name) | Folder | Erstellt im Stammverzeichnis der Ablage des Nutzers 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 zur angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück. |
enforceSingleParent(value) | void | Aktiviert oder deaktiviert die Funktion „ForceSingleParent“ für alle Aufrufe, die sich auf übergeordnete Elemente 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 | Ruft eine Sammlung aller Dateien im Google Drive-Konto des Nutzers ab. |
getFilesByName(name) | FileIterator | Ruft eine Sammlung aller Dateien im Google Drive des Nutzers ab, die den angegebenen Namen haben. |
getFilesByType(mimeType) | FileIterator | Ruft eine Sammlung aller Dateien im Drive-Konto des Nutzers ab, die den angegebenen MIME-Typ haben. |
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 | Ruft eine Sammlung aller Ordner in der Ablage des Nutzers ab. |
getFoldersByName(name) | FolderIterator | Ruft eine Sammlung aller Ordner im Google Drive des Nutzers ab, die den angegebenen Namen haben. |
getRootFolder() | Folder | Ordner im Stammverzeichnis der Ablage des Nutzers abrufen |
getStorageLimit() | Integer | Ruft die Anzahl der Byte ab, die der Nutzer in Google Drive speichern darf. |
getStorageUsed() | Integer | Ruft die Anzahl der Byte ab, die der Nutzer derzeit in Drive speichert. |
getTrashedFiles() | FileIterator | Ruft eine Sammlung aller Dateien im Papierkorb des Nutzers in Google Drive ab. |
getTrashedFolders() | FolderIterator | Ruft eine Sammlung aller Ordner im Papierkorb des Nutzers in Google Drive ab. |
searchFiles(params) | FileIterator | Ruft eine Sammlung aller Dateien im Drive-Ordner des Nutzers ab, die den angegebenen Suchkriterien entsprechen. |
searchFolders(params) | FolderIterator | Ruft eine Sammlung aller Ordner im Drive-Konto des Nutzers ab, 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 File hinzu. |
addCommenter(user) | File | Fügen Sie den angegebenen Nutzer der Liste der Kommentatoren für File hinzu. |
addCommenters(emailAddresses) | File | Füge das angegebene Array von Nutzern der Liste der Kommentatoren für File hinzu. |
addEditor(emailAddress) | File | Fügt den angegebenen Nutzer der Liste der Bearbeiter für File hinzu. |
addEditor(user) | File | Fügt den angegebenen Nutzer der Liste der Bearbeiter für File hinzu. |
addEditors(emailAddresses) | File | Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für File hinzu. |
addViewer(emailAddress) | File | Fügt den angegebenen Nutzer der Liste der Betrachter für File hinzu. |
addViewer(user) | File | Fügt den angegebenen Nutzer der Liste der Betrachter für File hinzu. |
addViewers(emailAddresses) | File | Fügt das angegebene Array von Nutzern der Liste der Betrachter für File hinzu. |
getAccess(email) | Permission | Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde. |
getAccess(user) | Permission | Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde. |
getAs(contentType) | Blob | Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. |
getBlob() | Blob | Gibt die Daten in diesem Objekt als Blob zurück. |
getDateCreated() | Date | Ruft das Datum ab, an dem File erstellt wurde. |
getDescription() | String | Ruft die Beschreibung für File ab. |
getDownloadUrl() | String | Ruft die URL ab, über die die Datei heruntergeladen werden kann. |
getEditors() | User[] | Ruft die Liste der Bearbeiter für diesen File ab. |
getId() | String | Ruft die ID von File ab. |
getLastUpdated() | Date | Ruft das Datum ab, an dem File zuletzt aktualisiert wurde. |
getMimeType() | String | Ruft den MIME-Typ der Datei ab. |
getName() | String | Ruft den Namen des File ab. |
getOwner() | User | Ruft den Dateieigentümer ab. |
getParents() | FolderIterator | Ruft eine Sammlung von Ordnern ab, die File unmittelbar übergeordnet sind. |
getResourceKey() | String | Ruft den Ressourcenschlüssel von File ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden. |
getSecurityUpdateEligible() | Boolean | Ruft 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() | Boolean | Ruft ab, ob für diesen File ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird. |
getSharingAccess() | Access | Ruft ab, welche Klasse von Nutzern auf File zugreifen kann, ausgenommen einzelne Nutzer, denen explizit Zugriff gewährt wurde. |
getSharingPermission() | Permission | Ruft die Berechtigung für die Nutzer ab, die auf File zugreifen können, ausgenommen einzelne Nutzer, denen explizit Zugriff gewährt wurde. |
getSize() | Integer | Ruft die Anzahl der Byte ab, die zum Speichern von File in Drive verwendet werden. |
getTargetId() | String | Bei einer Verknüpfung wird die ID des Elements zurückgegeben, auf das sie verweist. |
getTargetMimeType() | String | Wenn es sich um einen Shortcut handelt, wird der MIME-Typ des Elements zurückgegeben, auf das es verweist. |
getTargetResourceKey() | String | Wenn es sich bei der Datei um eine Verknüpfung handelt, wird der Ressourcenschlüssel des Elements zurückgegeben, auf das sie verweist. |
getThumbnail() | Blob | Ruft eine Miniaturansicht für die Datei ab oder null , wenn keine Miniaturansicht vorhanden ist. |
getUrl() | String | Ruft 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() | Boolean | Bestimmt, ob Nutzer mit Bearbeitungsberechtigungen für File Dateien für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
isStarred() | Boolean | Ermittelt, ob File in der Ablage des Nutzers markiert wurde. |
isTrashed() | Boolean | Legt fest, ob sich das File -Element im Papierkorb des Nutzers in der Ablage des Nutzers 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 gibt ihr einen Namen. |
makeCopy(name, destination) | File | Erstellt im Zielverzeichnis eine Kopie der Datei und gibt ihr einen Namen. |
moveTo(destination) | File | Verschiebt dieses Element in den angegebenen Zielordner. |
removeCommenter(emailAddress) | File | Entfernt den angegebenen Nutzer aus der Liste der Kommentatoren für File . |
removeCommenter(user) | File | Entfernt den angegebenen Nutzer aus der Liste der Kommentatoren für File . |
removeEditor(emailAddress) | File | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für File . |
removeEditor(user) | File | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für File . |
removeViewer(emailAddress) | File | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für File . |
removeViewer(user) | File | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für File . |
revokePermissions(emailAddress) | File | Hebt den Zugriff auf die File auf, die dem jeweiligen Nutzer gewährt wurden. |
revokePermissions(user) | File | Hebt 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) | File | Legt die Beschreibung für File fest. |
setName(name) | File | Legt den Namen von File fest. |
setOwner(emailAddress) | File | Eigentümer von File ändern |
setOwner(user) | File | Eigentümer von File ändern |
setSecurityUpdateEnabled(enabled) | File | Legt fest, ob das File für den Zugriff einen Ressourcenschlüssel erfordert, wenn es über einen Link freigegeben wird. |
setShareableByEditors(shareable) | File | Legt fest, ob Nutzer mit Bearbeitungsberechtigungen für File Dateien für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
setSharing(accessType, permissionType) | File | Legt 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) | File | Legt fest, ob das File in der Ablage des Nutzers markiert ist. |
setTrashed(trashed) | File | Legt fest, ob sich das File -Element im Papierkorb des Nutzers in der Ablage 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 Datei- oder Ordnersammlung ab. |
Folder
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addEditor(emailAddress) | Folder | Fügt den angegebenen Nutzer der Liste der Bearbeiter für Folder hinzu. |
addEditor(user) | Folder | Fügt den angegebenen Nutzer der Liste der Bearbeiter für Folder hinzu. |
addEditors(emailAddresses) | Folder | Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für Folder hinzu. |
addViewer(emailAddress) | Folder | Fügt den angegebenen Nutzer der Liste der Betrachter für Folder hinzu. |
addViewer(user) | Folder | Fügt den angegebenen Nutzer der Liste der Betrachter für Folder hinzu. |
addViewers(emailAddresses) | Folder | Fügt das angegebene Array von Nutzern der Liste der Betrachter für Folder hinzu. |
createFile(blob) | File | Erstellt im aktuellen Ordner eine Datei aus einem gegebenen Blob mit beliebigen Daten. |
createFile(name, content) | File | Erstellt im aktuellen Ordner eine Textdatei mit dem angegebenen Namen und Inhalt. |
createFile(name, content, mimeType) | File | Erstellt im aktuellen Ordner eine Datei 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 zur angegebenen Drive-Element-ID und dem Ressourcenschlüssel und gibt sie zurück. |
getAccess(email) | Permission | Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde. |
getAccess(user) | Permission | Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde. |
getDateCreated() | Date | Ruft das Datum ab, an dem Folder erstellt wurde. |
getDescription() | String | Ruft die Beschreibung für Folder ab. |
getEditors() | User[] | Ruft die Liste der Bearbeiter für diesen Folder ab. |
getFiles() | FileIterator | Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet 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 dem aktuellen Ordner untergeordnet 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 von Folder ab. |
getLastUpdated() | Date | Ruft das Datum ab, an dem Folder zuletzt aktualisiert wurde. |
getName() | String | Ruft den Namen des Folder ab. |
getOwner() | User | Ruft den Eigentümer von Folder ab. |
getParents() | FolderIterator | Ruft eine Sammlung von Ordnern ab, die Folder unmittelbar übergeordnet sind. |
getResourceKey() | String | Ruft den Ressourcenschlüssel von Folder ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden. |
getSecurityUpdateEligible() | Boolean | Ruft 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() | Boolean | Ruft ab, ob für diesen Folder ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird. |
getSharingAccess() | Access | Ruft ab, welche Klasse von Nutzern auf Folder zugreifen kann, ausgenommen einzelne Nutzer, denen explizit Zugriff gewährt wurde. |
getSharingPermission() | Permission | Ruft die Berechtigung für die Nutzer ab, die auf Folder zugreifen können, ausgenommen einzelne Nutzer, denen explizit Zugriff gewährt wurde. |
getSize() | Integer | Ruft die Anzahl der Byte ab, die zum Speichern von Folder in Drive verwendet werden. |
getUrl() | String | Ruft 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() | Boolean | Bestimmt, ob Nutzer mit Bearbeitungsberechtigungen für Folder Dateien für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
isStarred() | Boolean | Ermittelt, ob Folder in der Ablage des Nutzers markiert wurde. |
isTrashed() | Boolean | Legt fest, ob sich das Folder -Element im Papierkorb des Nutzers in der Ablage des Nutzers befindet. |
moveTo(destination) | Folder | Verschiebt dieses Element in den angegebenen Zielordner. |
removeEditor(emailAddress) | Folder | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Folder . |
removeEditor(user) | Folder | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Folder . |
removeViewer(emailAddress) | Folder | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Folder . |
removeViewer(user) | Folder | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Folder . |
revokePermissions(emailAddress) | Folder | Hebt den Zugriff auf die Folder auf, die dem jeweiligen Nutzer gewährt wurden. |
revokePermissions(user) | Folder | Hebt den Zugriff auf die Folder auf, die dem jeweiligen Nutzer gewährt wurden. |
searchFiles(params) | FileIterator | Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Suchkriterien entsprechen. |
searchFolders(params) | FolderIterator | Ruft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Suchkriterien entsprechen. |
setDescription(description) | Folder | Legt die Beschreibung für Folder fest. |
setName(name) | Folder | Legt den Namen von Folder fest. |
setOwner(emailAddress) | Folder | Eigentümer von Folder ändern |
setOwner(user) | Folder | Eigentümer von Folder ändern |
setSecurityUpdateEnabled(enabled) | Folder | Legt fest, ob das Folder für den Zugriff einen Ressourcenschlüssel erfordert, wenn es über einen Link freigegeben wird. |
setShareableByEditors(shareable) | Folder | Legt fest, ob Nutzer mit Bearbeitungsberechtigungen für Folder Dateien für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
setSharing(accessType, permissionType) | Folder | Legt 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) | Folder | Legt fest, ob das Folder in der Ablage des Nutzers markiert ist. |
setTrashed(trashed) | Folder | Legt fest, ob sich das Folder -Element im Papierkorb des Nutzers in der Ablage 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 Datei- oder Ordnersammlung ab. |
Permission
Attribute
Property | Typ | Beschreibung |
---|---|---|
VIEW | Enum | Nutzer, die Zugriff auf die Datei oder den Ordner haben, können die Datei oder den Ordner nur ansehen oder kopieren. |
EDIT | Enum | Nutzer, die Zugriff auf die Datei oder den Ordner haben, können sie auch bearbeiten. |
COMMENT | Enum | Nutzer mit Zugriff auf die Datei oder den Ordner können die Datei oder den Ordner nur ansehen, kopieren und kommentieren. |
OWNER | Enum | Der Nutzer ist Eigentümer der Datei oder des Ordners. |
ORGANIZER | Enum | Nutzer, die Dateien und Ordner in einer geteilten Ablage organisieren dürfen. |
FILE_ORGANIZER | Enum | Nutzer, die Inhalte innerhalb einer geteilten Ablage bearbeiten, in den Papierkorb verschieben und in den Papierkorb verschieben dürfen. |
NONE | Enum | Der Nutzer hat keine Berechtigungen für die Datei oder den Ordner. |
User
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
getDomain() | String | Ruft den Domainnamen ab, der dem Konto des Nutzers zugeordnet ist. |
getEmail() | String | Ruft die E-Mail-Adresse des Nutzers ab. |
getName() | String | Ruft den Namen des Nutzers ab. |
getPhotoUrl() | String | Ruft die URL für das Foto des Nutzers ab. |