Class Folder

Dossier

Dossier dans Google Drive. Vous pouvez accéder aux dossiers ou en créer depuis DriveApp. 

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

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 donné à la liste des éditeurs de Folder.
addViewer(emailAddress)FolderAjoute l'utilisateur spécifié à la liste des spectateurs de Folder.
addViewer(user)FolderAjoute l'utilisateur spécifié à la liste des spectateurs de Folder.
addViewers(emailAddresses)FolderAjoute le tableau d'utilisateurs donné à la liste des spectateurs de Folder.
createFile(blob)FileCrée un fichier dans le dossier actuel à partir d'un Blob donné de données arbitraires.
createFile(name, content)FileCrée un fichier texte dans le dossier actuel avec le nom et le contenu indiqués.
createFile(name, content, mimeType)FileCrée un fichier dans le dossier actuel avec le nom, le contenu et le type MIME spécifiés.
createFolder(name)FolderCrée un dossier dans le dossier actuel avec le nom donné.
createShortcut(targetId)FileCrée un raccourci vers l'ID de l'élément Drive fourni et le renvoie.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrée un raccourci vers l'ID et la clé de ressource de l'élément Drive fournis, puis le renvoie.
getAccess(email)PermissionObtient l'autorisation accordée à un utilisateur spécifique.
getAccess(user)PermissionObtient l'autorisation accordée à un utilisateur spécifique.
getDateCreated()DateObtient la date de création de Folder.
getDescription()StringRécupère la description de Folder.
getEditors()User[]Obtient 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 portant le nom indiqué.
getFilesByType(mimeType)FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel et ayant le type MIME spécifié.
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 portant le nom indiqué.
getId()StringRécupère l'ID du Folder.
getLastUpdated()DateObtient la date de la dernière mise à jour de Folder.
getName()StringRécupère le nom du Folder.
getOwner()UserRécupère le propriétaire de ce Folder.
getParents()FolderIteratorObtient une collection de dossiers qui sont les parents immédiats de Folder.
getResourceKey()StringObtient la clé de ressource du Folder requise pour accéder aux éléments partagés à l'aide d'un lien.
getSecurityUpdateEligible()BooleanIndique si ce Folder peut appliquer la mise à jour de sécurité qui nécessite une clé d'accès à la ressource lorsqu'il est partagé à l'aide d'un lien.
getSecurityUpdateEnabled()BooleanIndique si ce Folder nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien.
getSharingAccess()AccessIndique la classe d'utilisateurs pouvant accéder à Folder, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
getSharingPermission()PermissionObtient l'autorisation accordée aux utilisateurs pouvant accéder à Folder, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
getSize()IntegerObtient le nombre d'octets utilisés pour stocker Folder dans Drive.
getUrl()StringObtient l'URL qui peut être utilisée pour ouvrir Folder dans une application Google telle que Drive ou Docs.
getViewers()User[]Obtient la liste des lecteurs et des commentateurs pour ce Folder.
isShareableByEditors()BooleanDétermine si les utilisateurs disposant d'autorisations de modification pour le Folder sont autorisés à le partager avec d'autres utilisateurs ou à modifier les autorisations.
isStarred()BooleanDétermine si le Folder a été ajouté aux favoris dans le Drive de l'utilisateur.
isTrashed()BooleanDétermine si Folder se trouve dans la corbeille Drive de l'utilisateur.
moveTo(destination)FolderDéplace cet élément vers le dossier de destination fourni.
removeEditor(emailAddress)FolderSupprime l'utilisateur donné de la liste des éditeurs pour le Folder.
removeEditor(user)FolderSupprime l'utilisateur donné de la liste des éditeurs pour le Folder.
removeViewer(emailAddress)FolderSupprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs du Folder.
removeViewer(user)FolderSupprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs du Folder.
revokePermissions(emailAddress)FolderRévoque l'accès à Folder accordé à l'utilisateur spécifié.
revokePermissions(user)FolderRévoque l'accès à Folder accordé à l'utilisateur spécifié.
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 qui correspondent aux critères de recherche spécifiés.
setDescription(description)FolderDéfinit la description de Folder.
setName(name)FolderDéfinit le nom de Folder.
setOwner(emailAddress)FolderModifie le propriétaire de Folder.
setOwner(user)FolderModifie le propriétaire de Folder.
setSecurityUpdateEnabled(enabled)FolderIndique si Folder nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien.
setShareableByEditors(shareable)FolderIndique si les utilisateurs disposant des droits de modification pour le Folder sont autorisés à le partager 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)FolderIndique si le Folder est favori dans le Drive de l'utilisateur.
setTrashed(trashed)FolderIndique 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 spectateurs, cette méthode le retire de cette liste.

Paramètres

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

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 spectateurs, cette méthode le retire de cette liste.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

addEditors(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de Folder. Si l'un des utilisateurs figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.

Paramètres

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

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

addViewer(emailAddress)

Ajoute l'utilisateur spécifié à la liste des spectateurs de Folder. Si l'utilisateur figure 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 : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

addViewer(user)

Ajoute l'utilisateur spécifié à la liste des spectateurs de Folder. Si l'utilisateur figure 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 : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

addViewers(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de Folder. Si l'un des utilisateurs figurait déjà dans la liste des éditeurs, cette méthode n'a aucun effet pour lui.

Paramètres

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

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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.

Paramètres

NomTypeDescription
blobBlobSourceDonnées du nouveau fichier.

Renvois

File : nouveau fichier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 indiqué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 avec un ou plusieurs des scopes 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 spécifiés. 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 avec un ou plusieurs des scopes suivants :

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

createFolder(name)

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

Paramètres

NomTypeDescription
nameStringNom du nouveau dossier.

Renvois

Folder : le nouveau dossier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

createShortcut(targetId)

Crée un raccourci vers l'ID de l'élément Drive fourni et le renvoie.

Paramètres

NomTypeDescription
targetIdStringID du fichier ou du dossier cible.

Renvois

File : le nouveau raccourci.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Crée un raccourci vers l'ID et la clé de ressource de l'élément Drive 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 : le nouveau raccourci.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getAccess(email)

Obtient l'autorisation accordée à un utilisateur spécifique. Cette méthode ne permet pas de renvoyer les autorisations pour un groupe Google ni les autorisations héritées via des groupes Google.

Paramètres

NomTypeDescription
emailStringAdresse e-mail de l'utilisateur dont les autorisations doivent être vérifiées. Google Groupes n'est pas accepté.

Renvois

Permission : autorisations accordées à l'utilisateur.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getAccess(user)

Obtient l'autorisation accordée à un utilisateur spécifique. Cette méthode ne permet pas de renvoyer les autorisations pour un groupe Google ni les autorisations héritées via des groupes Google.

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 avec un ou plusieurs des scopes suivants :

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

getDateCreated()

Obtient la date de création de Folder.

Renvois

Date : date de création de Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getEditors()

Obtient la liste des éditeurs pour ce Folder. Si l'utilisateur qui exécute le script n'a pas 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 (const 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 tableau vide dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 avec un ou plusieurs des scopes 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 portant le nom indiqué.

Paramètres

NomTypeDescription
nameStringNom des fichiers à rechercher.

Renvois

FileIterator : collection de tous les fichiers enfants du dossier actuel portant le nom indiqué.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 ayant le type MIME spécifié.

Paramètres

NomTypeDescription
mimeTypeStringType MIME des fichiers à rechercher.

Renvois

FileIterator : collection de tous les fichiers enfants du dossier actuel qui ont le type MIME donné.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 avec un ou plusieurs des scopes 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 portant le nom indiqué.

Paramètres

NomTypeDescription
nameStringNom des dossiers à trouver.

Renvois

FolderIterator : collection de tous les dossiers enfants du dossier actuel portant le nom indiqué.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getId()

Récupère l'ID du Folder.

Renvois

String : ID de Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getLastUpdated()

Obtient 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 avec un ou plusieurs des scopes suivants :

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

getName()

Récupère le nom du Folder.

Renvois

String : nom de l'Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 cet Folder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getParents()

Obtient une collection de dossiers qui sont les parents immédiats de Folder.

Renvois

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 scopes suivants :

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

getResourceKey()

Obtient 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 avec un ou plusieurs des scopes suivants :

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

getSecurityUpdateEligible()

Indique si ce Folder peut appliquer la mise à jour de sécurité qui nécessite une clé d'accès à la ressource lorsqu'il est partagé à l'aide d'un lien.

Drive nécessite une clé d'accès à la ressource pour accéder à certains fichiers ou dossiers qui ont été partagés à l'aide d'un lien. Cette modification fait partie 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 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

Renvois

Boolean : indique si l'exigence de clé de ressource peut être appliquée à Folder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getSecurityUpdateEnabled()

Indique si ce Folder nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien. Cette exigence est activée par défaut pour les fichiers et 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

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 avec un ou plusieurs des scopes suivants :

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

getSharingAccess()

Indique la classe d'utilisateurs pouvant accéder à Folder, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.

Renvois

Access : classe d'utilisateurs pouvant accéder à Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getSharingPermission()

Obtient 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 à Folder

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getSize()

Obtient le nombre d'octets utilisés pour stocker Folder dans Drive. Notez que les fichiers d'application Google Workspace ne sont pas pris en compte 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 avec un ou plusieurs des scopes suivants :

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

getUrl()

Obtient l'URL qui peut être utilisée pour ouvrir Folder dans une application Google telle que Drive ou Docs.

Renvois

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 scopes suivants :

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

getViewers()

Obtient la liste des lecteurs et des commentateurs pour ce Folder. Si l'utilisateur qui exécute le script n'a pas 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 viewers and logs their names to the console.
const viewers = folder.getViewers();
for (const viewer of viewers) {
  console.log(viewer.getName());
}

Renvois

User[] : liste des lecteurs et des commentateurs pour ce Folder si l'utilisateur dispose d'un accès en modification, ou tableau vide dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

isShareableByEditors()

Détermine si les utilisateurs disposant d'autorisations de modification pour Folder sont autorisés à partager le fichier avec d'autres utilisateurs ou à modifier les autorisations.

Renvois

Boolean — true si les utilisateurs disposant des droits de modification sont autorisés à partager le fichier 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 avec un ou plusieurs des scopes 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.

Renvois

Boolean : true si le 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 avec un ou plusieurs des scopes suivants :

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

isTrashed()

Détermine si Folder se trouve dans la corbeille Drive de l'utilisateur.

Renvois

Boolean : true si le 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 scopes 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 pouvoir le déplacer vers le dossier de destination.

Paramètres

NomTypeDescription
destinationFolderDossier qui devient le nouveau parent.

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

removeEditor(emailAddress)

Supprime l'utilisateur donné de la liste des éditeurs pour le Folder. Cette méthode n'empêche pas les utilisateurs d'accéder à 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 : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

removeEditor(user)

Supprime l'utilisateur donné de la liste des éditeurs pour le Folder. Cette méthode n'empêche pas les utilisateurs d'accéder à 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 : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

removeViewer(emailAddress)

Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs du 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 à 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).Folder

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 : ce Folder pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

removeViewer(user)

Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs du 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 à 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 : ce Folder pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

revokePermissions(emailAddress)

Révoque l'accès à Folder accordé à l'utilisateur spécifié. 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 du domaine de l'utilisateur).

Paramètres

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

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

revokePermissions(user)

Révoque l'accès à Folder accordé à l'utilisateur spécifié. 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 du domaine de l'utilisateur).

Paramètres

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

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 entre les champs des versions v2 et v3.

L'argument params est une chaîne de requête qui peut 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.""
const files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

Paramètres

NomTypeDescription
paramsStringCritères de recherche, comme indiqué dans la documentation du SDK Google Drive.

Renvois

FileIterator : collection de tous les fichiers enfants du dossier actuel qui correspondent aux critères de recherche.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 qui correspondent aux critères de recherche spécifié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 des versions v2 et v3.

L'argument params est une chaîne de requête qui peut 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.
const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

Paramètres

NomTypeDescription
paramsStringCritères de recherche, comme indiqué dans la documentation du SDK Google Drive.

Renvois

FolderIterator : collection de tous les dossiers enfants du dossier actuel qui correspondent aux critères de recherche.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 Folder ;

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setName(name)

Définit le nom de Folder.

Paramètres

NomTypeDescription
nameStringle nouveau nom de la Folder ;

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setOwner(emailAddress)

Modifie le propriétaire de Folder. Cette méthode accorde également à l'ancien propriétaire un accès explicite en modification à Folder.

Drive ne permet pas de modifier le propriétaire des éléments appartenant à des comptes gmail.com. Cette fonctionnalité est disponible pour les comptes Workspace.

Paramètres

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

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setOwner(user)

Modifie le propriétaire de Folder. Cette méthode accorde également à l'ancien propriétaire un accès explicite en modification à Folder.

Drive ne permet pas de modifier le propriétaire des éléments appartenant à des comptes gmail.com. Cette fonctionnalité est disponible pour les comptes Workspace.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur qui doit devenir le nouveau propriétaire.

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setSecurityUpdateEnabled(enabled)

Indique si 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

NomTypeDescription
enabledBooleanIndique si la clé de ressource est requise pour Folder.

Renvois

Folder : ce Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setShareableByEditors(shareable)

Indique si les utilisateurs disposant des droits de modification pour le Folder sont autorisés à le partager avec d'autres utilisateurs ou à modifier les autorisations. La valeur par défaut d'un nouveau Folder est true.

Paramètres

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

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Paramètres

NomTypeDescription
accessTypeAccessla classe d'utilisateurs qui doit pouvoir accéder à Folder.
permissionTypePermissionles autorisations à accorder aux utilisateurs pouvant accéder à Folder.

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setStarred(starred)

Indique si le Folder est favori dans le Drive de l'utilisateur. La valeur par défaut pour les nouveaux Folder est false.

Paramètres

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

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setTrashed(trashed)

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

Paramètres

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

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

Méthodes obsolètes