Un dossier dans Google Drive Vous pouvez accéder aux dossiers ou les créer à partir de DriveApp
.
// 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()); }
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addEditor(emailAddress) | Folder | Ajoute l'utilisateur donné à la liste des éditeurs pour Folder . |
addEditor(user) | Folder | Ajoute l'utilisateur donné à la liste des éditeurs pour Folder . |
addEditors(emailAddresses) | Folder | Ajoute le tableau d'utilisateurs donné à la liste des éditeurs pour Folder . |
addViewer(emailAddress) | Folder | Ajoute l'utilisateur donné à la liste des lecteurs pour Folder . |
addViewer(user) | Folder | Ajoute l'utilisateur donné à la liste des lecteurs pour Folder . |
addViewers(emailAddresses) | Folder | Ajoute le tableau d'utilisateurs donné à la liste des lecteurs pour Folder . |
createFile(blob) | File | Crée un fichier dans le dossier actuel à partir d'un Blob donné de données arbitraires. |
createFile(name, content) | File | Crée un fichier texte avec le nom et le contenu indiqués dans le dossier actuel. |
createFile(name, content, mimeType) | File | Crée un fichier dans le dossier actuel avec le nom, le contenu et le type MIME indiqués. |
createFolder(name) | Folder | Crée un dossier avec le nom donné dans le dossier actuel. |
createShortcut(targetId) | File | Crée un raccourci vers l'ID de l'élément Drive fourni, puis l'affiche. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Crée un raccourci vers l'ID de l'élément Drive et la clé de ressource fournis, puis l'affiche. |
getAccess(email) | Permission | Récupère l'autorisation accordée à l'utilisateur donné. |
getAccess(user) | Permission | Récupère l'autorisation accordée à l'utilisateur donné. |
getDateCreated() | Date | Récupère la date de création de Folder . |
getDescription() | String | Récupère la description de Folder . |
getEditors() | User[] | Récupère la liste des éditeurs pour ce Folder . |
getFiles() | FileIterator | Récupère tous les fichiers enfants du dossier actuel. |
getFilesByName(name) | FileIterator | Récupère une collection de tous les fichiers enfants du dossier actuel et portant le nom donné. |
getFilesByType(mimeType) | FileIterator | Récupère tous les fichiers enfants du dossier actuel qui sont de type MIME. |
getFolders() | FolderIterator | Récupère une collection de tous les dossiers enfants du dossier actuel. |
getFoldersByName(name) | FolderIterator | Récupère une collection de tous les dossiers enfants du dossier actuel et portant le nom spécifié. |
getId() | String | Récupère l'ID de Folder . |
getLastUpdated() | Date | Récupère la date de la dernière mise à jour de Folder . |
getName() | String | Récupère le nom de Folder . |
getOwner() | User | Récupère le propriétaire de ce Folder . |
getParents() | FolderIterator | Récupère un ensemble de dossiers qui sont les parents immédiats de Folder . |
getResourceKey() | String | Récupère la clé de ressource de la classe Folder nécessaire pour accéder aux éléments partagés à l'aide d'un lien. |
getSecurityUpdateEligible() | Boolean | Détermine si cette Folder est éligible pour appliquer la mise à jour de sécurité nécessitant une clé de ressource pour l'accès lorsqu'elle est partagée à l'aide d'un lien. |
getSecurityUpdateEnabled() | Boolean | Détermine si cette Folder nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien. |
getSharingAccess() | Access | Permet d'identifier la classe d'utilisateur pouvant accéder au Folder , en plus des utilisateurs individuels auxquels un accès explicite a été accordé. |
getSharingPermission() | Permission | Récupère l'autorisation accordée aux utilisateurs ayant accès au Folder en plus des utilisateurs individuels disposant d'un accès explicite. |
getSize() | Integer | Récupère le nombre d'octets utilisés pour stocker l'élément Folder dans Drive. |
getUrl() | String | Récupère l'URL permettant d'ouvrir Folder dans une application Google telle que Drive ou Docs. |
getViewers() | User[] | Récupère la liste des lecteurs et des commentateurs pour ce Folder . |
isShareableByEditors() | Boolean | Détermine si les utilisateurs disposant de droits de modification sur Folder sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations. |
isStarred() | Boolean | Détermine si le Folder a été ajouté aux favoris dans le Drive de l'utilisateur. |
isTrashed() | Boolean | Détermine si Folder se trouve dans la corbeille du Drive de l'utilisateur. |
moveTo(destination) | Folder | Déplace cet élément vers le dossier de destination fourni. |
removeEditor(emailAddress) | Folder | Supprime l'utilisateur donné de la liste des éditeurs pour Folder . |
removeEditor(user) | Folder | Supprime l'utilisateur donné de la liste des éditeurs pour Folder . |
removeViewer(emailAddress) | Folder | Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour le Folder . |
removeViewer(user) | Folder | Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour le Folder . |
revokePermissions(emailAddress) | Folder | Révoque l'accès au Folder accordé à l'utilisateur donné. |
revokePermissions(user) | Folder | Révoque l'accès au Folder accordé à l'utilisateur donné. |
searchFiles(params) | FileIterator | Récupère tous les fichiers enfants du dossier actuel qui correspondent aux critères de recherche indiqués. |
searchFolders(params) | FolderIterator | Récupère un ensemble de dossiers enfants du dossier actuel qui correspondent aux critères de recherche indiqués. |
setDescription(description) | Folder | Définit la description de Folder . |
setName(name) | Folder | Définit le nom de Folder . |
setOwner(emailAddress) | Folder | Modifie le propriétaire de Folder . |
setOwner(user) | Folder | Modifie le propriétaire de Folder . |
setSecurityUpdateEnabled(enabled) | Folder | Définit si le Folder nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien. |
setShareableByEditors(shareable) | Folder | Indique si les utilisateurs autorisés à modifier le fichier Folder sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations. |
setSharing(accessType, permissionType) | Folder | Définit la classe des utilisateurs pouvant accéder à Folder et les autorisations accordées à ces utilisateurs, en plus des utilisateurs individuels disposant d'un accès explicite. |
setStarred(starred) | Folder | Indique si le suivi de Folder est activé dans le Drive de l'utilisateur. |
setTrashed(trashed) | Folder | Indique si Folder se trouve dans la corbeille du Drive de l'utilisateur. |
Documentation détaillée
addEditor(emailAddress)
Ajoute l'utilisateur donné à la liste des éditeurs pour Folder
. Si l'utilisateur figure déjà dans la liste, cette méthode le place hors de la liste.
Paramètres
Nom | Type | Description |
---|---|---|
emailAddress | String | Adresse e-mail de l'utilisateur à ajouter. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
addEditor(user)
Ajoute l'utilisateur donné à la liste des éditeurs pour Folder
. Si l'utilisateur figure déjà dans la liste, cette méthode le place hors de la liste.
Paramètres
Nom | Type | Description |
---|---|---|
user | User | Représentation de l'utilisateur à ajouter. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
addEditors(emailAddresses)
Ajoute le tableau d'utilisateurs donné à la liste des éditeurs pour Folder
. Si l'un des utilisateurs figure déjà dans la liste, cette méthode le place en dehors de la liste.
Paramètres
Nom | Type | Description |
---|---|---|
emailAddresses | String[] | Tableau des adresses e-mail des utilisateurs à ajouter. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
addViewer(emailAddress)
Ajoute l'utilisateur donné à la liste des lecteurs pour Folder
. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.
Paramètres
Nom | Type | Description |
---|---|---|
emailAddress | String | Adresse e-mail de l'utilisateur à ajouter. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
addViewer(user)
Ajoute l'utilisateur donné à la liste des lecteurs pour Folder
. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.
Paramètres
Nom | Type | Description |
---|---|---|
user | User | Représentation de l'utilisateur à ajouter. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
addViewers(emailAddresses)
Ajoute le tableau d'utilisateurs donné à la liste des lecteurs pour Folder
. Si l'un des utilisateurs figurait déjà dans la liste des éditeurs, cette méthode n'a aucun effet pour eux.
Paramètres
Nom | Type | Description |
---|---|---|
emailAddresses | String[] | Tableau des adresses e-mail des utilisateurs à ajouter. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
createFile(blob)
Crée un fichier dans le dossier actuel à partir d'un Blob
donné de données arbitraires.
// 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);
Paramètres
Nom | Type | Description |
---|---|---|
blob | BlobSource | Données du nouveau fichier. |
Aller-retour
File
: nouveau fichier.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
createFile(name, content)
Crée un fichier texte avec le nom et le contenu indiqués dans le dossier actuel. Génère une exception si la valeur de content
est supérieure à 50 Mo.
// Create a text file with the content "Hello, world!" DriveApp.getRootFolder().createFile('New Text File', 'Hello, world!');
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nom du nouveau fichier. |
content | String | Contenu du nouveau fichier. |
Aller-retour
File
: nouveau fichier.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
createFile(name, content, mimeType)
Crée un fichier dans le dossier actuel avec le nom, le contenu et le type MIME indiqués. Génère une exception si la valeur de content
est supérieure à 10 Mo.
// Create an HTML file with the content "Hello, world!" DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nom du nouveau fichier. |
content | String | Contenu du nouveau fichier. |
mimeType | String | Type MIME du nouveau fichier. |
Aller-retour
File
: nouveau fichier.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
createFolder(name)
Crée un dossier avec le nom donné dans le dossier actuel.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nom du nouveau dossier. |
Aller-retour
Folder
: nouveau dossier.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
createShortcut(targetId)
Crée un raccourci vers l'ID de l'élément Drive fourni, puis l'affiche.
Paramètres
Nom | Type | Description |
---|---|---|
targetId | String | ID du fichier ou du dossier cible. |
Aller-retour
File
: nouveau raccourci.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)
Crée un raccourci vers l'ID de l'élément Drive et la clé de ressource fournis, puis l'affiche. Une clé de ressource est un paramètre supplémentaire qui doit être transmis pour accéder au fichier ou au dossier cible qui a été partagé via un lien.
// 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()); }
Paramètres
Nom | Type | Description |
---|---|---|
targetId | String | ID du fichier ou dossier cible. |
targetResourceKey | String | Clé de la ressource du fichier ou du dossier cible. |
Aller-retour
File
: nouveau raccourci.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
getAccess(email)
Récupère l'autorisation accordée à l'utilisateur donné.
Paramètres
Nom | Type | Description |
---|---|---|
email | String | Adresse e-mail de l'utilisateur dont les autorisations doivent être vérifiées |
Aller-retour
Permission
: autorisations accordées à l'utilisateur
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAccess(user)
Récupère l'autorisation accordée à l'utilisateur donné.
Paramètres
Nom | Type | Description |
---|---|---|
user | User | Représentation de l'utilisateur dont les autorisations doivent être vérifiées |
Aller-retour
Permission
: autorisations accordées à l'utilisateur
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getDateCreated()
Récupère la date de création de Folder
.
Aller-retour
Date
: date à laquelle le Folder
a été créé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getDescription()
Récupère la description de Folder
.
Aller-retour
String
: description de Folder
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getEditors()
Récupère la liste des éditeurs pour ce Folder
. Si l'utilisateur qui exécute le script n'est pas autorisé à modifier Folder
, cette méthode renvoie un tableau vide.
// 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()); }
Aller-retour
User[]
: liste des éditeurs pour ce Folder
si l'utilisateur dispose d'un accès en modification ou d'un tableau vide dans le cas contraire.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getFiles()
Récupère tous les fichiers enfants du dossier actuel.
Aller-retour
FileIterator
: collection de tous les fichiers enfants du dossier actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getFilesByName(name)
Récupère une collection de tous les fichiers enfants du dossier actuel et portant le nom donné.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nom des fichiers à rechercher. |
Aller-retour
FileIterator
: collection de tous les fichiers enfants du dossier actuel et portant le nom donné
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getFilesByType(mimeType)
Récupère tous les fichiers enfants du dossier actuel qui sont de type MIME.
Paramètres
Nom | Type | Description |
---|---|---|
mimeType | String | Type MIME des fichiers à rechercher. |
Aller-retour
FileIterator
: collection de tous les fichiers enfants du dossier actuel et du type MIME donné.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getFolders()
Récupère une collection de tous les dossiers enfants du dossier actuel.
Aller-retour
FolderIterator
: collection de tous les dossiers enfants du dossier actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getFoldersByName(name)
Récupère une collection de tous les dossiers enfants du dossier actuel et portant le nom spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nom des dossiers à rechercher. |
Aller-retour
FolderIterator
: collection de tous les dossiers enfants du dossier actuel et portant le nom donné
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getId()
Récupère l'ID de Folder
.
Aller-retour
String
: ID de Folder
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getLastUpdated()
Récupère la date de la dernière mise à jour de Folder
.
Aller-retour
Date
: date de la dernière mise à jour de Folder
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getName()
Récupère le nom de Folder
.
Aller-retour
String
: nom de Folder
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getOwner()
Récupère le propriétaire de ce Folder
.
// 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());
Aller-retour
User
: propriétaire de la Folder
.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getParents()
Récupère un ensemble de dossiers qui sont les parents immédiats de Folder
.
Aller-retour
FolderIterator
: ensemble de dossiers qui sont les parents immédiats de Folder
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getResourceKey()
Récupère la clé de ressource de la classe Folder
nécessaire pour accéder aux éléments partagés à l'aide d'un lien.
Aller-retour
String
: clé de ressource de Folder
.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEligible()
Détermine si cette Folder
est éligible pour appliquer la mise à jour de sécurité nécessitant une clé de ressource pour l'accès lorsqu'elle est partagée à l'aide d'un lien.
Drive nécessite une clé de ressource pour accéder à certains fichiers ou dossiers partagés à l'aide d'un lien. Cette modification s'inscrit dans une mise à jour de sécurité. La mise à jour est activée par défaut pour les fichiers et les dossiers éligibles. Pour activer ou désactiver l'exigence de clé de ressource pour les fichiers éligibles, utilisez setSecurityUpdateEnabled
.
En savoir plus sur la mise à jour de sécurité pour Google Drive
Aller-retour
Boolean
: indique si l'exigence de clé de ressource peut être appliquée pour Folder
.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEnabled()
Détermine si cette Folder
nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien. Cette exigence est activée par défaut pour les fichiers et les dossiers éligibles.
Pour activer ou désactiver cette fonctionnalité pour les fichiers éligibles, utilisez
setSecurityUpdateEnabled
.
En savoir plus sur la mise à jour de sécurité pour Google Drive
Aller-retour
Boolean
: indique si l'exigence de clé de ressource est activée pour ce Folder
.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingAccess()
Permet d'identifier la classe d'utilisateur pouvant accéder au Folder
, en plus des utilisateurs individuels auxquels un accès explicite a été accordé.
Aller-retour
Access
: classe permettant d'accéder à Folder
.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingPermission()
Récupère l'autorisation accordée aux utilisateurs ayant accès au Folder
en plus des utilisateurs individuels disposant d'un accès explicite.
Aller-retour
Permission
: autorisations accordées aux utilisateurs ayant accès au Folder
.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSize()
Récupère le nombre d'octets utilisés pour stocker l'élément Folder
dans Drive. Notez que les fichiers d'application Google Workspace ne sont pas comptabilisés dans les limites de stockage Drive et renvoient donc 0
octets.
Aller-retour
Integer
: nombre d'octets utilisés pour stocker les Folder
dans Drive.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getUrl()
Récupère l'URL permettant d'ouvrir Folder
dans une application Google telle que Drive ou Docs.
Aller-retour
String
: URL permettant d'afficher ce Folder
dans une application Google telle que Drive ou Docs
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getViewers()
Récupère la liste des lecteurs et des commentateurs pour ce Folder
. Si l'utilisateur qui exécute le script n'est pas autorisé à modifier Folder
, cette méthode renvoie un tableau vide.
// 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()); }
Aller-retour
User[]
: liste des lecteurs et des commentateurs de ce Folder
si l'utilisateur dispose d'un accès en modification ou d'un tableau vide dans le cas contraire.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isStarred()
Détermine si le Folder
a été ajouté aux favoris dans le Drive de l'utilisateur.
Aller-retour
Boolean
: true
si le suivi est activé dans le Drive de l'utilisateur Folder
(false
, dans le cas contraire)
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isTrashed()
Détermine si Folder
se trouve dans la corbeille du Drive de l'utilisateur.
Aller-retour
Boolean
: true
si Folder
se trouve dans la corbeille du Drive de l'utilisateur
false
dans le cas contraire
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
moveTo(destination)
Déplace cet élément vers le dossier de destination fourni.
L'utilisateur actuel doit être le propriétaire du fichier ou disposer au moins d'un accès en modification au dossier parent actuel de l'élément pour le déplacer vers le dossier de destination.
Paramètres
Nom | Type | Description |
---|---|---|
destination | Folder | Dossier qui devient le nouveau parent. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
removeEditor(emailAddress)
Supprime l'utilisateur donné de la liste des éditeurs pour Folder
. Cette méthode n'empêche pas les utilisateurs d'accéder à Folder
s'ils appartiennent à une classe à accès général, par exemple si Folder
est partagé avec l'ensemble du domaine de l'utilisateur ou si Folder
se trouve dans un Drive partagé auquel l'utilisateur peut accéder.
Pour les fichiers Drive, l'utilisateur est également retiré de la liste des lecteurs.
Paramètres
Nom | Type | Description |
---|---|---|
emailAddress | String | Adresse e-mail de l'utilisateur à supprimer. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
removeEditor(user)
Supprime l'utilisateur donné de la liste des éditeurs pour Folder
. Cette méthode n'empêche pas les utilisateurs d'accéder à Folder
s'ils appartiennent à une classe à accès général, par exemple si Folder
est partagé avec l'ensemble du domaine de l'utilisateur ou si Folder
se trouve dans un Drive partagé auquel l'utilisateur peut accéder.
Pour les fichiers Drive, l'utilisateur est également retiré de la liste des lecteurs.
Paramètres
Nom | Type | Description |
---|---|---|
user | User | Représentation de l'utilisateur à supprimer. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
removeViewer(emailAddress)
Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour le Folder
. Cette méthode n'a aucun effet si l'utilisateur est éditeur, et non lecteur ou commentateur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder à Folder
s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple si Folder
est partagé avec l'ensemble de leur domaine ou si Folder
se trouve dans un Drive partagé auquel l'utilisateur peut accéder.
Pour les fichiers Drive, l'utilisateur est également retiré de la liste des éditeurs.
Paramètres
Nom | Type | Description |
---|---|---|
emailAddress | String | Adresse e-mail de l'utilisateur à supprimer. |
Aller-retour
Folder
: Folder
pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
removeViewer(user)
Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour le Folder
. Cette méthode n'a aucun effet si l'utilisateur est éditeur et non lecteur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder à Folder
s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple si Folder
est partagé avec l'ensemble du domaine de l'utilisateur ou si Folder
se trouve dans un Drive partagé auquel l'utilisateur peut accéder.
Pour les fichiers Drive, l'utilisateur est également retiré de la liste des éditeurs.
Paramètres
Nom | Type | Description |
---|---|---|
user | User | Représentation de l'utilisateur à supprimer. |
Aller-retour
Folder
: Folder
pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
revokePermissions(emailAddress)
Révoque l'accès au Folder
accordé à l'utilisateur donné. Cette méthode n'empêche pas les utilisateurs d'accéder à Folder
s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple si Folder
est partagé avec l'ensemble de leur domaine.
Paramètres
Nom | Type | Description |
---|---|---|
emailAddress | String | Adresse e-mail de l'utilisateur dont l'accès doit être révoqué. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
revokePermissions(user)
Révoque l'accès au Folder
accordé à l'utilisateur donné. Cette méthode n'empêche pas les utilisateurs d'accéder à Folder
s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple si Folder
est partagé avec l'ensemble de leur domaine.
Paramètres
Nom | Type | Description |
---|---|---|
user | User | Représentation de l'utilisateur dont l'accès doit être révoqué. |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
searchFiles(params)
Récupère tous les fichiers enfants du dossier actuel qui correspondent aux critères de recherche indiqués. Les critères de recherche sont détaillés dans la documentation du SDK Google Drive. Notez que le service Drive utilise la version 2 de l'API Drive et que certains champs de requête diffèrent de la version 3. Examinez les différences entre les champs V2 et V3.
L'argument params
est une chaîne de requête pouvant contenir des valeurs de chaîne. Veillez donc à échapper correctement les guillemets (par exemple, "title contains 'Gulliver\\'s
Travels'"
ou '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()); }
Paramètres
Nom | Type | Description |
---|---|---|
params | String | Critères de recherche détaillés dans la documentation du SDK Google Drive. |
Aller-retour
FileIterator
: ensemble de tous les fichiers enfants du dossier actuel et correspondant aux critères de recherche
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
searchFolders(params)
Récupère un ensemble de dossiers enfants du dossier actuel qui correspondent aux critères de recherche indiqués. Les critères de recherche sont détaillés dans la documentation du SDK Google Drive. Notez que le service Drive utilise la version 2 de l'API Drive et que certains champs de requête diffèrent de la version 3. Examinez les différences entre les champs V2 et V3.
L'argument params
est une chaîne de requête pouvant contenir des valeurs de chaîne. Veillez donc à échapper correctement les guillemets (par exemple, "title contains 'Gulliver\\'s
Travels'"
ou '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()); }
Paramètres
Nom | Type | Description |
---|---|---|
params | String | Critères de recherche détaillés dans la documentation du SDK Google Drive. |
Aller-retour
FolderIterator
: ensemble de tous les dossiers enfants du dossier actuel et correspondant aux critères de recherche
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
setDescription(description)
Définit la description de Folder
.
Paramètres
Nom | Type | Description |
---|---|---|
description | String | la nouvelle description de la Folder |
Aller-retour
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
setName(name)
Définit le nom de Folder
.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nouveau nom du Folder |
Aller-retour
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
setOwner(emailAddress)
Modifie le propriétaire de Folder
. Cette méthode accorde également au propriétaire précédent un accès en modification explicite à Folder
.
Paramètres
Nom | Type | Description |
---|---|---|
emailAddress | String | Adresse e-mail de l'utilisateur qui doit devenir le nouveau propriétaire |
Aller-retour
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
setOwner(user)
Modifie le propriétaire de Folder
. Cette méthode accorde également au propriétaire précédent un accès en modification explicite à Folder
.
Paramètres
Nom | Type | Description |
---|---|---|
user | User | une représentation de l'utilisateur qui doit devenir son nouveau propriétaire ; |
Aller-retour
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
setSecurityUpdateEnabled(enabled)
Définit si le Folder
nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien. Les fichiers et dossiers éligibles sont activés par défaut.
En savoir plus sur la mise à jour de sécurité pour Google Drive
Paramètres
Nom | Type | Description |
---|---|---|
enabled | Boolean | Permet d'activer ou non la clé de ressource requise pour le Folder . |
Aller-retour
Folder
: cet élément Folder
, pour le chaînage.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
setSharing(accessType, permissionType)
Définit la classe des utilisateurs pouvant accéder à Folder
et les autorisations accordées à ces utilisateurs, en plus des utilisateurs individuels disposant d'un accès explicite.
// 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);
Paramètres
Nom | Type | Description |
---|---|---|
accessType | Access | La classe des utilisateurs doit pouvoir accéder à Folder |
permissionType | Permission | les autorisations à accorder aux utilisateurs ayant accès au Folder |
Aller-retour
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
setStarred(starred)
Indique si le suivi de Folder
est activé dans le Drive de l'utilisateur. La valeur par défaut pour les nouveaux Folder
est false
.
Paramètres
Nom | Type | Description |
---|---|---|
starred | Boolean | true si l'utilisateur doit suivre Folder dans le Drive de l'utilisateur ; false dans le cas contraire |
Aller-retour
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive
setTrashed(trashed)
Indique si Folder
se trouve dans la corbeille du Drive de l'utilisateur. Seul le propriétaire peut placer Folder
dans la corbeille. La valeur par défaut pour les nouveaux Folder
est false
.
Paramètres
Nom | Type | Description |
---|---|---|
trashed | Boolean | true si l'élément Folder doit être placé dans la corbeille du Drive de l'utilisateur ; false dans le cas contraire. |
Aller-retour
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/drive