Class Folder

Ordner

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

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

Methoden

MethodeRückgabetypKurzbeschreibung
addEditor(emailAddress)FolderFügt den angegebenen Nutzer der Liste der Bearbeiter für Folder hinzu.
addEditor(user)FolderFügt den angegebenen Nutzer der Liste der Bearbeiter für Folder hinzu.
addEditors(emailAddresses)FolderFügt das angegebene Array von Nutzern der Liste der Bearbeiter für Folder hinzu.
addViewer(emailAddress)FolderFügt den angegebenen Nutzer der Liste der Betrachter für das Folder hinzu.
addViewer(user)FolderFügt den angegebenen Nutzer der Liste der Betrachter für das Folder hinzu.
addViewers(emailAddresses)FolderFügt das angegebene Array von Nutzern der Betrachterliste für Folder hinzu.
createFile(blob)FileErstellt im aktuellen Ordner eine Datei aus einer bestimmten Blob mit beliebigen Daten.
createFile(name, content)FileErstellt im aktuellen Ordner eine Textdatei mit dem angegebenen Namen und Inhalt.
createFile(name, content, mimeType)FileErstellt im aktuellen Ordner eine Datei mit dem angegebenen Namen, Inhalt und MIME-Typ.
createFolder(name)FolderErstellt im aktuellen Ordner einen Ordner mit dem angegebenen Namen.
createShortcut(targetId)FileErstellt eine Verknüpfung zur angegebenen Drive-Element-ID und gibt sie zurück.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileEine Verknüpfung zur angegebenen Drive-Element-ID und dem Ressourcenschlüssel wird erstellt und zurückgegeben.
getAccess(email)PermissionRuft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde.
getAccess(user)PermissionRuft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde.
getDateCreated()DateRuft das Datum ab, an dem die Folder erstellt wurde.
getDescription()StringRuft die Beschreibung für den Folder ab.
getEditors()User[]Ruft die Liste der Bearbeiter für dieses Folder-Element ab.
getFiles()FileIteratorRuft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind.
getFilesByName(name)FileIteratorRuft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben.
getFilesByType(mimeType)FileIteratorRuft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen MIME-Typ haben.
getFolders()FolderIteratorRuft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind.
getFoldersByName(name)FolderIteratorRuft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben.
getId()StringRuft die ID von Folder ab.
getLastUpdated()DateRuft das Datum ab, an dem die Folder zuletzt aktualisiert wurde.
getName()StringRuft den Namen des Folder ab.
getOwner()UserRuft den Eigentümer von Folder ab.
getParents()FolderIteratorRuft eine Sammlung von Ordnern ab, die dem Folder unmittelbar übergeordnet sind.
getResourceKey()StringRuft den Ressourcenschlüssel der Folder ab, die für den Zugriff auf Elemente erforderlich ist, die wurden über einen Link freigegeben.
getSecurityUpdateEligible()BooleanRuft ab, ob dieser Folder berechtigt ist, das Sicherheitsupdate anzuwenden, das erfordert für den Zugriff einen Ressourcenschlüssel, wenn er über einen Link freigegeben wird.
getSecurityUpdateEnabled()BooleanRuft ab, ob dieser Folder einen Ressourcenschlüssel für den Zugriff benötigt, wenn er die über einen Link freigegeben wurden.
getSharingAccess()AccessRuft ab, welche Klasse von Nutzern außer auf einzelne Nutzer auf das Folder zugreifen kann Nutzern, denen explizit Zugriff gewährt wurde.
getSharingPermission()PermissionEr erhält die Berechtigung für die Nutzer, die auf Folder zugreifen können, außer für einzelne Nutzer, denen explizit Zugriff gewährt wurde.
getSize()IntegerRuft die Anzahl von Byte ab, die zum Speichern von Folder in Drive verwendet werden.
getUrl()StringRuft die URL ab, die zum Öffnen von Folder in einer Google-App verwendet werden kann, z. B. Google Drive oder Google Docs.
getViewers()User[]Ruft die Liste der Betrachter und Kommentatoren für dieses Folder ab.
isShareableByEditors()BooleanLegt fest, ob Nutzer mit Bearbeitungsberechtigungen für Folder folgende Aktionen ausführen dürfen: für andere Nutzer freigeben oder die Berechtigungen ändern.
isStarred()BooleanLegt fest, ob das Folder im Drive des Nutzers markiert wurde.
isTrashed()BooleanLegt fest, ob sich das Folder im Papierkorb der Ablage des Nutzers befindet.
moveTo(destination)FolderVerschiebt dieses Element in den angegebenen Zielordner.
removeEditor(emailAddress)FolderEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Folder.
removeEditor(user)FolderEntfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Folder.
removeViewer(emailAddress)FolderEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Folder.
removeViewer(user)FolderEntfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Folder.
revokePermissions(emailAddress)FolderHebt den Zugriff auf die Folder auf, die dem angegebenen Nutzer gewährt wurde.
revokePermissions(user)FolderHebt den Zugriff auf die Folder auf, die dem angegebenen Nutzer gewährt wurde.
searchFiles(params)FileIteratorRuft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und der angegebenen Suche entsprechen Kriterien.
searchFolders(params)FolderIteratorRuft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und der angegebenen Suche entsprechen Kriterien.
setDescription(description)FolderLegt die Beschreibung für das Folder fest.
setName(name)FolderLegt den Namen des Folder fest.
setOwner(emailAddress)FolderÄndert den Eigentümer von Folder.
setOwner(user)FolderÄndert den Eigentümer von Folder.
setSecurityUpdateEnabled(enabled)FolderLegt fest, ob Folder einen Ressourcenschlüssel für den Zugriff benötigt, wenn er die über einen Link freigegeben wurden.
setShareableByEditors(shareable)FolderLegt fest, ob Nutzer mit Bearbeitungsberechtigungen für die Folder Dateien freigeben dürfen oder die Berechtigungen zu ändern.
setSharing(accessType, permissionType)FolderLegt fest, welche Klasse von Nutzern auf die Folder zugreifen kann und welche Berechtigungen werden diesen Nutzern gewährt, ebenso wie einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
setStarred(starred)FolderLegt fest, ob das Folder im Drive des Nutzers markiert ist.
setTrashed(trashed)FolderLegt fest, ob sich die Folder im Papierkorb der Ablage des Nutzers befindet.

Detaillierte Dokumentation

addEditor(emailAddress)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Folder hinzu. Wenn der Nutzer wird der Nutzer mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des hinzuzufügenden Nutzers.

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addEditor(user)

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Folder hinzu. Wenn der Nutzer wird der Nutzer mit dieser Methode aus der Betrachterliste hochgestuft.

Parameter

NameTypBeschreibung
userUserDarstellung des hinzuzufügenden Nutzers.

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addEditors(emailAddresses)

Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für Folder hinzu. Wenn eines der Nutzer, die bereits auf der Liste der Betrachter stehen, werden sie mit dieser Methode aus der Liste der Zuschauer*innen.

Parameter

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

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addViewer(emailAddress)

Fügt den angegebenen Nutzer der Liste der Betrachter für das Folder hinzu. Wenn der Nutzer auf der Liste der Bearbeiter enthält, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des hinzuzufügenden Nutzers.

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addViewer(user)

Fügt den angegebenen Nutzer der Liste der Betrachter für das Folder hinzu. Wenn der Nutzer auf der Liste der Bearbeiter enthält, hat diese Methode keine Auswirkungen.

Parameter

NameTypBeschreibung
userUserDarstellung des hinzuzufügenden Nutzers.

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addViewers(emailAddresses)

Fügt das angegebene Array von Nutzern der Betrachterliste für Folder hinzu. Wenn eines der Benutzer, die bereits auf der Liste der Bearbeiter waren, hat diese Methode keine Auswirkungen auf sie.

Parameter

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

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createFile(blob)

Erstellt im aktuellen Ordner eine Datei aus einer bestimmten Blob mit beliebigen Daten.

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.getRootFolder().createFile(blob);

Parameter

NameTypBeschreibung
blobBlobSourceDie Daten für die neue Datei.

Rückflug

File: Die neue Datei.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createFile(name, content)

Erstellt im aktuellen Ordner eine Textdatei mit dem angegebenen Namen und Inhalt. Wirf einen Ausnahme, 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createFile(name, content, mimeType)

Erstellt im aktuellen Ordner eine Datei mit dem angegebenen Namen, Inhalt und MIME-Typ. Wurfspiele Ausnahme, 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Eine Verknüpfung zur angegebenen Drive-Element-ID und dem Ressourcenschlüssel wird erstellt und zurückgegeben. Eine Ressource Schlüssel ist ein zusätzlicher Parameter, der übergeben werden muss, um auf die Zieldatei oder den Zielordner zuzugreifen, die bzw. den wurde per Link freigegeben.

// 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getAccess(email)

Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde.

Parameter

NameTypBeschreibung
emailStringDie E-Mail-Adresse des Nutzers, dessen Berechtigungen überprüft werden sollen

Rückflug

Permission – die Berechtigungen, die dem Nutzer gewährt wurden

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getAccess(user)

Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde.

Parameter

NameTypBeschreibung
userUserDarstellung des Nutzers, dessen Berechtigungen geprüft werden sollen

Rückflug

Permission – die Berechtigungen, die dem Nutzer gewährt wurden

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDateCreated()

Ruft das Datum ab, an dem die Folder erstellt wurde.

Rückflug

Date – das Datum, an dem die Folder erstellt wurde

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDescription()

Ruft die Beschreibung für den Folder ab.

Rückflug

String: Die Beschreibung für das Folder-Element

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getEditors()

Ruft die Liste der Bearbeiter für dieses Folder-Element ab. Wenn der Nutzer, der das Skript ausführt, keinen Bearbeitungszugriff auf das 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 (editor of editors) {
  console.log(editor.getName());
}

Rückflug

User[]: Liste der Bearbeiter für Folder, wenn der Nutzer Bearbeitungszugriff oder eine Andernfalls ist ein leeres Array vorhanden.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFiles()

Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind.

Rückflug

FileIterator: Eine Sammlung aller Dateien, die dem aktuellen Ordner untergeordnet sind.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFilesByName(name)

Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben.

Parameter

NameTypBeschreibung
nameStringDer Name der zu suchenden Dateien.

Rückflug

FileIterator: Eine Sammlung aller Dateien, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFilesByType(mimeType)

Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen MIME-Typ haben.

Parameter

NameTypBeschreibung
mimeTypeStringDer MIME-Typ der zu suchenden Dateien.

Rückflug

FileIterator: Eine Sammlung aller Dateien, die dem aktuellen Ordner untergeordnet sind und das angegebene MIME haben Typ.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFolders()

Ruft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind.

Rückflug

FolderIterator: Eine Sammlung aller Ordner, die dem aktuellen Ordner untergeordnet sind.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFoldersByName(name)

Ruft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben.

Parameter

NameTypBeschreibung
nameStringDer Name des zu suchenden Ordners.

Rückflug

FolderIterator: Eine Sammlung aller Ordner, die dem aktuellen Ordner untergeordnet sind und den angegebenen Namen haben.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getId()

Ruft die ID von Folder ab.

Rückflug

String – die ID von Folder

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getLastUpdated()

Ruft das Datum ab, an dem die Folder zuletzt aktualisiert wurde.

Rückflug

Date – das Datum, an dem die Folder zuletzt aktualisiert wurde

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 des Folder

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getOwner()

Ruft den Eigentümer von 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 Eigentümer von Folder.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getParents()

Ruft eine Sammlung von Ordnern ab, die dem Folder unmittelbar übergeordnet sind.

Rückflug

FolderIterator: Eine Sammlung von Ordnern, die unmittelbar übergeordnete Elemente von Folder sind.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getResourceKey()

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

Rückflug

String: Der Ressourcenschlüssel von Folder.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSecurityUpdateEligible()

Ruft ab, ob dieser Folder berechtigt ist, das Sicherheitsupdate anzuwenden, das erfordert für den Zugriff einen Ressourcenschlüssel, wenn er über einen Link freigegeben wird.

Drive benötigt einen Ressourcenschlüssel, um auf einige Dateien oder Ordner zugreifen zu können, die über ein . Diese Änderung ist Teil eines Sicherheitsupdates. Das Update ist standardmäßig für berechtigte Dateien und Ordner. Um die Anforderung von Ressourcenschlüsseln für zulässige Dateien zu aktivieren oder zu deaktivieren, verwenden Sie setSecurityUpdateEnabled

Weitere Informationen zum Sicherheitsupdate für Google Drive

Rückflug

Boolean: gibt an, ob die Ressourcenschlüsselanforderung für Folder angewendet werden kann.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSecurityUpdateEnabled()

Ruft ab, ob dieser Folder einen Ressourcenschlüssel für den Zugriff benötigt, wenn er die über einen Link freigegeben wurden. Diese Anforderung ist für geeignete Dateien und Ordner standardmäßig aktiviert. Verwenden Sie setSecurityUpdateEnabled, um die Anforderung von Ressourcenschlüsseln für zulässige Dateien zu aktivieren oder zu deaktivieren.

Weitere Informationen zum Sicherheitsupdate für Google Drive

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSharingAccess()

Ruft ab, welche Klasse von Nutzern außer auf einzelne Nutzer auf das Folder zugreifen kann Nutzern, denen explizit Zugriff gewährt wurde.

Rückflug

Access – welche Klasse von Nutzern kann auf die Folder zugreifen

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSharingPermission()

Er erhält die Berechtigung für die Nutzer, die auf Folder zugreifen können, außer für einzelne Nutzer, denen explizit Zugriff gewährt wurde.

Rückflug

Permission: die Berechtigungen, die Nutzern gewährt wurden, die auf die Folder zugreifen können

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSize()

Ruft die Anzahl von Byte ab, die zum Speichern von Folder in Drive verwendet werden. Beachten Sie, dass Dateien aus Google Workspace-Anwendungen werden nicht auf das Drive-Speicherkontingent angerechnet und deshalb zurückgegeben 0 Byte.

Rückflug

Integer: Die Anzahl der Byte, die zum Speichern von Folder in Drive verwendet werden

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getUrl()

Ruft die URL ab, die zum Öffnen von Folder in einer Google-App verwendet werden kann, z. B. Google Drive oder Google Docs.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getViewers()

Ruft die Liste der Betrachter und Kommentatoren für dieses Folder ab. Wenn Nutzende, die führt das Skript aus, das keinen Bearbeitungszugriff auf den Folder hat, mit dieser Methode gibt 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 (viewer of viewers) {
  console.log(viewer.getName());
}

Rückflug

User[]: Liste der Betrachter und Kommentatoren für Folder, falls der Nutzer eine Änderung vorgenommen hat oder ein leeres Array.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isShareableByEditors()

Legt fest, ob Nutzer mit Bearbeitungsberechtigungen für Folder folgende Aktionen ausführen dürfen: für andere Nutzer freigeben oder die Berechtigungen ändern.

Rückflug

Boolean: true, wenn Nutzer mit Bearbeitungsberechtigungen Dateien für andere Nutzer freigeben dürfen oder Berechtigungen ändern false wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isStarred()

Legt fest, ob das Folder im Drive des Nutzers markiert wurde.

Rückflug

Boolean: true, wenn Folder in der Ablage des Nutzers markiert ist false wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isTrashed()

Legt fest, ob sich das Folder im Papierkorb der Ablage des Nutzers befindet.

Rückflug

Boolean: true, wenn sich die Folder im Papierkorb der Ablage des Nutzers befindet false wenn nicht

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 Eigentümer der Datei sein oder mindestens Bearbeitungszugriff auf das Element aktuellen übergeordneten Ordner, um das Element in den Zielordner zu verschieben.

Parameter

NameTypBeschreibung
destinationFolderDer Ordner, der zum neuen übergeordneten Ordner wird.

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

removeEditor(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Folder. Bei dieser Methode werden keine Nutzer am Zugriff auf Folder blockieren, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff haben, z. B. wenn die Folder für das gesamte Domain oder die Folder befindet sich in einer geteilten Ablage, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des zu entfernenden Nutzers.

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

removeEditor(user)

Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Folder. Bei dieser Methode werden keine Nutzer am Zugriff auf Folder blockieren, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff haben, z. B. wenn die Folder für das gesamte Domain oder die Folder befindet sich in einer geteilten Ablage, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

removeViewer(emailAddress)

Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Folder. Dieses hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter, kein Betrachter oder Kommentator ist. Bei dieser Methode Der Zugriff auf Folder wird nicht blockiert, wenn sie zu einer Klasse von Nutzern gehören, die allgemeinen Zugriff haben, z. B. wenn die Folder für das 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 Bearbeiter entfernt.

Parameter

NameTypBeschreibung
emailAddressStringDie E-Mail-Adresse des zu entfernenden Nutzers.

Rückflug

Folder: Diese Folder für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

removeViewer(user)

Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für das Folder. Dieses hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter und kein Betrachter ist. Diese Methode blockiert auch nicht Nutzer, die nicht auf die Folder zugreifen, wenn sie zu einer Nutzerklasse mit allgemeinen Zugriff haben, z. B. wenn die Folder für die gesamte Domain des Nutzers freigegeben ist oder Folder befindet sich in einer geteilten Ablage, auf die der Nutzer zugreifen kann.

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

Parameter

NameTypBeschreibung
userUserEine Darstellung des zu entfernenden Nutzers.

Rückflug

Folder: Diese Folder für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

revokePermissions(emailAddress)

Hebt den Zugriff auf die Folder auf, die dem angegebenen Nutzer gewährt wurde. Bei dieser Methode werden keine Nutzer daran hindern, auf die Folder zuzugreifen, wenn sie zu einer Klasse von Nutzern gehören, die allgemeinen Zugriff haben, z. B. wenn die Folder für das der gesamten Domain.

Parameter

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

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

revokePermissions(user)

Hebt den Zugriff auf die Folder auf, die dem angegebenen Nutzer gewährt wurde. Bei dieser Methode werden keine Nutzer daran hindern, auf die Folder zuzugreifen, wenn sie zu einer Klasse von Nutzern gehören, die allgemeinen Zugriff haben, z. B. wenn die Folder für das der gesamten Domain.

Parameter

NameTypBeschreibung
userUserDarstellung des Nutzers, dessen Zugriff widerrufen werden soll

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

searchFiles(params)

Ruft eine Sammlung aller Dateien ab, die dem aktuellen Ordner untergeordnet sind und der angegebenen Suche entsprechen Kriterien. Die Suchkriterien sind in der Google Drive SDK-Dokumentation ausführlich beschrieben. Beachten Sie, dass die Drive-Datei Der Dienst verwendet Version 2 der Drive API. Einige Abfragefelder unterscheiden sich von Version 3. Überprüfen Sie das Feld Unterschiede zwischen v2 und v3.

Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. um Anführungszeichen korrekt mit Escapezeichen zu versehen (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.""
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var 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 dem aktuellen Ordner untergeordnet sind und mit der Suche übereinstimmen Kriterien.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

searchFolders(params)

Ruft eine Sammlung aller Ordner ab, die dem aktuellen Ordner untergeordnet sind und der angegebenen Suche entsprechen Kriterien. Die Suchkriterien sind in der Google Drive SDK-Dokumentation ausführlich beschrieben. Beachten Sie, dass die Drive-Datei Der Dienst verwendet Version 2 der Drive API. Einige Abfragefelder unterscheiden sich von Version 3. Überprüfen Sie das Feld Unterschiede zwischen v2 und v3.

Das Argument params ist ein Abfragestring, der Stringwerte enthalten kann. um Anführungszeichen korrekt mit Escapezeichen zu versehen (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.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var 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 dem aktuellen Ordner untergeordnet sind und mit der Suche übereinstimmen Kriterien.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setDescription(description)

Legt die Beschreibung für das Folder fest.

Parameter

NameTypBeschreibung
descriptionStringdie neue Beschreibung für das Folder

Rückflug

Folder – diese Folder, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setName(name)

Legt den Namen des Folder fest.

Parameter

NameTypBeschreibung
nameStringden neuen Namen von Folder

Rückflug

Folder – diese Folder, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setOwner(emailAddress)

Ändert den Eigentümer von Folder. Bei dieser Methode erhält der vorherige Eigentümer ausdrücklicher Bearbeitungszugriff auf die Folder.

Parameter

NameTypBeschreibung
emailAddressStringdie E-Mail-Adresse des Nutzers, der der neue Eigentümer werden soll

Rückflug

Folder – diese Folder, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setOwner(user)

Ändert den Eigentümer von Folder. Bei dieser Methode erhält der vorherige Eigentümer ausdrücklicher Bearbeitungszugriff auf die Folder.

Parameter

NameTypBeschreibung
userUserDarstellung des Nutzers, der der neue Inhaber werden soll

Rückflug

Folder – diese Folder, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setSecurityUpdateEnabled(enabled)

Legt fest, ob Folder einen Ressourcenschlüssel für den Zugriff benötigt, wenn er die über einen Link freigegeben wurden. Zulässige Dateien und Ordner sind standardmäßig aktiviert.

Weitere Informationen zum Sicherheitsupdate für Google Drive

Parameter

NameTypBeschreibung
enabledBooleanGibt an, ob die Ressourcenschlüsselanforderung für Folder aktiviert werden soll.

Rückflug

Folder: Diese Folder zum Verketten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setShareableByEditors(shareable)

Legt fest, ob Nutzer mit Bearbeitungsberechtigungen für die Folder Dateien freigeben dürfen oder die Berechtigungen zu ändern. Die Standardeinstellung für eine neue Folder ist true.

Parameter

NameTypBeschreibung
shareableBooleantrue, wenn Nutzer mit Bearbeitungsberechtigung die Datei freigeben dürfen andere Nutzer oder die Berechtigungen ändern false wenn nicht

Rückflug

Folder – diese Folder, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setSharing(accessType, permissionType)

Legt fest, welche Klasse von Nutzern auf die Folder zugreifen kann und welche Berechtigungen werden diesen Nutzern gewährt, ebenso wie 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.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parameter

NameTypBeschreibung
accessTypeAccesswelche Nutzerklasse auf die Folder zugreifen können soll
permissionTypePermissiondie Berechtigungen, die Nutzern gewährt werden sollen, die auf Folder zugreifen können

Rückflug

Folder – diese Folder, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setStarred(starred)

Legt fest, ob das Folder im Drive des Nutzers markiert ist. Der Standardwert für Der neue Wert für Folder ist false.

Parameter

NameTypBeschreibung
starredBooleantrue, wenn Folder im Feld des Nutzers markiert werden soll Drive: false wenn nicht

Rückflug

Folder – diese Folder, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setTrashed(trashed)

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

Parameter

NameTypBeschreibung
trashedBooleantrue, wenn die Folder in den Papierkorb verschoben werden soll: in das Google Drive-Konto des Nutzers, false wenn nicht

Rückflug

Folder – diese Folder, für Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Verworfene Methoden