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

Class Folder

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éthode	Type renvoyé	Brève description
`addEditor(emailAddress)`	`Folder`	Ajoute l'utilisateur donné à la liste des éditeurs de `Folder`.
`addEditor(user)`	`Folder`	Ajoute l'utilisateur donné à la liste des éditeurs de `Folder`.
`addEditors(emailAddresses)`	`Folder`	Ajoute le tableau d'utilisateurs donné à la liste des éditeurs pour `Folder`.
`addViewer(emailAddress)`	`Folder`	Ajoute l'utilisateur donné à la liste des lecteurs de `Folder`.
`addViewer(user)`	`Folder`	Ajoute l'utilisateur donné à la liste des lecteurs de `Folder`.
`addViewers(emailAddresses)`	`Folder`	Ajoute le tableau d'utilisateurs donné à la liste des lecteurs pour `Folder`.
`createFile(blob)`	`File`	Crée un fichier dans le dossier actuel à partir d'un `Blob` donné de données arbitraires.
`createFile(name, content)`	`File`	Crée un fichier texte avec le nom et le contenu indiqués dans le dossier actuel.
`createFile(name, content, mimeType)`	`File`	Crée un fichier avec le nom, le contenu et le type MIME dans le dossier actuel.
`createFolder(name)`	`Folder`	Crée un dossier portant le nom donné dans le dossier actuel.
`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 d'élément Drive et la clé de ressource fournis, puis le renvoie.
`getAccess(email)`	`Permission`	Récupère l'autorisation accordée à l'utilisateur donné.
`getAccess(user)`	`Permission`	Récupère l'autorisation accordée à l'utilisateur donné.
`getDateCreated()`	`Date`	Récupère la date de création de l'élément `Folder`.
`getDescription()`	`String`	Récupère la description de `Folder`.
`getEditors()`	`User[]`	Récupère la liste des éditeurs pour cet élément `Folder`.
`getFiles()`	`FileIterator`	Récupère une collection de tous les fichiers enfants du dossier actuel.
`getFilesByName(name)`	`FileIterator`	Récupère une collection de tous les fichiers enfants du dossier actuel et portant le nom indiqué.
`getFilesByType(mimeType)`	`FileIterator`	Récupère une collection de tous les fichiers enfants du dossier actuel et possédant le type MIME spécifié.
`getFolders()`	`FolderIterator`	Récupère une collection de tous les dossiers enfants du dossier actuel.
`getFoldersByName(name)`	`FolderIterator`	Récupère une collection de tous les dossiers enfants du dossier actuel et portant le nom donné.
`getId()`	`String`	Récupère l'ID de `Folder`.
`getLastUpdated()`	`Date`	Récupère la date de la dernière mise à jour de `Folder`.
`getName()`	`String`	Récupère le nom de l'élément `Folder`.
`getOwner()`	`User`	Récupère le propriétaire de ce `Folder`.
`getParents()`	`FolderIterator`	Récupère une collection de dossiers qui sont les parents immédiats de `Folder`.
`getResourceKey()`	`String`	Récupère la clé d'accès à la ressource de l'objet `Folder` nécessaire pour accéder aux éléments ont été partagées à l'aide d'un lien.
`getSecurityUpdateEligible()`	`Boolean`	Détermine si cet `Folder` est éligible à l'application de la mise à jour de sécurité qui nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
`getSecurityUpdateEnabled()`	`Boolean`	Détermine si cet élément `Folder` a besoin d'une clé d'accès à la ressource en cas d' partagés à l'aide d'un lien.
`getSharingAccess()`	`Access`	Récupère la classe d'utilisateurs qui peuvent accéder à `Folder`, en dehors de tous les individus. les utilisateurs à qui l'accès a été explicitement accordé.
`getSharingPermission()`	`Permission`	Récupère l'autorisation accordée aux utilisateurs ayant accès à `Folder`. en plus de tous les utilisateurs individuels auxquels l'accès a été explicitement accordé.
`getSize()`	`Integer`	Récupère le nombre d'octets utilisés pour stocker `Folder` dans Drive.
`getUrl()`	`String`	Récupère l'URL permettant d'ouvrir `Folder` dans une appli Google, par exemple Drive ou Docs.
`getViewers()`	`User[]`	Récupère la liste des lecteurs et des commentateurs de `Folder`.
`isShareableByEditors()`	`Boolean`	Détermine si les utilisateurs disposant de droits de modification sur `Folder` sont autorisés à partager avec d'autres utilisateurs ou modifier les autorisations.
`isStarred()`	`Boolean`	Détermine si `Folder` a été ajouté aux favoris dans le Drive de l'utilisateur.
`isTrashed()`	`Boolean`	Détermine si `Folder` se trouve dans la corbeille du Drive de l'utilisateur.
`moveTo(destination)`	`Folder`	Déplace cet élément dans le dossier de destination fourni.
`removeEditor(emailAddress)`	`Folder`	Supprime l'utilisateur indiqué de la liste des éditeurs pour `Folder`.
`removeEditor(user)`	`Folder`	Supprime l'utilisateur indiqué de la liste des éditeurs pour `Folder`.
`removeViewer(emailAddress)`	`Folder`	Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour `Folder`.
`removeViewer(user)`	`Folder`	Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour `Folder`.
`revokePermissions(emailAddress)`	`Folder`	Révoque l'accès à `Folder` accordé à l'utilisateur donné.
`revokePermissions(user)`	`Folder`	Révoque l'accès à `Folder` accordé à l'utilisateur donné.
`searchFiles(params)`	`FileIterator`	Récupère une collection de tous les fichiers enfants du dossier actuel et correspondant à la recherche donnée. critères.
`searchFolders(params)`	`FolderIterator`	Récupère une collection de tous les dossiers enfants du dossier actuel et correspondant à la recherche donnée. critères.
`setDescription(description)`	`Folder`	Définit la description de `Folder`.
`setName(name)`	`Folder`	Définit le nom de `Folder`.
`setOwner(emailAddress)`	`Folder`	Modifie le propriétaire de `Folder`.
`setOwner(user)`	`Folder`	Modifie le propriétaire de `Folder`.
`setSecurityUpdateEnabled(enabled)`	`Folder`	Détermine si `Folder` a besoin d'une clé d'accès à la ressource lorsqu'il est partagés à l'aide d'un lien.
`setShareableByEditors(shareable)`	`Folder`	Détermine si les utilisateurs autorisés à modifier le `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`, ainsi que les autorisations. ces utilisateurs se voient accorder l'accès, outre les utilisateurs individuels auxquels l'accès a été explicitement accordé.
`setStarred(starred)`	`Folder`	Détermine si `Folder` est ajouté aux favoris dans le Drive de l'utilisateur.
`setTrashed(trashed)`	`Folder`	Détermine si `Folder` se trouve dans la corbeille du 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 Folder. Si l'utilisateur était déjà dans la liste des lecteurs, cette méthode met l'utilisateur hors de la liste des lecteurs.

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 correspondant à 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 Folder. Si l'utilisateur était déjà dans la liste des lecteurs, cette méthode met l'utilisateur hors de la liste des lecteurs.

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

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

`addEditors(emailAddresses)`

Ajoute le tableau d'utilisateurs donné à la liste des éditeurs pour Folder. Si l'une des valeurs que les utilisateurs figuraient déjà dans la liste des lecteurs, cette méthode les met en retrait de la liste les lecteurs.

Paramètres

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

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

`addViewer(emailAddress)`

Ajoute l'utilisateur donné à la liste des lecteurs de Folder. Si l'utilisateur était 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 correspondant à un ou plusieurs des champs d'application suivants:

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

`addViewer(user)`

Ajoute l'utilisateur donné à la liste des lecteurs de Folder. Si l'utilisateur était 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 correspondant à 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'une des valeurs si des utilisateurs figuraient déjà dans la liste des éditeurs, cette méthode n'a aucun effet pour eux.

Paramètres

Nom	Type	Description
`emailAddresses`	`String[]`	Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

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

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

`createFile(blob)`

Crée un fichier dans le dossier actuel à partir d'un Blob donné de données arbitraires.

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.getRootFolder().createFile(blob);

Paramètres

Nom	Type	Description
`blob`	`BlobSource`	Données du nouveau fichier.

Renvois

File : nouveau fichier.

Autorisation

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

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

`createFile(name, content)`

Crée un fichier texte avec le nom et le contenu indiqués dans le dossier actuel. Génère une 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 correspondant à un ou plusieurs des champs d'application suivants:

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

`createFile(name, content, mimeType)`

Crée un fichier avec le nom, le contenu et le type MIME dans le dossier actuel. 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 correspondant à 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

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 correspondant à 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 correspondant à 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 ressource est un paramètre supplémentaire qui doit être transmis pour accéder au fichier ou au dossier cible a été partagée à 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é d'accès à la ressource du fichier ou dossier cible.

Renvois

File : nouveau raccourci.

Autorisation

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

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

`getAccess(email)`

Récupère l'autorisation accordée à l'utilisateur donné.

Paramètres

Nom	Type	Description
`email`	`String`	L'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 correspondant à un ou plusieurs des champs d'application suivants:

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

`getAccess(user)`

Récupère l'autorisation accordée à l'utilisateur donné.

Paramètres

Nom	Type	Description
`user`	`User`	Représentation de l'utilisateur dont les autorisations doivent être vérifiées

Renvois

Permission : autorisations accordées à l'utilisateur

Autorisation

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

Renvois

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

Autorisation

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 cet élément Folder. Si l'utilisateur qui exécute le script n'est pas autorisé à modifier Folder, cette méthode renvoie un tableau vide.

// Gets a folder by its ID.
// TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of editors and logs their names to the console.
const editors = folder.getEditors();
for (editor of editors) {
  console.log(editor.getName());
}

Renvois

User[] : liste des éditeurs de ce Folder, si l'utilisateur dispose d'un accès en modification ou d'un vide dans le cas contraire.

Autorisation

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

Paramètres

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

Renvois

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

Autorisation

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

Paramètres

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

Renvois

FileIterator : collection de tous les fichiers enfants du dossier actuel et portant le nom MIME de mots clés.

Autorisation

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

Nom	Type	Description
`name`	`String`	Nom 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 correspondant à un ou plusieurs des champs d'application suivants:

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

`getId()`

Récupère l'ID de Folder.

Renvois

String : ID du Folder

Autorisation

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

Autorisation

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

Autorisation

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

Renvois

FolderIterator : ensemble de dossiers qui sont les parents immédiats du Folder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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é d'accès à la ressource de l'objet Folder nécessaire pour accéder aux éléments ont été partagées à l'aide d'un lien.

Renvois

String : clé d'accès à la ressource de Folder.

Autorisation

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

Drive a besoin d'une clé d'accès à la ressource pour accéder à certains fichiers ou dossiers qui ont été partagés à l'aide d'un . Ce changement s'inscrit dans le cadre d'une mise à jour de sécurité. La mise à jour est activée par défaut pour des fichiers et des dossiers. Pour activer ou désactiver l'exigence de clé d'accès aux ressources 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 correspondant à 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 cet élément Folder a besoin d'une clé d'accès à la ressource en cas d' partagés à 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é d'accès à la 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 correspondant à 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 peuvent accéder à Folder, en dehors de tous les individus. les utilisateurs à qui 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 correspondant à un ou plusieurs des champs d'application suivants:

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

`getSharingPermission()`

Récupère l'autorisation accordée aux utilisateurs ayant accès à Folder. en plus de tous les utilisateurs individuels auxquels l'accès a été explicitement accordé.

Renvois

Permission : autorisations accordées aux utilisateurs ayant accès au Folder.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 Folder dans Drive. Notez que Les fichiers des applications 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 le Folder dans Drive

Autorisation

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

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

`getUrl()`

Récupère l'URL permettant d'ouvrir Folder dans une appli Google, par exemple Drive ou Docs.

Renvois

String : l'URL qui peut être utilisée pour afficher ce Folder dans une appli Google comme Drive ou Docs

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 Folder. Si l'utilisateur qui exécute le script et n'est pas autorisé à modifier Folder, cette méthode renvoie un tableau vide.

// Gets a folder by its ID.
// TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (viewer of viewers) {
  console.log(viewer.getName());
}

Renvois

User[] : liste des lecteurs et des commentateurs de ce Folder si l'utilisateur est autorisé à la modifier ou un tableau vide dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 de droits de modification sur Folder sont autorisés à partager avec d'autres utilisateurs ou modifier les autorisations.

Renvois

Boolean : true si les utilisateurs disposant de droits de modification sont autorisés à partager du contenu avec d'autres utilisateurs ou modifier les autorisations ; false si ce n'est pas le cas

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 ajouté aux favoris dans le Drive de l'utilisateur false si ce n'est pas le cas

Autorisation

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

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

`isTrashed()`

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

Renvois

Boolean : true si Folder se trouve dans la corbeille du Drive de l'utilisateur false si ce n'est pas le cas

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 avoir au moins un accès en modification aux dossier parent actuel afin de déplacer l'élément 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 correspondant à 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 ne permet pas empêcher les utilisateurs d'accéder au Folder s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple, si le Folder est partagé avec l'ensemble domaine, 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 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 correspondant à 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 correspondant à 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 pour Folder. Ce n'a aucun effet si l'utilisateur est un éditeur, et non un lecteur ou un commentateur. Cette méthode permet également n'empêche pas les utilisateurs d'accéder au Folder s'ils appartiennent à une classe d'utilisateurs qui disposer d'un accès général (par exemple, si le Folder est partagé avec le compte l'ensemble du domaine, ou si le 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 correspondant à 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 pour Folder. Ce n'a aucun effet si l'utilisateur est un éditeur et non un lecteur. Cette méthode ne bloque pas non plus utilisateurs d'accéder à Folder s'ils appartiennent à une classe d'utilisateurs ayant des droits d'accès l'accès, par exemple si le Folder est partagé avec l'ensemble du domaine de l'utilisateur ; 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 correspondant à un ou plusieurs des champs d'application suivants:

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

`revokePermissions(emailAddress)`

Révoque l'accès à Folder accordé à l'utilisateur donné. Cette méthode ne permet pas empêcher les utilisateurs d'accéder au Folder s'ils appartiennent à une classe d'utilisateurs qui disposer d'un accès général (par exemple, si le Folder est partagé avec le compte dans l'ensemble du domaine.

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 correspondant à 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 correspondant à 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 à la recherche donnée. critères. Les critères de recherche sont détaillés dans la documentation du SDK Google Drive. Notez que le composant Drive utilise la version 2 de l'API Drive, et certains champs de requête sont différents de ceux de la version 3. Passez en revue le champ différences entre les versions v2 et v3.

L'argument params est une chaîne de requête qui peut contenir des valeurs de chaîne. Par conséquent, faites attention pour échapper correctement les guillemets (par exemple, "title contains 'Gulliver\\'s Travels'" ou 'title contains "Gulliver\'s Travels"').

// Logs the name of every file that are children of the current folder and modified after February 28,
// 2022 whose name contains "untitled.""
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

Paramètres

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

Renvois

FileIterator : collection de tous les fichiers enfants du dossier actuel et correspondant à la recherche critères.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 à la recherche donnée. critères. Les critères de recherche sont détaillés dans la documentation du SDK Google Drive. Notez que le composant Drive utilise la version 2 de l'API Drive, et certains champs de requête sont différents de ceux de la version 3. Passez en revue le champ différences entre les versions v2 et v3.

// Logs the name of every folder that are children of the current folder and you own and is starred.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  console.log(folder.getName());
}

Paramètres

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

Renvois

FolderIterator : collection de tous les dossiers enfants du dossier actuel et correspondant à la recherche critères.

Autorisation

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

Renvois

Folder : Folder, pour le chaînage

Autorisation

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

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

`setName(name)`

Définit le nom de Folder.

Paramètres

Nom	Type	Description
`name`	`String`	Nouveau nom de `Folder`

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 donne également au propriétaire précédent autorisation explicite de modifier 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 correspondant à 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 donne également au propriétaire précédent autorisation explicite de modifier 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 correspondant à un ou plusieurs des champs d'application suivants:

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

`setSecurityUpdateEnabled(enabled)`

Détermine si Folder a besoin d'une clé d'accès à la ressource lorsqu'il est partagés à l'aide d'un lien. Les fichiers et dossiers éligibles sont activés par défaut.

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

Paramètres

Nom	Type	Description
`enabled`	`Boolean`	Permet d'activer ou non l'exigence de clé ressource pour `Folder`.

Renvois

Folder : Folder, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 avec d'autres utilisateurs ou modifier les autorisations. La valeur par défaut pour un nouveau Folder est true

Paramètres

Nom	Type	Description
`shareable`	`Boolean`	`true` si les utilisateurs disposant de droits de modification doivent être autorisés à partager avec d’autres utilisateurs ou de modifier les autorisations ; `false` si ce n'est pas le cas

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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, ainsi que les autorisations. ces utilisateurs se voient accorder l'accès, outre les 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

Nom	Type	Description
`accessType`	`Access`	la classe d'utilisateurs qui doit pouvoir accéder à `Folder`
`permissionType`	`Permission`	les autorisations à accorder aux utilisateurs ayant accès au `Folder`.

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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. Par défaut, les nouvelles valeurs Folder sont false.

Paramètres

Nom	Type	Description
`starred`	`Boolean`	`true` si `Folder` doit être ajouté aux favoris dans la Drive `false` si ce n'est pas le cas

Renvois

Folder : Folder, pour le chaînage

Autorisation

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

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

`setTrashed(trashed)`

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

Paramètres

Nom	Type	Description
`trashed`	`Boolean`	`true` si `Folder` doit être placé dans la corbeille de dans le Drive de l'utilisateur ; `false` si ce n'est pas le cas

Renvois

Folder : Folder, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 retire pas le fichier 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 correspondant à 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 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 correspondant à 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, Si un fichier est supprimé de tous ses parents, il n'est visible dans Drive qu'en effectuant une recherche. ou utiliser l'option "Tous les éléments" vue.

Paramètres

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

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 ou son contenu, mais si un dossier est supprimé de tous ses parents, il n'est plus visible dans Drive sauf en effectuant une recherche ou en utilisant l'option "Tous les éléments" vue.

Paramètres

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

Renvois

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

Autorisation

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

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