Class Folder

Dossier

Un dossier dans Google Drive. Les dossiers sont accessibles ou créés depuis 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éthodeType renvoyéBrève description
addEditor(emailAddress)FolderAjoute l'utilisateur donné à la liste des éditeurs pour Folder.
addEditor(user)FolderAjoute l'utilisateur donné à la liste des éditeurs pour Folder.
addEditors(emailAddresses)FolderAjoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Folder.
addViewer(emailAddress)FolderAjoute l'utilisateur donné à la liste des lecteurs pour Folder.
addViewer(user)FolderAjoute l'utilisateur donné à la liste des lecteurs pour Folder.
addViewers(emailAddresses)FolderAjoute le tableau d'utilisateurs donné à la liste des lecteurs pour Folder.
createFile(blob)FileCrée un fichier dans le dossier actuel à partir d'une Blob donnée de données arbitraires.
createFile(name, content)FileCrée un fichier texte dans le dossier actuel avec le nom et le contenu donnés.
createFile(name, content, mimeType)FileCrée un fichier dans le dossier actuel avec le nom donné, le contenu et le type MIME.
createFolder(name)FolderCrée un dossier portant le nom donné dans le dossier actuel.
createShortcut(targetId)FileCrée un raccourci vers l'ID d'élément Drive fourni, puis l'affiche.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrée un raccourci vers l'ID d'élément Drive et la clé de ressource fournis, puis le renvoie.
getAccess(email)PermissionRécupère l'autorisation accordée à l'utilisateur donné.
getAccess(user)PermissionRécupère l'autorisation accordée à l'utilisateur donné.
getDateCreated()DateRécupère la date de création de Folder.
getDescription()StringRécupère la description de Folder.
getEditors()User[]Récupère la liste des éditeurs pour ce Folder.
getFiles()FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel.
getFilesByName(name)FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel et portant le nom donné.
getFilesByType(mimeType)FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel et possédant le type MIME donné.
getFolders()FolderIteratorRécupère une collection de tous les dossiers enfants du dossier actuel.
getFoldersByName(name)FolderIteratorRécupère une collection de tous les dossiers enfants du dossier actuel et portant le nom donné.
getId()StringRécupère l'ID d'Folder.
getLastUpdated()DateRécupère la date de la dernière mise à jour de Folder.
getName()StringRécupère le nom de l'élément Folder.
getOwner()UserRécupère le propriétaire de ce Folder.
getParents()FolderIteratorRécupère une collection de dossiers parents immédiats de Folder.
getResourceKey()StringRécupère la clé de ressource du Folder requise pour accéder aux éléments partagés à l'aide d'un lien.
getSecurityUpdateEligible()BooleanDétermine si ce Folder est éligible à l'application de la mise à jour de sécurité nécessitant l'accès à une clé d'accès à la ressource lorsqu'il est partagé via un lien.
getSecurityUpdateEnabled()BooleanDétermine si ce Folder nécessite une clé d'accès à la ressource lorsqu'il est partagé via un lien.
getSharingAccess()AccessRécupère la classe d'utilisateurs qui peut accéder à Folder, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
getSharingPermission()PermissionRécupère l'autorisation accordée aux utilisateurs pouvant accéder à Folder, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
getSize()IntegerRécupère le nombre d'octets utilisés pour stocker le Folder dans Drive.
getUrl()StringRécupère l'URL permettant d'ouvrir le fichier Folder dans une application Google telle que Drive ou Docs.
getViewers()User[]Récupère la liste des lecteurs et des commentateurs de ce Folder.
isShareableByEditors()BooleanDétermine si les utilisateurs autorisés à modifier le Folder sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations.
isStarred()BooleanDétermine si Folder a été ajouté aux favoris dans le Drive de l'utilisateur.
isTrashed()BooleanDétermine si le Folder se trouve dans la corbeille du Drive de l'utilisateur.
moveTo(destination)FolderDéplace cet élément dans le dossier de destination fourni.
removeEditor(emailAddress)FolderSupprime l'utilisateur indiqué de la liste des éditeurs pour Folder.
removeEditor(user)FolderSupprime l'utilisateur indiqué de la liste des éditeurs pour Folder.
removeViewer(emailAddress)FolderSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Folder.
removeViewer(user)FolderSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Folder.
revokePermissions(emailAddress)FolderRévoque l'accès au Folder accordé à l'utilisateur donné.
revokePermissions(user)FolderRévoque l'accès au Folder accordé à l'utilisateur donné.
searchFiles(params)FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel et correspondant aux critères de recherche indiqués.
searchFolders(params)FolderIteratorRécupère une collection de tous les dossiers enfants du dossier actuel et correspondant aux critères de recherche donnés.
setDescription(description)FolderDéfinit la description de Folder.
setName(name)FolderDéfinit le nom de la Folder.
setOwner(emailAddress)FolderModifie le propriétaire de Folder.
setOwner(user)FolderModifie le propriétaire de Folder.
setSecurityUpdateEnabled(enabled)FolderDétermine si l'Folder nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
setShareableByEditors(shareable)FolderDétermine si les utilisateurs autorisés à modifier le Folder sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations.
setSharing(accessType, permissionType)FolderDéfinit la classe d'utilisateurs pouvant accéder à Folder et les autorisations qui leur sont accordées, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
setStarred(starred)FolderDétermine si Folder est ajouté aux favoris dans le Drive de l'utilisateur.
setTrashed(trashed)FolderDétermine si le 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 figurait déjà dans la liste des visiteurs, cette méthode l'exclut de la liste.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 figurait déjà dans la liste des visiteurs, cette méthode l'exclut de la liste.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

addEditors(emailAddresses)

Ajoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Folder. Si l'un des utilisateurs figurait déjà dans la liste des lecteurs, cette méthode l'exclut de la liste.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 figurait déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 figurait déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 sur lui.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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'une Blob donnée 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

NomTypeDescription
blobBlobSourceDonnées du nouveau fichier.

Renvois

File : nouveau fichier

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

createFile(name, content)

Crée un fichier texte dans le dossier actuel avec le nom et le contenu donnés. Génère une exception si content est supérieur à 50 Mo.

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

Paramètres

NomTypeDescription
nameStringNom du nouveau fichier.
contentStringContenu du nouveau fichier.

Renvois

File : nouveau fichier

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 donné, le contenu et le type MIME. Génère une exception si content est supérieur à 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

NomTypeDescription
nameStringNom du nouveau fichier.
contentStringContenu du nouveau fichier.
mimeTypeStringType MIME du nouveau fichier.

Renvois

File : nouveau fichier

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

createFolder(name)

Crée un dossier portant le nom donné dans le dossier actuel.

Paramètres

NomTypeDescription
nameStringNom du nouveau dossier.

Renvois

Folder : nouveau dossier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

createShortcut(targetId)

Crée un raccourci vers l'ID d'élément Drive fourni, puis l'affiche.

Paramètres

NomTypeDescription
targetIdStringID du fichier ou du dossier cible.

Renvois

File : nouveau raccourci.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Crée un raccourci vers l'ID d'élément Drive et la clé de ressource fournis, puis le renvoie. 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é à l'aide d'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

NomTypeDescription
targetIdStringID du fichier ou du dossier cible.
targetResourceKeyStringClé de ressource du fichier ou du dossier cible.

Renvois

File : nouveau raccourci.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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

NomTypeDescription
emailStringL'adresse e-mail de l'utilisateur dont les autorisations doivent être vérifiées

Renvois

Permission : autorisations accordées à l'utilisateur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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

NomTypeDescription
userUserreprésentation de l'utilisateur dont les autorisations doivent être vérifiées

Renvois

Permission : autorisations accordées à l'utilisateur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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.

Renvois

Date : date de création de l'élément Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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.

Renvois

String : description de l'élément Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 ne dispose pas d'un accès en modification à 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());
}

Renvois

User[] : liste des éditeurs 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 associée à 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 une collection de tous les fichiers enfants du dossier actuel.

Renvois

FileIterator : collection de tous les fichiers enfants du dossier actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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

NomTypeDescription
nameStringNom des fichiers à rechercher.

Renvois

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 associée à 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 une collection de tous les fichiers enfants du dossier actuel et possédant le type MIME donné.

Paramètres

NomTypeDescription
mimeTypeStringType MIME des fichiers à rechercher.

Renvois

FileIterator : collection de tous les fichiers enfants du dossier actuel et possédant le type MIME donné.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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.

Renvois

FolderIterator : collection de tous les dossiers enfants du dossier actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 donné.

Paramètres

NomTypeDescription
nameStringNom des dossiers à rechercher.

Renvois

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 associée à 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 d'Folder.

Renvois

String : ID du Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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.

Renvois

Date : date de la dernière mise à jour de Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 l'élément Folder.

Renvois

String : nom du Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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());

Renvois

User : propriétaire de ce Folder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 une collection de dossiers parents immédiats de Folder.

Renvois

FolderIterator : collection de dossiers parents immédiats de Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 du Folder requise pour accéder aux éléments partagés à l'aide d'un lien.

Renvois

String : clé de ressource de Folder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 ce Folder est éligible à l'application de la mise à jour de sécurité nécessitant l'accès à une clé d'accès à la ressource lorsqu'il est partagé via un lien.

Drive a besoin d'une clé d'accès à certains fichiers ou dossiers partagés via un lien. Cette modification s'inscrit dans le cadre d'une mise à jour de sécurité. La mise à jour est activée par défaut pour les fichiers et dossiers éligibles. Pour activer ou désactiver la condition de clé de ressource pour les fichiers éligibles, utilisez setSecurityUpdateEnabled.

En savoir plus sur la mise à jour de sécurité pour Google Drive

Renvois

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 associée à 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 ce Folder nécessite une clé d'accès à la ressource lorsqu'il est partagé via un lien. Cette exigence est activée par défaut pour les fichiers et dossiers éligibles. Pour activer ou désactiver la condition de clé d'accès aux fichiers éligibles, utilisez setSecurityUpdateEnabled.

En savoir plus sur la mise à jour de sécurité pour Google Drive

Renvois

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 associée à un ou plusieurs des champs d'application suivants:

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

getSharingAccess()

Récupère la classe d'utilisateurs qui peut accéder à Folder, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.

Renvois

Access : classe d'utilisateurs qui peut accéder à Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 pouvant accéder à Folder, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.

Renvois

Permission : autorisations accordées aux utilisateurs pouvant accéder au Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 le 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.

Renvois

Integer : nombre d'octets utilisés pour stocker Folder dans Drive

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 le fichier Folder dans une application Google telle que Drive ou Docs.

Renvois

String : URL permettant d'afficher ce Folder dans une appli Google telle que Drive ou Docs

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 de ce Folder. Si l'utilisateur qui exécute le script n'est pas autorisé à modifier le 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());
}

Renvois

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 associée à un ou plusieurs des champs d'application suivants:

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

isShareableByEditors()

Détermine si les utilisateurs autorisés à modifier le Folder sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations.

Renvois

Boolean : true si les utilisateurs disposant de droits de modification sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations, false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 Folder a été ajouté aux favoris dans le Drive de l'utilisateur.

Renvois

Boolean : true si Folder est suivi dans le Drive de l'utilisateur ; false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 le Folder se trouve dans la corbeille du Drive de l'utilisateur.

Renvois

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 associée à 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 dans 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 pouvoir le déplacer vers le dossier de destination.

Paramètres

NomTypeDescription
destinationFolderDossier qui devient le nouveau parent.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

removeEditor(emailAddress)

Supprime l'utilisateur indiqué de la liste des éditeurs pour Folder. Cette méthode n'empêche pas les utilisateurs d'accéder au Folder s'ils appartiennent à une classe d'utilisateurs disposant d'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, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

removeEditor(user)

Supprime l'utilisateur indiqué de la liste des éditeurs pour Folder. Cette méthode n'empêche pas les utilisateurs d'accéder au Folder s'ils appartiennent à une classe d'utilisateurs disposant d'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, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

removeViewer(emailAddress)

Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Folder. Cette méthode n'a aucun effet si l'utilisateur est un éditeur, et non un lecteur ou un commentateur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder au Folder s'ils appartiennent à une classe d'utilisateurs disposant d'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, cela supprime également l'utilisateur de la liste des éditeurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

Folder : Folder pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

removeViewer(user)

Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Folder. Cette méthode n'a aucun effet si l'utilisateur est un éditeur, et non un lecteur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder au Folder s'ils appartiennent à une classe d'utilisateurs disposant d'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, cela supprime également l'utilisateur de la liste des éditeurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

Folder : Folder pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 au Folder s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si Folder est partagé avec l'ensemble du domaine de l'utilisateur).

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur dont l'accès doit être révoqué.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 au Folder s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si Folder est partagé avec l'ensemble du domaine de l'utilisateur).

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur dont l'accès doit être révoqué.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

searchFiles(params)

Récupère une collection de tous les fichiers enfants du dossier actuel et correspondant 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 de champs entre les versions 2 et 3.

L'argument params est une chaîne de requête pouvant contenir des valeurs de chaîne. Veillez donc à bien échapper 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

NomTypeDescription
paramsStringLes critères de recherche, tels que détaillés dans la documentation du SDK Google Drive

Renvois

FileIterator : collection 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 associée à 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 une collection de tous les dossiers enfants du dossier actuel et correspondant aux critères de recherche donné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 de champs entre les versions 2 et 3.

L'argument params est une chaîne de requête pouvant contenir des valeurs de chaîne. Veillez donc à bien échapper 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

NomTypeDescription
paramsStringLes critères de recherche, tels que détaillés dans la documentation du SDK Google Drive

Renvois

FolderIterator : collection 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 associée à 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

NomTypeDescription
descriptionStringla nouvelle description de l'élément Folder

Renvois

Folder : cette Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setName(name)

Définit le nom de la Folder.

Paramètres

NomTypeDescription
nameStringle nouveau nom de l'appareil Folder ;

Renvois

Folder : cette Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 au Folder.

Paramètres

NomTypeDescription
emailAddressStringL'adresse e-mail de l'utilisateur qui doit devenir le nouveau propriétaire

Renvois

Folder : cette Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 au Folder.

Paramètres

NomTypeDescription
userUserune représentation de l'utilisateur qui doit devenir le nouveau propriétaire

Renvois

Folder : cette Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setSecurityUpdateEnabled(enabled)

Détermine si l'Folder nécessite une clé d'accès à la ressource lorsqu'elle est partagée via 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

NomTypeDescription
enabledBooleanActiver ou non l'exigence de clé de ressource pour Folder.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setShareableByEditors(shareable)

Détermine si les utilisateurs autorisés à modifier le Folder sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations. La valeur par défaut pour un nouveau Folder est true.

Paramètres

NomTypeDescription
shareableBooleantrue si les utilisateurs disposant de droits de modification doivent être autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations ; false dans le cas contraire ;

Renvois

Folder : cette Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setSharing(accessType, permissionType)

Définit la classe d'utilisateurs pouvant accéder à Folder et les autorisations qui leur sont accordées, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.

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

NomTypeDescription
accessTypeAccessquelle classe d'utilisateurs doit pouvoir accéder à Folder
permissionTypePermissionles autorisations à accorder aux utilisateurs ayant accès au Folder.

Renvois

Folder : cette Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setStarred(starred)

Détermine si Folder est ajouté aux favoris dans le Drive de l'utilisateur. La valeur par défaut pour les nouvelles Folder est false.

Paramètres

NomTypeDescription
starredBooleantrue si Folder doit être ajouté aux favoris dans le Drive de l'utilisateur ; false dans le cas contraire

Renvois

Folder : cette Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setTrashed(trashed)

Détermine si le Folder se trouve dans la corbeille du Drive de l'utilisateur. Seul le propriétaire peut mettre la Folder dans la corbeille. La valeur par défaut pour les nouveaux éléments Folder est false.

Paramètres

NomTypeDescription
trashedBooleantrue si Folder doit être placé dans la corbeille du Drive de l'utilisateur ; false dans le cas contraire ;

Renvois

Folder : cette Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

Méthodes obsolètes