Cette page a été traduite par l'API Cloud Translation.

Class Folder

Dossier dans Google Drive Vous pouvez accéder aux dossiers ou en créer à partir de 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éthode	Type renvoyé	Brève description
`addEditor(emailAddress)`	`Folder`	Ajoute l'utilisateur donné à la liste des éditeurs de l'`Folder`.
`addEditor(user)`	`Folder`	Ajoute l'utilisateur donné à la liste des éditeurs de l'`Folder`.
`addEditors(emailAddresses)`	`Folder`	Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de l'`Folder`.
`addViewer(emailAddress)`	`Folder`	Ajoute l'utilisateur donné à la liste des spectateurs de l'`Folder`.
`addViewer(user)`	`Folder`	Ajoute l'utilisateur donné à la liste des spectateurs de l'`Folder`.
`addViewers(emailAddresses)`	`Folder`	Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de l'`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 dans le répertoire actuel avec le nom et le contenu donnés.
`createFile(name, content, mimeType)`	`File`	Crée un fichier dans le dossier actuel avec le nom, le contenu et le type MIME donnés.
`createFolder(name)`	`Folder`	Crée un dossier dans le dossier actuel avec le nom donné.
`createShortcut(targetId)`	`File`	Crée un raccourci vers l'ID d'élément Drive fourni, puis le renvoie.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Crée un raccourci vers l'ID de l'élément Drive et la clé de ressource fournis, puis le renvoie.
`getAccess(email)`	`Permission`	Récupère l'autorisation accordée à un utilisateur spécifique.
`getAccess(user)`	`Permission`	Récupère l'autorisation accordée à un utilisateur spécifique.
`getDateCreated()`	`Date`	Récupère la date de création de l'`Folder`.
`getDescription()`	`String`	Récupère la description de l'`Folder`.
`getEditors()`	`User[]`	Récupère la liste des éditeurs de cet objet `Folder`.
`getFiles()`	`FileIterator`	Récupère une collection de tous les fichiers qui sont enfants du dossier actuel.
`getFilesByName(name)`	`FileIterator`	Récupère une collection de tous les fichiers qui sont enfants du dossier actuel et portent le nom donné.
`getFilesByType(mimeType)`	`FileIterator`	Récupère une collection de tous les fichiers enfants du dossier actuel et ayant le type MIME donné.
`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 qui sont enfants du dossier actuel et portent le nom donné.
`getId()`	`String`	Récupère l'ID du `Folder`.
`getLastUpdated()`	`Date`	Récupère la date de la dernière mise à jour de l'`Folder`.
`getName()`	`String`	Récupère le nom de l'`Folder`.
`getOwner()`	`User`	Récupère le propriétaire de cet élément `Folder`.
`getParents()`	`FolderIterator`	Récupère une collection de dossiers qui sont des parents immédiats de l'`Folder`.
`getResourceKey()`	`String`	Récupère la clé de ressource de l'`Folder` requise pour accéder aux éléments partagés à l'aide d'un lien.
`getSecurityUpdateEligible()`	`Boolean`	Indique si cet élément `Folder` peut appliquer la mise à jour de sécurité qui nécessite une clé d'accès aux ressources lorsqu'il est partagé à l'aide d'un lien.
`getSecurityUpdateEnabled()`	`Boolean`	Indique si cet élément `Folder` nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien.
`getSharingAccess()`	`Access`	Permet d'obtenir la classe d'utilisateurs pouvant accéder à `Folder`, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`getSharingPermission()`	`Permission`	Récupère l'autorisation accordée aux utilisateurs pouvant accéder à `Folder`, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`getSize()`	`Integer`	Récupère le nombre d'octets utilisés pour stocker le `Folder` dans Drive.
`getUrl()`	`String`	Récupère l'URL permettant d'ouvrir le `Folder` dans une application Google telle que Drive ou Docs.
`getViewers()`	`User[]`	Récupère la liste des lecteurs et des commentateurs de cet `Folder`.
`isShareableByEditors()`	`Boolean`	Détermine si les utilisateurs disposant d'autorisations de modification pour le `Folder` sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
`isStarred()`	`Boolean`	Détermine si l'`Folder` a été ajouté aux favoris dans Drive de l'utilisateur.
`isTrashed()`	`Boolean`	Détermine si l'`Folder` se trouve dans la corbeille de 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 de l'`Folder`.
`removeEditor(user)`	`Folder`	Supprime l'utilisateur donné de la liste des éditeurs de l'`Folder`.
`removeViewer(emailAddress)`	`Folder`	Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'`Folder`.
`removeViewer(user)`	`Folder`	Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'`Folder`.
`revokePermissions(emailAddress)`	`Folder`	Révoque l'accès à l'`Folder` accordé à l'utilisateur donné.
`revokePermissions(user)`	`Folder`	Révoque l'accès à l'`Folder` accordé à l'utilisateur donné.
`searchFiles(params)`	`FileIterator`	Récupère une collection de tous les fichiers qui sont enfants du dossier actuel et correspondent aux critères de recherche donnés.
`searchFolders(params)`	`FolderIterator`	Récupère une collection de tous les dossiers qui sont enfants du dossier actuel et correspondent aux critères de recherche donnés.
`setDescription(description)`	`Folder`	Définit la description de `Folder`.
`setName(name)`	`Folder`	Définit le nom de l'`Folder`.
`setOwner(emailAddress)`	`Folder`	Modifie le propriétaire de l'`Folder`.
`setOwner(user)`	`Folder`	Modifie le propriétaire de l'`Folder`.
`setSecurityUpdateEnabled(enabled)`	`Folder`	Indique si `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 disposant des autorisations de modification de l'`Folder` sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
`setSharing(accessType, permissionType)`	`Folder`	Définit la classe d'utilisateurs pouvant accéder à `Folder` et les autorisations accordées à ces utilisateurs, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`setStarred(starred)`	`Folder`	Indique si l'`Folder` est ajouté aux favoris dans Drive de l'utilisateur.
`setTrashed(trashed)`	`Folder`	Définit si l'`Folder` se trouve dans la corbeille de Drive de l'utilisateur.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`addFile(child)`	`Folder`	Ajoute le fichier donné au dossier actuel.
`addFolder(child)`	`Folder`	Ajoute le dossier donné au dossier actuel.
`removeFile(child)`	`Folder`	Supprime le fichier donné du dossier actuel.
`removeFolder(child)`	`Folder`	Supprime le dossier donné du dossier actuel.

Documentation détaillée

`addEditor(emailAddress)`

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

Paramètres

Nom	Type	Description
`emailAddress`	`String`	Adresse 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 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 de l'Folder. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le supprime de la liste.

Paramètres

Nom	Type	Description
`user`	`User`	Représentation de l'utilisateur à ajouter.

Renvois

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

`addEditors(emailAddresses)`

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

Paramètres

Nom	Type	Description
`emailAddresses`	`String[]`	Tableau d'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 avec un ou plusieurs des champs d'application suivants:

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

`addViewer(emailAddress)`

Ajoute l'utilisateur donné à la liste des spectateurs de l'Folder. Si l'utilisateur figurait 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.

Renvois

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

`addViewer(user)`

Ajoute l'utilisateur donné à la liste des spectateurs de l'Folder. Si l'utilisateur figurait 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.

Renvois

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

`addViewers(emailAddresses)`

Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de l'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

Nom	Type	Description
`emailAddresses`	`String[]`	Tableau d'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 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.

Paramètres

Nom	Type	Description
`blob`	`BlobSource`	Donné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 champs d'application suivants:

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

`createFile(name, content)`

Crée un fichier texte dans le répertoire 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

Nom	Type	Description
`name`	`String`	Nom du nouveau fichier.
`content`	`String`	Contenu du nouveau fichier.

Renvois

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 donné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

Nom	Type	Description
`name`	`String`	Nom du nouveau fichier.
`content`	`String`	Contenu du nouveau fichier.
`mimeType`	`String`	Type 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 champs d'application suivants:

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

`createFolder(name)`

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

Paramètres

Nom	Type	Description
`name`	`String`	Nom du nouveau dossier.

Renvois

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 d'élément Drive fourni, puis le renvoie.

Paramètres

Nom	Type	Description
`targetId`	`String`	ID du fichier ou du dossier cible.

Renvois

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

Nom	Type	Description
`targetId`	`String`	ID du fichier ou du dossier cible.
`targetResourceKey`	`String`	Clé de ressource du fichier ou du dossier cible.

Renvois

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 à un utilisateur spécifique. La méthode ne permet pas de renvoyer les autorisations d'un groupe Google ni les autorisations héritées via Google Groupes.

Paramètres

Nom	Type	Description
`email`	`String`	Adresse e-mail de l'utilisateur dont les autorisations doivent être vérifiées. Google Groupes n'est pas compatible.

Renvois

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 à un utilisateur spécifique. La méthode ne permet pas de renvoyer les autorisations d'un groupe Google ni les autorisations héritées via Google Groupes.

Paramètres

Nom	Type	Description
`user`	`User`	Repré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 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 l'Folder.

Renvois

Date : date de création de l'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

`getDescription()`

Récupère la description de l'Folder.

Renvois

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 de cet objet 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 cet élément 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 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 qui sont 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 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 qui sont enfants du dossier actuel et portent le nom donné.

Paramètres

Nom	Type	Description
`name`	`String`	Nom des fichiers à rechercher.

Renvois

FileIterator : ensemble 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 une collection de tous les fichiers enfants du dossier actuel et ayant le type MIME donné.

Paramètres

Nom	Type	Description
`mimeType`	`String`	Type MIME des fichiers à rechercher.

Renvois

FileIterator : ensemble de tous les fichiers qui sont enfants du dossier actuel et qui ont le 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.

Renvois

FolderIterator : ensemble 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 qui sont enfants du dossier actuel et portent le nom donné.

Paramètres

Nom	Type	Description
`name`	`String`	Nom des dossiers à rechercher.

Renvois

FolderIterator : ensemble 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 du Folder.

Renvois

String : ID de l'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 l'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 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'Folder.

Renvois

String : nom de l'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 cet élément 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 élément 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 une collection de dossiers qui sont des parents immédiats de l'Folder.

Renvois

FolderIterator : ensemble de dossiers qui sont des parents immédiats de l'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 l'Folder requise pour accéder aux éléments partagés à l'aide d'un lien.

Renvois

String : clé de ressource de l'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()`

Indique si cet élément Folder peut appliquer la mise à jour de sécurité qui nécessite une clé d'accès aux ressources 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 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 à 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

`getSecurityUpdateEnabled()`

Indique si cet élément 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 cette 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'obtenir la classe d'utilisateurs pouvant accéder à Folder, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.

Renvois

Access : classe d'utilisateurs autorisés à 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 pouvant accéder à Folder, en plus des utilisateurs individuels auxquels un 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 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 inclus dans les limites de stockage Drive et renvoient donc 0 octets.

Renvois

Integer : nombre d'octets utilisés pour stocker le 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 le Folder dans une application Google telle que Drive ou Docs.

Renvois

String : URL permettant d'afficher cette 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 de cet 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 de cet élément 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 champs d'application 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 le Folder sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.

Renvois

Boolean : true si les utilisateurs disposant des autorisations de modification sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations ; false sinon

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 l'Folder a été ajouté aux favoris dans Drive de l'utilisateur.

Renvois

Boolean : true si l'Folder est suivi dans Drive de l'utilisateur, false sinon

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 l'Folder se trouve dans la corbeille de Drive de l'utilisateur.

Renvois

Boolean : true si le Folder se trouve dans la corbeille de 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 pouvoir le déplacer vers le dossier de destination.

Paramètres

Nom	Type	Description
`destination`	`Folder`	Dossier qui devient le nouveau parent.

Renvois

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

`removeEditor(emailAddress)`

Supprime l'utilisateur donné de la liste des éditeurs de l'Folder. Cette méthode n'empêche pas les utilisateurs d'accéder à l'Folder s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si l'Folder est partagé avec l'ensemble du domaine de l'utilisateur ou si l'Folder se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des lecteurs.

Paramètres

Nom	Type	Description
`emailAddress`	`String`	Adresse 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 avec un ou plusieurs des champs d'application suivants:

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

`removeEditor(user)`

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des lecteurs.

Paramètres

Nom	Type	Description
`user`	`User`	Représentation de l'utilisateur à supprimer.

Renvois

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(emailAddress)`

Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'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 à l'Folder s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si l'Folder est partagée avec l'ensemble du domaine de l'utilisateur ou si l'Folder se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des éditeurs.

Paramètres

Nom	Type	Description
`emailAddress`	`String`	Adresse 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 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 spectateurs et des commentateurs de l'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, l'utilisateur est également supprimé de la liste des éditeurs.

Paramètres

Nom	Type	Description
`user`	`User`	Représentation de l'utilisateur à supprimer.

Renvois

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 à l'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 disposant d'un accès général (par exemple, si Folder est partagé avec l'ensemble du domaine de l'utilisateur).

Paramètres

Nom	Type	Description
`emailAddress`	`String`	Adresse 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 avec un ou plusieurs des champs d'application suivants:

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

`revokePermissions(user)`

Paramètres

Nom	Type	Description
`user`	`User`	Repré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 avec 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 qui sont enfants du dossier actuel et correspondent 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. Consultez les différences entre les champs de la version v2 et de la version 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.""
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

Nom	Type	Description
`params`	`String`	Les critères de recherche, comme indiqué dans la documentation du SDK Google Drive.

Renvois

FileIterator : ensemble de tous les fichiers qui sont enfants du dossier actuel et qui correspondent 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 une collection de tous les dossiers qui sont enfants du dossier actuel et correspondent 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. Consultez les différences entre les champs de la version v2 et de la version v3.

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

Nom	Type	Description
`params`	`String`	Les critères de recherche, comme indiqué dans la documentation du SDK Google Drive.

Renvois

FolderIterator : ensemble de tous les dossiers qui sont enfants du dossier actuel et qui correspondent 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 l'`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 champs d'application suivants:

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

`setName(name)`

Définit le nom de l'Folder.

Paramètres

Nom	Type	Description
`name`	`String`	le nouveau nom du `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 champs d'application suivants:

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

`setOwner(emailAddress)`

Modifie le propriétaire de l'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`	l'adresse e-mail de l'utilisateur qui doit devenir le nouveau propriétaire ;

Renvois

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

`setOwner(user)`

Modifie le propriétaire de l'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 le nouveau propriétaire

Renvois

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

`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

Nom	Type	Description
`enabled`	`Boolean`	Indique si la clé de ressource est requise pour `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 champs d'application suivants:

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

`setShareableByEditors(shareable)`

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

Paramètres

Nom	Type	Description
`shareable`	`Boolean`	`true` si les utilisateurs disposant des autorisations de modification doivent être autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations ; `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 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 accordées à ces utilisateurs, en plus des utilisateurs individuels auxquels un 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

Nom	Type	Description
`accessType`	`Access`	la classe d'utilisateurs qui doit pouvoir accéder à `Folder`
`permissionType`	`Permission`	les autorisations à accorder aux utilisateurs autorisés à 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 champs d'application suivants:

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

`setStarred(starred)`

Indique si l'Folder est ajouté aux favoris dans 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'`Folder` doit être ajouté aux favoris dans Drive de l'utilisateur ; `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 champs d'application suivants:

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

`setTrashed(trashed)`

Indique si l'Folder se trouve dans la corbeille de Drive de l'utilisateur. Seul le propriétaire peut placer l'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'`Folder` doit être déplacé vers la corbeille de Drive de l'utilisateur ; `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 champs d'application suivants:

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

Méthodes obsolètes

`addFile(child)`

Obsolète. Utilisez plutôt File.moveTo(destination) ou createShortcut(targetId).

Ajoute le fichier donné au dossier actuel. Cette méthode ne déplace pas le fichier hors de son dossier parent existant. Un fichier peut avoir plusieurs parents simultanément.

Paramètres

Nom	Type	Description
`child`	`File`	Fichier enfant à ajouter.

Renvois

Folder : nouveau parent du fichier ajouté en tant qu'enfant.

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

`addFolder(child)`

Obsolète. Utilisez plutôt moveTo(destination) ou createShortcut(targetId).

Ajoute le dossier donné au dossier actuel. Cette méthode ne déplace pas le dossier hors de son dossier parent existant. Un dossier peut avoir plusieurs parents simultanément.

Paramètres

Nom	Type	Description
`child`	`Folder`	Dossier enfant à ajouter.

Renvois

Folder : nouveau parent du dossier ajouté en tant qu'enfant.

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

`removeFile(child)`

Obsolète. Utilisez plutôt File.moveTo(destination).

Supprime le fichier donné du dossier actuel. Cette méthode ne supprime pas le fichier, mais si un fichier est supprimé de tous ses parents, il ne peut pas être vu dans Drive, sauf en le recherchant ou en utilisant la vue "Tous les éléments".

Paramètres

Nom	Type	Description
`child`	`File`	Fichier enfant à supprimer.

Renvois

Folder : parent précédent de l'enfant.

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

`removeFolder(child)`

Obsolète. Utilisez plutôt moveTo(destination).

Supprime le dossier donné du dossier actuel. Cette méthode ne supprime pas le dossier ni son contenu, mais si un dossier est supprimé de tous ses parents, il ne peut pas être vu dans Drive, sauf en le recherchant ou en utilisant la vue "Tous les éléments".

Paramètres

Nom	Type	Description
`child`	`Folder`	Dossier enfant à supprimer.

Renvois

Folder : parent précédent de l'enfant.

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