Class Folder

Ordner

Ein Ordner in Google Drive. Ordner können über DriveApp aufgerufen oder erstellt werden. 

// Log the name of every folder in the user's Drive.
const folders = DriveApp.getFolders();
while (folders.hasNext()) {
  const folder = folders.next();
  Logger.log(folder.getName());
}

Methoden

MethodeRückgabetypKurzbeschreibung
addEditor(emailAddress)FolderFügt den angegebenen Nutzer der Liste der Bearbeiter für die Folder hinzu.
addEditor(user)FolderFügt den angegebenen Nutzer der Liste der Bearbeiter für die 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 Zuschauer für die 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 der 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.

Detaillierte Dokumentation

addEditor(emailAddress)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für die Folder hinzu. Wenn der Nutzer bereits in der Liste der Zuschauer war, wird er durch diese Methode aus der Liste entfernt.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

addEditor(user)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für die Folder hinzu. Wenn der Nutzer bereits in der Liste der Zuschauer war, wird er durch diese Methode aus der Liste entfernt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

addEditors(emailAddresses)

Fügt das angegebene Nutzer-Array der Liste der Bearbeiter für Folder hinzu. Wenn einer der Nutzer bereits in der Liste der Zuschauer war, wird er durch diese Methode aus der Liste der Zuschauer entfernt.

Parameter

NameTypBeschreibung
emailAddressesString[]Ein Array mit den E‑Mail-Adressen der Nutzer, die hinzugefügt werden sollen.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

addViewer(emailAddress)

Fügt den angegebenen Nutzer der Liste der Zuschauer für Folder hinzu. Wenn der Nutzer bereits in der Liste der Bearbeiter enthalten war, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

addViewer(user)

Fügt den angegebenen Nutzer der Liste der Zuschauer für Folder hinzu. Wenn der Nutzer bereits in der Liste der Bearbeiter enthalten war, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
userUserEine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

addViewers(emailAddresses)

Fügt das angegebene Nutzer-Array der Liste der Zuschauer für die Folder hinzu. Wenn einer der Nutzer bereits in der Liste der Bearbeiter enthalten war, hat diese Methode keine Auswirkungen auf ihn.

Parameter

NameTypBeschreibung
emailAddressesString[]Ein Array mit den E‑Mail-Adressen der Nutzer, die hinzugefügt werden sollen.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

createFile(blob)

Erstellt eine Datei im aktuellen Ordner aus einem angegebenen Blob mit beliebigen Daten.

Parameter

NameTypBeschreibung
blobBlobSourceDie Daten für die neue Datei.

Rückflug

File: Die neue Datei.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

createFile(name, content)

Erstellt im aktuellen Ordner eine Textdatei mit dem angegebenen Namen und Inhalt. Löst eine Ausnahme aus, wenn content größer als 50 MB ist. 

// Create a text file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New Text File', 'Hello, world!');

Parameter

NameTypBeschreibung
nameStringDer Name der neuen Datei.
contentStringDer Inhalt der neuen Datei.

Rückflug

File: Die neue Datei.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

createFile(name, content, mimeType)

Erstellt eine Datei im aktuellen Ordner mit dem angegebenen Namen, Inhalt und MIME-Typ. Löst eine Ausnahme aus, wenn content größer als 10 MB ist. 

// Create an HTML file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

Parameter

NameTypBeschreibung
nameStringDer Name der neuen Datei.
contentStringDer Inhalt der neuen Datei.
mimeTypeStringDer MIME-Typ der neuen Datei.

Rückflug

File: Die neue Datei.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

createFolder(name)

Erstellt im aktuellen Ordner einen Ordner mit dem angegebenen Namen.

Parameter

NameTypBeschreibung
nameStringDer Name des neuen Ordners.

Rückflug

Folder: Der neue Ordner.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

createShortcut(targetId)

Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück.

Parameter

NameTypBeschreibung
targetIdStringDie Datei-ID der Zieldatei oder des Zielordners.

Rückflug

File: Die neue Tastenkombination.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Erstellt eine Verknüpfung zur angegebenen Drive-Element-ID und zum angegebenen Ressourcenschlüssel und gibt sie zurück. Ein Ressourcenschlüssel ist ein zusätzlicher Parameter, der übergeben werden muss, um auf die Zieldatei oder den Zielordner zuzugreifen, die über einen Link freigegeben wurden. 

// Creates shortcuts for all folders in the user's drive that have a specific
// name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your
// drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and
  // returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(
      folder.getId(),
      folder.getResourceKey(),
  );
}

Parameter

NameTypBeschreibung
targetIdStringDie ID der Zieldatei oder des Zielordners.
targetResourceKeyStringDer Ressourcenschlüssel der Zieldatei oder des Zielordners.

Rückflug

File: Die neue Tastenkombination.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

getAccess(email)

Ruft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde. Die Methode unterstützt nicht die Rückgabe von Berechtigungen für eine Google-Gruppe oder von Berechtigungen, die über Google-Gruppen übernommen wurden.

Parameter

NameTypBeschreibung
emailStringDie E-Mail-Adresse des Nutzers, dessen Berechtigungen geprüft werden sollen. Google Groups werden nicht unterstützt.

Rückflug

Permission: Die dem Nutzer gewährten Berechtigungen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAccess(user)

Ruft die Berechtigung ab, die einem bestimmten Nutzer gewährt wurde. Die Methode unterstützt nicht die Rückgabe von Berechtigungen für eine Google-Gruppe oder von Berechtigungen, die über Google-Gruppen übernommen wurden.

Parameter

NameTypBeschreibung
userUserEine Darstellung des Nutzers, dessen Berechtigungen geprüft werden sollen.

Rückflug

Permission: Die dem Nutzer gewährten Berechtigungen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDateCreated()

Gibt das Datum zurück, an dem Folder erstellt wurde.

Rückflug

Date: Das Datum, an dem die Folder erstellt wurde.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDescription()

Ruft die Beschreibung für die Folder ab.

Rückflug

String – die Beschreibung für die Folder

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getEditors()

Ruft die Liste der Mitbearbeiter für diese Folder ab. Wenn der Nutzer, der das Script ausführt, keinen Bearbeitungszugriff auf Folder hat, gibt diese Methode ein leeres Array zurück. 

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of editors and logs their names to the console.
const editors = folder.getEditors();
for (const editor of editors) {
  console.log(editor.getName());
}

Rückflug

User[]: Die Liste der Bearbeiter für dieses Folder, wenn der Nutzer Bearbeitungszugriff hat, andernfalls ein leeres Array.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFiles()

Ruft eine Sammlung aller Dateien ab, die untergeordnete Elemente des aktuellen Ordners sind.

Rückflug

FileIterator: Eine Sammlung aller Dateien, die untergeordnete Elemente des aktuellen Ordners sind.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFilesByName(name)

Ruft eine Sammlung aller Dateien ab, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Namen haben.

Parameter

NameTypBeschreibung
nameStringDer Name der zu suchenden Dateien.

Rückflug

FileIterator: Eine Sammlung aller Dateien, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Namen haben.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFilesByType(mimeType)

Ruft eine Sammlung aller Dateien ab, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen MIME-Typ haben.

Parameter

NameTypBeschreibung
mimeTypeStringDer MIME-Typ der zu suchenden Dateien.

Rückflug

FileIterator – Eine Sammlung aller Dateien, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen MIME-Typ haben.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFolders()

Ruft eine Sammlung aller Ordner ab, die untergeordnete Elemente des aktuellen Ordners sind.

Rückflug

FolderIterator: Eine Sammlung aller Ordner, die untergeordnete Elemente des aktuellen Ordners sind.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFoldersByName(name)

Ruft eine Sammlung aller Ordner ab, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Namen haben.

Parameter

NameTypBeschreibung
nameStringDie Namen der zu suchenden Ordner.

Rückflug

FolderIterator: Eine Sammlung aller Ordner, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Namen haben.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getId()

Ruft die ID des Folder ab.

Rückflug

String: die ID des Folder

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getLastUpdated()

Gibt das Datum zurück, an dem Folder zuletzt aktualisiert wurde.

Rückflug

Date: Das Datum, an dem die Folder zuletzt aktualisiert wurde

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getName()

Ruft den Namen des Folder ab.

Rückflug

String – der Name der Folder

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getOwner()

Ruft den Eigentümer dieses Folder ab. 

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the owner of the folder and logs the name to the console.
const folderOwner = folder.getOwner();
console.log(folderOwner.getName());

Rückflug

User: Der Inhaber dieses Folder.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getParents()

Ruft eine Sammlung von Ordnern ab, die unmittelbar übergeordnete Elemente von Folder sind.

Rückflug

FolderIterator: Eine Sammlung von Ordnern, die die unmittelbaren übergeordneten Elemente des Folder sind.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getResourceKey()

Ruft den Ressourcenschlüssel des Folder ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden.

Rückflug

String: Der Ressourcenschlüssel der Folder.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEligible()

Gibt 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.

Für den Zugriff auf einige Dateien oder Ordner, die über einen Link freigegeben wurden, ist in Google Drive ein Ressourcenschlüssel erforderlich. Diese Änderung ist Teil eines Sicherheitsupdates. Die Aktualisierung ist standardmäßig für berechtigte Dateien und Ordner aktiviert. Mit setSecurityUpdateEnabled können Sie die Anforderung für Ressourcenschlüssel für infrage kommende Dateien aktivieren oder deaktivieren.

Weitere Informationen zum Sicherheitsupdate für Google Drive

Rückflug

Boolean: Gibt an, ob die Anforderung für den Ressourcenschlüssel für die Folder angewendet werden kann.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEnabled()

Gibt an, ob für den Zugriff auf diese Folder ein Ressourcenschlüssel erforderlich ist, wenn sie über einen Link freigegeben wird. Diese Anforderung ist für berechtigte Dateien und Ordner standardmäßig aktiviert. Mit setSecurityUpdateEnabled können Sie die Anforderung für Ressourcenschlüssel für infrage kommende Dateien aktivieren oder deaktivieren.

Weitere Informationen zum Sicherheitsupdate für Google Drive

Rückflug

Boolean: Gibt an, ob die Anforderung für den Ressourcenschlüssel für diese Folder aktiviert ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingAccess()

Ruft ab, welche Nutzerklasse auf die Folder zugreifen kann, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.

Rückflug

Access – welche Nutzerklasse auf die Folder zugreifen kann

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingPermission()

Ruft die Berechtigung ab, die Nutzern mit Zugriff auf Folder gewährt wird, mit Ausnahme von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.

Rückflug

Permission: Die Berechtigungen, die Nutzern mit Zugriff auf die Folder gewährt werden.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSize()

Gibt die Anzahl der Byte zurück, die zum Speichern des Folder in Drive verwendet werden. Dateien von Google Workspace-Anwendungen werden nicht auf die Speicherplatzlimits von Drive angerechnet und geben daher 0 Bytes zurück.

Rückflug

Integer – die Anzahl der Byte, die zum Speichern der Folder in Drive verwendet werden

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getUrl()

Ruft die URL ab, mit der die Folder in einer Google-App wie Drive oder Docs geöffnet werden kann.

Rückflug

String: Die URL, die verwendet werden kann, um dieses Folder in einer Google-App wie Drive oder Docs aufzurufen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getViewers()

Ruft die Liste der Betrachter und Kommentatoren für diese Folder ab. Wenn der Nutzer, der das Skript ausführt, keinen Bearbeitungszugriff auf Folder hat, gibt diese Methode ein leeres Array zurück. 

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (const viewer of viewers) {
  console.log(viewer.getName());
}

Rückflug

User[]: Die Liste der Betrachter und Kommentatoren für dieses Folder, wenn der Nutzer Bearbeitungszugriff hat, andernfalls ein leeres Array.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isShareableByEditors()

Bestimmt, ob Nutzer mit Bearbeitungsberechtigungen für die Folder die Datei für andere Nutzer freigeben oder die Berechtigungen ändern dürfen.

Rückflug

Boolean – true, wenn Nutzer mit Bearbeitungsberechtigungen die Berechtigungen ändern oder Inhalte für andere Nutzer freigeben dürfen, false, wenn nicht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isStarred()

Gibt an, ob das Folder in Google Drive des Nutzers mit einem Sternchen markiert wurde.

Rückflug

Boolean – true, wenn das Folder in der Ablage des Nutzers mit einem Sternchen markiert ist; false, wenn nicht

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isTrashed()

Gibt an, ob sich die Folder im Papierkorb des Drive-Kontos des Nutzers befindet.

Rückflug

Boolean – true, wenn sich die Folder im Papierkorb des Nutzers in Drive befindet; false, wenn nicht

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

moveTo(destination)

Verschiebt dieses Element in den angegebenen Zielordner.

Der aktuelle Nutzer muss der Eigentümer der Datei sein oder mindestens Bearbeitungszugriff auf den aktuellen übergeordneten Ordner des Elements haben, um das Element in den Zielordner zu verschieben.

Parameter

NameTypBeschreibung
destinationFolderDer Ordner, der das neue übergeordnete Element wird.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

removeEditor(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die Folder. Mit dieser Methode wird der Zugriff von Nutzern auf die Folder nicht blockiert, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Folder für die gesamte Domain des Nutzers freigegeben ist oder sich die Folder in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Betrachter entfernt.

Parameter

NameTypBeschreibung
emailAddressStringDie E‑Mail-Adresse des Nutzers, der entfernt werden soll.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

removeEditor(user)

Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die Folder. Mit dieser Methode wird der Zugriff von Nutzern auf die Folder nicht blockiert, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Folder für die gesamte Domain des Nutzers freigegeben ist oder sich die Folder in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Betrachter entfernt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

removeViewer(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Folder. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter und kein Betrachter oder Kommentator ist. Mit dieser Methode wird auch nicht verhindert, dass Nutzer auf die Folder zugreifen, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Folder für die gesamte Domain des Nutzers freigegeben ist oder wenn sich die Folder in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Mitbearbeiter entfernt.

Parameter

NameTypBeschreibung
emailAddressStringDie E‑Mail-Adresse des Nutzers, der entfernt werden soll.

Rückflug

Folder – Diese Folder für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

removeViewer(user)

Entfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Folder. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter und kein Betrachter ist. Mit dieser Methode wird auch nicht verhindert, dass Nutzer auf die Folder zugreifen, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Folder für die gesamte Domain des Nutzers freigegeben ist oder wenn sich die Folder in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Mitbearbeiter entfernt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Folder – Diese Folder für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

revokePermissions(emailAddress)

Widerruft den Zugriff auf Folder, der dem angegebenen Nutzer gewährt wurde. Mit dieser Methode wird der Zugriff von Nutzern auf die Folder nicht blockiert, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat, z. B. wenn die Folder für die gesamte Domain des Nutzers freigegeben ist.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, dessen Zugriff widerrufen werden soll.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

revokePermissions(user)

Widerruft den Zugriff auf Folder, der dem angegebenen Nutzer gewährt wurde. Mit dieser Methode wird der Zugriff von Nutzern auf die Folder nicht blockiert, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat, z. B. wenn die Folder für die gesamte Domain des Nutzers freigegeben ist.

Parameter

NameTypBeschreibung
userUserEine Darstellung des Nutzers, dessen Zugriff widerrufen werden soll.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

searchFiles(params)

Ruft eine Sammlung aller Dateien ab, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Suchkriterien entsprechen. Die Suchkriterien sind in der Google Drive SDK-Dokumentation beschrieben. Der Drive-Dienst verwendet Version 2 der Drive API. Einige Abfragefelder unterscheiden sich von Version 3. Unterschiede zwischen v2 und v3 bei Feldern

Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie daher darauf, Anführungszeichen richtig zu maskieren (z. B. "title contains 'Gulliver\\'s Travels'" oder 'title contains "Gulliver\'s Travels"'). 

// Logs the name of every file that are children of the current folder and modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

Parameter

NameTypBeschreibung
paramsStringDie Suchkriterien, wie in der Google Drive SDK-Dokumentation beschrieben.

Rückflug

FileIterator: Eine Sammlung aller Dateien, die untergeordnete Elemente des aktuellen Ordners sind und den Suchkriterien entsprechen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

searchFolders(params)

Ruft eine Sammlung aller Ordner ab, die untergeordnete Elemente des aktuellen Ordners sind und den angegebenen Suchkriterien entsprechen. Die Suchkriterien sind in der Google Drive SDK-Dokumentation beschrieben. Der Drive-Dienst verwendet Version 2 der Drive API. Einige Abfragefelder unterscheiden sich von Version 3. Unterschiede zwischen v2 und v3 bei Feldern

Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. Achten Sie daher darauf, Anführungszeichen richtig zu maskieren (z. B. "title contains 'Gulliver\\'s Travels'" oder 'title contains "Gulliver\'s Travels"'). 

// Logs the name of every folder that are children of the current folder and you own and is starred.
const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

Parameter

NameTypBeschreibung
paramsStringDie Suchkriterien, wie in der Google Drive SDK-Dokumentation beschrieben.

Rückflug

FolderIterator: Eine Sammlung aller Ordner, die untergeordnete Elemente des aktuellen Ordners sind und den Suchkriterien entsprechen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

setDescription(description)

Legt die Beschreibung für Folder fest.

Parameter

NameTypBeschreibung
descriptionStringdie neue Beschreibung für Folder

Rückflug

Folder – diese Folder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

setName(name)

Legt den Namen der Folder fest.

Parameter

NameTypBeschreibung
nameStringDer neue Name der Folder

Rückflug

Folder – diese Folder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

setOwner(emailAddress)

Ändert den Inhaber von Folder. Mit dieser Methode erhält der bisherige Inhaber auch expliziten Bearbeitungszugriff auf die Folder.

In Google Drive wird das Ändern des Eigentümers für Elemente, deren Eigentümer ein gmail.com-Konto ist, nicht unterstützt. Für Workspace-Konten wird es unterstützt.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des Nutzers, der der neue Inhaber werden soll.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

setOwner(user)

Ändert den Inhaber von Folder. Mit dieser Methode erhält der bisherige Inhaber auch expliziten Bearbeitungszugriff auf die Folder.

In Google Drive wird das Ändern des Eigentümers für Elemente, deren Eigentümer ein gmail.com-Konto ist, nicht unterstützt. Für Workspace-Konten wird es unterstützt.

Parameter

NameTypBeschreibung
userUserEine Darstellung des Nutzers, der der neue Inhaber werden soll.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

setSecurityUpdateEnabled(enabled)

Legt fest, ob für den Zugriff auf Folder ein Ressourcenschlüssel erforderlich ist, wenn die Datei über einen Link freigegeben wird. Geeignete Dateien und Ordner sind standardmäßig aktiviert.

Weitere Informationen zum Sicherheitsupdate für Google Drive

Parameter

NameTypBeschreibung
enabledBooleanGibt an, ob die Anforderung des Ressourcenschlüssels für die Folder aktiviert werden soll.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

setShareableByEditors(shareable)

Gibt an, ob Nutzer mit Bearbeitungsberechtigungen für die Folder die Datei für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. Der Standardwert für ein neues Folder ist true.

Parameter

NameTypBeschreibung
shareableBooleantrue, wenn Nutzer mit Bearbeitungsberechtigungen die Berechtigungen ändern oder Inhalte für andere Nutzer freigeben dürfen, false, wenn nicht.

Rückflug

Folder – Diese Folder zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

setSharing(accessType, permissionType)

Legt fest, welche Nutzerklasse auf Folder zugreifen kann und welche Berechtigungen diesen Nutzern erteilt werden, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde. 

// Creates a folder that anyone on the Internet can read from and write to.
// (Domain administrators can prohibit this setting for users of a Google
// Workspace domain.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parameter

NameTypBeschreibung
accessTypeAccessWelche Nutzerklasse sollte auf die Folder zugreifen können?
permissionTypePermissiondie Berechtigungen, die Nutzern mit Zugriff auf Folder gewährt werden sollen

Rückflug

Folder – diese Folder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

setStarred(starred)

Legt fest, ob die Folder in Google Drive des Nutzers mit einem Sternchen markiert ist. Der Standardwert für neue Folders ist false.

Parameter

NameTypBeschreibung
starredBooleantrue, wenn die Folder in der Drive-Ablage des Nutzers mit einem Sternchen markiert werden soll; false, wenn nicht

Rückflug

Folder – diese Folder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

setTrashed(trashed)

Legt fest, ob sich die Folder im Papierkorb des Drive-Kontos des Nutzers befindet. Nur der Eigentümer kann Folder in den Papierkorb verschieben. Der Standardwert für neue Folders ist false.

Parameter

NameTypBeschreibung
trashedBooleantrue, wenn die Folder in den Papierkorb der Ablage des Nutzers verschoben werden soll; false, wenn nicht

Rückflug

Folder – diese Folder zur Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

  • https://www.googleapis.com/auth/drive

Eingestellte Methoden