Eine Datei in Google Drive Du kannst die Dateien über DriveApp
aufrufen oder erstellen.
// Trash every untitled spreadsheet that hasn't been updated in a week. var files = DriveApp.getFilesByName('Untitled spreadsheet'); while (files.hasNext()) { var file = files.next(); if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { file.setTrashed(true); } }
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addCommenter(emailAddress) | File | Fügen Sie den angegebenen Nutzer zur Liste der Kommentatoren für File hinzu. |
addCommenter(user) | File | Fügen Sie den angegebenen Nutzer zur Liste der Kommentatoren für File hinzu. |
addCommenters(emailAddresses) | File | Füge das angegebene Array der Nutzer der Liste der Kommentatoren für File hinzu. |
addEditor(emailAddress) | File | Der entsprechende Nutzer wird der Liste der Mitbearbeiter für File hinzugefügt. |
addEditor(user) | File | Der entsprechende Nutzer wird der Liste der Mitbearbeiter für File hinzugefügt. |
addEditors(emailAddresses) | File | Fügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für File hinzu. |
addViewer(emailAddress) | File | Der entsprechende Nutzer wird der Liste der Betrachter für File hinzugefügt. |
addViewer(user) | File | Der entsprechende Nutzer wird der Liste der Betrachter für File hinzugefügt. |
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 Erstellungsdatum der File ab. |
getDescription() | String | Ruft die Beschreibung für File ab |
getDownloadUrl() | String | Ruft die URL ab, die zum Herunterladen der Datei verwendet werden kann. |
getEditors() | User[] | Ruft die Liste der Editoren für dieses 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 von File ab |
getOwner() | User | Ruft den Dateieigentümer ab |
getParents() | FolderIterator | Ruft eine Sammlung von Ordnern ab, die unmittelbare übergeordnete Elemente von File 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 dieses File das Sicherheitsupdate anwenden kann, für das ein Ressourcenschlüssel erforderlich ist, wenn er über einen Link freigegeben wird. |
getSecurityUpdateEnabled() | Boolean | Ruft ab, ob dieser File einen Ressourcenschlüssel für den Zugriff benötigt, wenn er über einen Link freigegeben wird. |
getSharingAccess() | Access | Ruft ab, welche Klasse von Nutzern auf File zugreifen kann, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde. |
getSharingPermission() | Permission | Ruft die Berechtigung ab, die diesen Nutzern gewährt wird, die auf File zugreifen können – mit Ausnahme der einzelnen Nutzer, denen explizit Zugriff gewährt wurde. |
getSize() | Integer | Ruft die Anzahl der Bytes ab, die zum Speichern der File in Drive verwendet werden |
getTargetId() | String | Wenn es ein Shortcut ist, wird die ID des Elements zurückgegeben, auf das es verweist. |
getTargetMimeType() | String | Wenn es ein Shortcut ist, wird der MIME-Typ des Elements zurückgegeben, auf das es verweist. |
getTargetResourceKey() | String | Wenn die Datei eine Verknüpfung ist, wird der Ressourcenschlüssel des Elements zurückgegeben, auf das sie verweist. |
getThumbnail() | Blob | Ruft ein Thumbnail für die Datei ab oder null , wenn kein Thumbnail vorhanden ist |
getUrl() | String | Ruft die URL ab, mit der die File in einer Google-App wie Google Drive oder Google Docs geöffnet werden kann. |
getViewers() | User[] | Ruft die Liste der Betrachter und Kommentatoren für dieses File ab. |
isShareableByEditors() | Boolean | Bestimmt, ob Nutzer mit Bearbeitungsberechtigungen für File diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
isStarred() | Boolean | Bestimmt, ob das File in der Ablage des Nutzers markiert wurde. |
isTrashed() | Boolean | Bestimmt, ob sich die File im Papierkorb 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 mit dem angegebenen Namen. |
makeCopy(name, destination) | File | Erstellt eine Kopie der Datei im Zielverzeichnis und benannt sie mit dem angegebenen 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 Mitbearbeiter für File . |
removeEditor(user) | File | Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für File . |
removeViewer(emailAddress) | File | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von File . |
removeViewer(user) | File | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von File . |
revokePermissions(emailAddress) | File | Hiermit wird der Zugriff auf die File widerrufen, die dem angegebenen Nutzer gewährt wurde. |
revokePermissions(user) | File | Hiermit wird der Zugriff auf die File widerrufen, die dem angegebenen Nutzer gewährt wurde. |
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 | Ändert den Inhaber von File . |
setOwner(user) | File | Ändert den Inhaber von File . |
setSecurityUpdateEnabled(enabled) | File | Legt fest, ob für den File ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird. |
setShareableByEditors(shareable) | File | Legt fest, ob Nutzer mit Bearbeitungsberechtigungen für File diese für andere Nutzer freigeben oder die Berechtigungen ändern dürfen. |
setSharing(accessType, permissionType) | File | Legt fest, welche Nutzerklasse auf File zugreifen und welche Berechtigungen diese Nutzer neben den einzelnen Nutzern, denen explizit Zugriff gewährt wurde, gewähren. |
setStarred(starred) | File | Legt fest, ob das File in der Ablage des Nutzers markiert ist. |
setTrashed(trashed) | File | Legt fest, ob sich die File im Papierkorb der Ablage des Nutzers befindet. |
Detaillierte Dokumentation
addCommenter(emailAddress)
Fügen Sie den angegebenen Nutzer zur Liste der Kommentatoren für File
hinzu. Wenn der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you // want to add as a commenter. while (files.hasNext()) { const file = files.next(); email = 'cloudysanfrancisco@gmail.com'; console.log(file.addCommenter(email)); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
addCommenter(user)
Fügen Sie den angegebenen Nutzer zur Liste der Kommentatoren für File
hinzu. Wenn der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Adds the active user as a commenter. while (files.hasNext()) { const file = files.next(); file.addCommenter(Session.getActiveUser()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des hinzuzufügenden Nutzers. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
addCommenters(emailAddresses)
Füge das angegebene Array der Nutzer der Liste der Kommentatoren für File
hinzu. Wenn einer der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); while (files.hasNext()) { const file = files.next(); // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and // 'baklavainthebalkans@gmail.com' with the email addresses to add as commenters. const emails = ['cloudysanfrancisco@gmail.com','baklavainthebalkans@gmail.com']; console.log(file.addCommenters(emails)); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddresses | String[] | Ein Array mit E-Mail-Adressen der hinzuzufügenden Nutzer. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
addEditor(emailAddress)
Der entsprechende Nutzer wird der Liste der Mitbearbeiter für File
hinzugefügt. Wenn der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
addEditor(user)
Der entsprechende Nutzer wird der Liste der Mitbearbeiter für File
hinzugefügt. Wenn der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des hinzuzufügenden Nutzers. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
addEditors(emailAddresses)
Fügt das angegebene Array von Nutzern der Liste der Mitbearbeiter für File
hinzu. Wenn einer der Nutzer bereits auf der Liste der Betrachter steht, wird er mit dieser Methode aus der Betrachterliste hochgestuft.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddresses | String[] | Ein Array mit E-Mail-Adressen der hinzuzufügenden Nutzer. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
addViewer(emailAddress)
Der entsprechende Nutzer wird der Liste der Betrachter für File
hinzugefügt. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befindet, hat diese Methode keine Auswirkungen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
addViewer(user)
Der entsprechende Nutzer wird der Liste der Betrachter für File
hinzugefügt. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befindet, hat diese Methode keine Auswirkungen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des hinzuzufügenden Nutzers. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
addViewers(emailAddresses)
Fügt das angegebene Array von Nutzern der Liste der Betrachter für File
hinzu. Wenn einer der Nutzer bereits auf der Liste der Mitbearbeiter steht, hat diese Methode keine Auswirkungen für ihn.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddresses | String[] | Ein Array mit E-Mail-Adressen der hinzuzufügenden Nutzer. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
getAccess(email)
Ruft die Berechtigung ab, die dem angegebenen Nutzer gewährt wurde.
Parameter
Name | Typ | Beschreibung |
---|---|---|
email | String | die E-Mail-Adresse des Nutzers, dessen Berechtigungen geprüft werden sollen |
Rückflug
Permission
: Die dem Nutzer gewährten Berechtigungen
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
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
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des Nutzers, dessen Berechtigungen geprüft werden sollen |
Rückflug
Permission
: Die dem Nutzer gewährten Berechtigungen
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAs(contentType)
Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. Durch diese Methode wird dem Dateinamen die entsprechende Erweiterung hinzugefügt, z. B. „meinedatei.pdf“. Dabei wird jedoch davon ausgegangen, dass der Teil des Dateinamens, der auf den letzten Punkt folgt (falls vorhanden), eine vorhandene Erweiterung ist, die ersetzt werden soll. Daher wird „ShoppingList.12.25.2014“ in „ShoppingList.12.25.pdf“ geändert.
Informationen zu den täglichen Kontingenten für Conversions finden Sie unter Kontingente für Google-Dienste. Neu erstellte Google Workspace-Domains können vorübergehend strengeren Kontingenten unterliegen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
contentType | String | Der MIME-Typ, in den konvertiert werden soll. Für die meisten Blobs ist 'application/pdf' die einzige gültige Option. Für Bilder im BMP-, GIF-, JPEG- oder PNG-Format ist 'image/bmp' , 'image/gif' , 'image/jpeg' oder 'image/png' ebenfalls gültig. |
Rückflug
Blob
: Die Daten als Blob.
getBlob()
getDateCreated()
Ruft das Erstellungsdatum der File
ab.
Rückflug
Date
: Das Datum, an dem der File
erstellt wurde
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getDescription()
getDownloadUrl()
Ruft die URL ab, die zum Herunterladen der Datei verwendet werden kann. Nur Nutzer mit der Berechtigung zum Öffnen der Datei in Google Drive können auf die URL zugreifen. Sie können diese URL in einem Browser herunterladen, aber nicht mit UrlFetchApp
abrufen. Wenn Sie den Inhalt der Datei im Skript verwenden möchten, verwenden Sie getBlob()
.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the download URLs to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getDownloadUrl()); }
Rückflug
String
: die URL, die zum Herunterladen der Datei verwendet werden kann.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getEditors()
Ruft die Liste der Editoren für dieses File
ab. Wenn der Nutzer, der das Skript ausführt, keinen Bearbeitungszugriff auf File
hat, gibt diese Methode ein leeres Array zurück.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Adds the email addresses in the array as editors of each file. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' // and 'baklavainthebalkans@gmail.com' with valid email addresses. file.addEditors(['cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com']); // Gets a list of the file editors. const editors = file.getEditors(); // For each file, logs the editors' email addresses to the console. for (const editor of editors) { console.log(editor.getEmail()); } }
Rückflug
User[]
: Wenn der Nutzer Bearbeitungszugriff für diese File
hat, wird die Liste der Editoren zurückgegeben. Wenn der Nutzer keinen Bearbeitungszugriff hat, wird ein leeres Array zurückgegeben.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getId()
getLastUpdated()
Ruft das Datum ab, an dem File
zuletzt aktualisiert wurde.
Rückflug
Date
: Das Datum, an dem der File
zuletzt aktualisiert wurde.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getMimeType()
Ruft den MIME-Typ der Datei ab
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the MIME type to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getMimeType()); }
Rückflug
String
: Der MIME-Typ der Datei.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getName()
getOwner()
Ruft den Dateieigentümer ab
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the names of the file owners to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getOwner().getName()); }
Rückflug
User
: Der Dateieigentümer.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getParents()
Ruft eine Sammlung von Ordnern ab, die unmittelbare übergeordnete Elemente von File
sind.
Rückflug
FolderIterator
: eine Sammlung von Ordnern, die direkte Eltern von File
sind
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getResourceKey()
Ruft den Ressourcenschlüssel von File
ab, der für den Zugriff auf Elemente erforderlich ist, die über einen Link freigegeben wurden
Rückflug
String
: Der Ressourcenschlüssel von File
.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEligible()
Ruft ab, ob dieses File
das Sicherheitsupdate anwenden kann, für das ein Ressourcenschlüssel erforderlich ist, wenn er über einen Link freigegeben wird.
Für Google Drive ist ein Ressourcenschlüssel erforderlich, um auf einige Dateien oder Ordner zugreifen zu können, die über einen Link freigegeben wurden. Diese Änderung ist Teil eines Sicherheitsupdates. Das Update ist für berechtigte Dateien und Ordner standardmäßig aktiviert. Verwenden Sie setSecurityUpdateEnabled
, um die Anforderung für den Ressourcenschlüssel für zulässige Dateien zu aktivieren oder zu deaktivieren.
Weitere Informationen zum Sicherheitsupdate für Google Drive
Rückflug
Boolean
: Gibt an, ob der Ressourcenschlüssel für File
angewendet werden kann.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEnabled()
Ruft ab, ob dieser File
einen Ressourcenschlüssel für den Zugriff benötigt, wenn er über einen Link freigegeben wird. Diese Anforderung ist für berechtigte Dateien und Ordner standardmäßig aktiviert.
Mit
setSecurityUpdateEnabled
können Sie die Anforderung des Ressourcenschlüssels für zulässige Dateien aktivieren oder deaktivieren.
Weitere Informationen zum Sicherheitsupdate für Google Drive
Rückflug
Boolean
: Gibt an, ob der Ressourcenschlüssel für dieses File
aktiviert ist.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingAccess()
Ruft ab, welche Klasse von Nutzern auf File
zugreifen kann, abgesehen von einzelnen Nutzern, denen explizit Zugriff gewährt wurde.
Rückflug
Access
: Welche Nutzerklasse auf die File
zugreifen kann
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingPermission()
Ruft die Berechtigung ab, die diesen Nutzern gewährt wird, die auf File
zugreifen können – mit Ausnahme der einzelnen Nutzer, denen explizit Zugriff gewährt wurde.
Rückflug
Permission
: Die Berechtigungen, die Nutzern gewährt werden, die auf das File
zugreifen können
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSize()
Ruft die Anzahl der Bytes ab, die zum Speichern der File
in Drive verwendet werden Hinweis: Google Workspace-Anwendungsdateien werden nicht auf die Drive-Speicherlimits angerechnet und geben daher 0
Byte zurück.
Rückflug
Integer
: Anzahl der Byte, die zum Speichern von File
in Drive verwendet werden
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getTargetId()
Wenn es ein Shortcut ist, wird die ID des Elements zurückgegeben, auf das es verweist.
Andernfalls wird null
zurückgegeben.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the target ID of the shortcut. console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);
Rückflug
String
: Die Zielelement-ID.
getTargetMimeType()
Wenn es ein Shortcut ist, wird der MIME-Typ des Elements zurückgegeben, auf das es verweist.
Andernfalls wird null
zurückgegeben.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the MIME type of the file that the shortcut points to. console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);
Rückflug
String
: Der MIME-Typ des Zielelements.
getTargetResourceKey()
Wenn die Datei eine Verknüpfung ist, wird der Ressourcenschlüssel des Elements zurückgegeben, auf das sie verweist. Ein Ressourcenschlüssel ist ein zusätzlicher Parameter, den Sie weitergeben müssen, um auf Dateien zuzugreifen, die über einen Link freigegeben wurden.
Wenn die Datei keine Verknüpfung ist, wird null
zurückgegeben.
// Gets a file by its ID. // TODO(developer): Replace 'abc123456' with your file ID. const file = DriveApp.getFileById('abc123456'); // If the file is a shortcut, returns the resource key of the file that it points to. console.log(file.getTargetResourceKey());
Rückflug
String
: Der Ressourcenschlüssel des Zielelements oder null
, wenn die Datei keine Verknüpfung ist.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getThumbnail()
Ruft ein Thumbnail für die Datei ab oder null
, wenn kein Thumbnail vorhanden ist
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Logs the thumbnail image for each file to the console as a blob, // or null if no thumbnail exists. console.log(file.getThumbnail()); }
Rückflug
Blob
: Die Miniaturansicht für die Datei.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getUrl()
Ruft die URL ab, mit der die File
in einer Google-App wie Google Drive oder Google Docs geöffnet werden kann.
Rückflug
String
: die URL, mit der File
in einer Google-App wie Google Drive oder Google Docs aufgerufen werden kann
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getViewers()
Ruft die Liste der Betrachter und Kommentatoren für dieses File
ab. Wenn der Nutzer, der das Skript ausführt, keinen Bearbeitungszugriff auf File
hat, gibt diese Methode ein leeres Array zurück.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // For each file, logs the viewers' email addresses to the console. const viewers = file.getViewers(); for (viewer of viewers) { console.log(viewer.getEmail()); } }
Rückflug
User[]
: Wenn der Nutzer Bearbeitungszugriff für diese File
hat, wird die Liste der Betrachter und Kommentatoren zurückgegeben. Wenn der Nutzer keinen Bearbeitungszugriff hat, wird ein leeres Array zurückgegeben.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isStarred()
Bestimmt, ob das File
in der Ablage des Nutzers markiert wurde.
Rückflug
Boolean
: true
, wenn die File
in der Ablage des Nutzers markiert ist. false
, wenn nicht.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isTrashed()
Bestimmt, ob sich die File
im Papierkorb der Ablage des Nutzers befindet.
Rückflug
Boolean
: true
, wenn sich File
im Papierkorb der Drive-Ablage des Nutzers befindet.
false
, wenn nicht.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
makeCopy()
Erstellt eine Kopie der Datei.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and logs the file name to the console. console.log(file.makeCopy().getName()); }
Rückflug
File
: Die neue Kopie.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
makeCopy(destination)
Erstellt eine Kopie der Datei im Zielverzeichnis.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and adds it to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy(destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
destination | Folder | Das Verzeichnis, in das die Datei kopiert wird. |
Rückflug
File
: Die neue Kopie.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
makeCopy(name)
Erstellt eine Kopie der Datei und gibt ihr einen Namen mit dem angegebenen Namen.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and sets the name to 'Test-Copy.' const filename = file.makeCopy('Test-Copy'); // Logs the copied file's name to the console. console.log(filename.getName()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Der Dateiname, der auf die neue Kopie angewendet werden soll. |
Rückflug
File
: Die neue Kopie.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
makeCopy(name, destination)
Erstellt eine Kopie der Datei im Zielverzeichnis und benannt sie mit dem angegebenen Namen.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file, sets the file name, and adds the copied file // to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy('Test-Copy', destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Der Dateiname, der auf die neue Kopie angewendet werden soll. |
destination | Folder | Das Verzeichnis, in das die Datei kopiert wird. |
Rückflug
File
: Die neue Kopie.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
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 zumindest Bearbeitungszugriff auf den aktuellen übergeordneten Ordner des Elements haben, damit es in den Zielordner verschoben werden kann.
Parameter
Name | Typ | Beschreibung |
---|---|---|
destination | Folder | Der Ordner, der zum neuen übergeordneten Element wird. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
removeCommenter(emailAddress)
Entfernt den angegebenen Nutzer aus der Liste der Kommentatoren für File
. Diese Methode blockiert den Zugriff auf Nutzer von File
nicht, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn File
für die gesamte Domain des Nutzers freigegeben ist.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. // TODO(developer): Replace the email with the email of the user you want to remove. file.removeCommenter('cloudysanfrancisco@gmail.com'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, der entfernt werden soll. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
removeCommenter(user)
Entfernt den angegebenen Nutzer aus der Liste der Kommentatoren für File
. Diese Methode blockiert den Zugriff auf Nutzer von File
nicht, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn File
für die gesamte Domain des Nutzers freigegeben ist.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. console.log(file.removeCommenter(Session.getActiveUser())); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Darstellung des zu entfernenden Nutzers |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
removeEditor(emailAddress)
Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für File
. Diese Methode hindert Nutzer nicht daran, auf File
zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die File
für die gesamte Domain des Nutzers freigegeben ist oder wenn sich File
in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer dadurch aus der Liste der Betrachter entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, der entfernt werden soll. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
removeEditor(user)
Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für File
. Diese Methode hindert Nutzer nicht daran, auf File
zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die File
für die gesamte Domain des Nutzers freigegeben ist oder wenn sich File
in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer dadurch aus der Liste der Betrachter entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Darstellung des zu entfernenden Nutzers |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
removeViewer(emailAddress)
Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von File
. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter ist, kein Betrachter oder Kommentator. Diese Methode verhindert auch nicht, dass Nutzer auf File
zugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die File
für die gesamte Domain des Nutzers freigegeben ist oder wenn sich das File
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
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, der entfernt werden soll. |
Rückflug
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
removeViewer(user)
Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren von File
. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter ist, kein Betrachter. Diese Methode hindert Nutzer auch nicht daran, auf File
zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die File
für die gesamte Domain des Nutzers freigegeben ist oder wenn sich File
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
Name | Typ | Beschreibung |
---|---|---|
user | User | Darstellung des zu entfernenden Nutzers |
Rückflug
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
revokePermissions(emailAddress)
Hiermit wird der Zugriff auf die File
widerrufen, die dem angegebenen Nutzer gewährt wurde. Diese Methode hindert Nutzer nicht daran, auf File
zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die File
mit der gesamten Domain des Nutzers geteilt wird.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, dessen Zugriff widerrufen werden soll. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
revokePermissions(user)
Hiermit wird der Zugriff auf die File
widerrufen, die dem angegebenen Nutzer gewährt wurde. Diese Methode hindert Nutzer nicht daran, auf File
zuzugreifen, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die File
mit der gesamten Domain des Nutzers geteilt wird.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des Nutzers, dessen Zugriff widerrufen werden soll. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
setContent(content)
Überschreibt den Inhalt der Datei mit einem bestimmten Ersatz. Löst eine Ausnahme aus, wenn content
größer als 10 MB ist.
// Creates a text file with the content 'Hello, world!' file = DriveApp.createFile('New Text File', 'Hello, world!'); // Logs the content of the text file to the console. console.log(file.getBlob().getDataAsString()); // Updates the content of the text file to 'Updated text!' file.setContent('Updated text!') // Logs content of the text file to the console. console.log(file.getBlob().getDataAsString());
Parameter
Name | Typ | Beschreibung |
---|---|---|
content | String | Der neue Inhalt der Datei. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
setDescription(description)
setName(name)
setOwner(emailAddress)
Ändert den Inhaber von File
. Mit dieser Methode erhält der vorherige Inhaber auch explizit Bearbeitungszugriff auf den File
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | die E-Mail-Adresse des Nutzers, der der neue Inhaber werden soll |
Rückflug
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
setOwner(user)
Ändert den Inhaber von File
. Mit dieser Methode erhält der vorherige Inhaber auch explizit Bearbeitungszugriff auf den File
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Darstellung des Nutzers, der der neue Inhaber werden soll |
Rückflug
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
setSecurityUpdateEnabled(enabled)
Legt fest, ob für den File
ein Ressourcenschlüssel für den Zugriff erforderlich ist, wenn er über einen Link freigegeben wird. Zulässige Dateien und Ordner sind standardmäßig aktiviert.
Weitere Informationen zum Sicherheitsupdate für Google Drive
Parameter
Name | Typ | Beschreibung |
---|---|---|
enabled | Boolean | Gibt an, ob der Ressourcenschlüssel für File aktiviert werden soll. |
Rückflug
File
: Der File
für eine Verkettung.
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
setSharing(accessType, permissionType)
Legt fest, welche Nutzerklasse auf File
zugreifen und welche Berechtigungen diese Nutzer neben den einzelnen Nutzern, denen explizit Zugriff gewährt wurde, gewähren.
// 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
Name | Typ | Beschreibung |
---|---|---|
accessType | Access | welche Nutzer auf die File zugreifen dürfen |
permissionType | Permission | die Berechtigungen, die Nutzern gewährt werden sollen, die auf das File zugreifen können |
Rückflug
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
setStarred(starred)
Legt fest, ob das File
in der Ablage des Nutzers markiert ist. Der Standardwert für neue File
s ist false
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
starred | Boolean | true , wenn File in der Ablage des Nutzers markiert werden soll. false , wenn nicht. |
Rückflug
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive
setTrashed(trashed)
Legt fest, ob sich die File
im Papierkorb der Ablage des Nutzers befindet. Nur der Inhaber darf File
in den Papierkorb verschieben. Der Standardwert für neue File
s ist false
.
Parameter
Name | Typ | Beschreibung |
---|---|---|
trashed | Boolean | true , wenn File in den Papierkorb der Ablage des Nutzers verschoben werden soll. false , wenn nicht |
Rückflug
Autorisierung
Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:
-
https://www.googleapis.com/auth/drive