Un fichier dans Google Drive. Vous pouvez accéder aux fichiers ou en créer à partir de Drive.
// Trash every untitled spreadsheet that hasn't been updated in a week. const files = DriveApp.getFilesByName('Untitled spreadsheet'); while (files.hasNext()) { const file = files.next(); if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { file.setTrashed(true); } }
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
add | File | Ajoutez l'utilisateur donné à la liste des commentateurs pour File. |
add | File | Ajoutez l'utilisateur donné à la liste des commentateurs pour File. |
add | File | Ajoutez le tableau d'utilisateurs donné à la liste des commentateurs pour File. |
add | File | Ajoute l'utilisateur donné à la liste des éditeurs pour File. |
add | File | Ajoute l'utilisateur donné à la liste des éditeurs pour File. |
add | File | Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de File. |
add | File | Ajoute l'utilisateur donné à la liste des spectateurs de File. |
add | File | Ajoute l'utilisateur donné à la liste des spectateurs de File. |
add | File | Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de File. |
get | Permission | Obtient l'autorisation accordée à un utilisateur spécifique. |
get | Permission | Obtient l'autorisation accordée à un utilisateur spécifique. |
get | Blob | Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié. |
get | Blob | Renvoie les données de cet objet sous forme de blob. |
get | Date | Obtient la date de création de File. |
get | String | Récupère la description de File. |
get | String | Obtient l'URL qui peut être utilisée pour télécharger le fichier. |
get | User[] | Obtient la liste des éditeurs pour ce File. |
get | String | Récupère l'ID du File. |
get | Date | Obtient la date de la dernière mise à jour de File. |
get | String | Récupère le type MIME du fichier. |
get | String | Récupère le nom du File. |
get | User | Récupère le propriétaire du fichier. |
get | Folder | Obtient une collection de dossiers qui sont les parents immédiats de File. |
get | String | Obtient la clé de ressource du File requise pour accéder aux éléments partagés à l'aide d'un lien. |
get | Boolean | Indique si ce File 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. |
get | Boolean | Indique si ce File nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien. |
get | Access | Indique la classe d'utilisateurs pouvant accéder à File, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
get | Permission | Obtient l'autorisation accordée aux utilisateurs pouvant accéder à File, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
get | Integer | Obtient le nombre d'octets utilisés pour stocker File dans Drive. |
get | String | S'il s'agit d'un raccourci, renvoie l'ID de l'élément vers lequel il pointe. |
get | String | S'il s'agit d'un raccourci, renvoie le type MIME de l'élément vers lequel il pointe. |
get | String | Si le fichier est un raccourci, renvoie la clé de ressource de l'élément vers lequel il pointe. |
get | Blob|null | Obtient une image miniature du fichier ou null si aucune miniature n'existe. |
get | String | Obtient l'URL qui peut être utilisée pour ouvrir File dans une application Google telle que Drive ou Docs. |
get | User[] | Obtient la liste des lecteurs et des commentateurs pour ce File. |
is | Boolean | Détermine si les utilisateurs disposant d'autorisations de modification pour le File sont autorisés à le partager avec d'autres utilisateurs ou à modifier les autorisations. |
is | Boolean | Détermine si le File a été ajouté aux favoris dans le Drive de l'utilisateur. |
is | Boolean | Détermine si File se trouve dans la corbeille Drive de l'utilisateur. |
make | File | Crée une copie du fichier. |
make | File | Crée une copie du fichier dans le répertoire de destination. |
make | File | Crée une copie du fichier et lui attribue le nom fourni. |
make | File | Crée une copie du fichier dans le répertoire de destination et lui donne le nom fourni. |
move | File | Déplace cet élément vers le dossier de destination fourni. |
remove | File | Supprime l'utilisateur donné de la liste des commentateurs pour le File. |
remove | File | Supprime l'utilisateur donné de la liste des commentateurs pour le File. |
remove | File | Supprime l'utilisateur donné de la liste des éditeurs pour le File. |
remove | File | Supprime l'utilisateur donné de la liste des éditeurs pour le File. |
remove | File | Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le File. |
remove | File | Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le File. |
revoke | File | Révoque l'accès à File accordé à l'utilisateur spécifié. |
revoke | File | Révoque l'accès à File accordé à l'utilisateur spécifié. |
set | File | Écrase le contenu du fichier avec un contenu de remplacement donné. |
set | File | Définit la description de File. |
set | File | Définit le nom de File. |
set | File | Modifie le propriétaire de File. |
set | File | Modifie le propriétaire de File. |
set | File | Indique si File nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien. |
set | File | Indique si les utilisateurs disposant des droits de modification pour le File sont autorisés à le partager avec d'autres utilisateurs ou à modifier les autorisations. |
set | File | Définit la classe d'utilisateurs pouvant accéder à File et les autorisations qui leur sont accordées, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
set | File | Indique si le File est favori dans le Drive de l'utilisateur. |
set | File | Indique si le File se trouve dans la corbeille du Drive de l'utilisateur. |
Documentation détaillée
add Commenter(emailAddress)
Ajoutez l'utilisateur donné à la liste des commentateurs pour File. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.
const files = DriveApp.getFilesByName('Test'); // Loops through the files while (files.hasNext()) { const file = files.next(); file.addCommenter('hello@example.com'); }
Paramètres
| Nom | Type | Description |
|---|---|---|
email | String | Adresse e-mail de l'utilisateur à ajouter. |
Renvois
File : ce File, 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
add Commenter(user)
Ajoutez l'utilisateur donné à la liste des commentateurs pour File. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Adds the active user as a commenter. while (files.hasNext()) { const file = files.next(); file.addCommenter(Session.getActiveUser()); }
Paramètres
| Nom | Type | Description |
|---|---|---|
user | User | Représentation de l'utilisateur à ajouter. |
Renvois
File : ce File, 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
add Commenters(emailAddresses)
Ajoutez le tableau d'utilisateurs donné à la liste des commentateurs pour File. Si l'un des utilisateurs figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); while (files.hasNext()) { const file = files.next(); // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and // 'baklavainthebalkans@gmail.com' with the email addresses to add as // commenters. const emails = [ 'cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com', ]; console.log(file.addCommenters(emails)); }
Paramètres
| Nom | Type | Description |
|---|---|---|
email | String[] | Tableau des adresses e-mail des utilisateurs à ajouter. |
Renvois
File : ce File, 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
add Editor(emailAddress)
Ajoute l'utilisateur donné à la liste des éditeurs pour File. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.
Paramètres
| Nom | Type | Description |
|---|---|---|
email | String | Adresse e-mail de l'utilisateur à ajouter. |
Renvois
File : ce File, 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
add Editor(user)
Ajoute l'utilisateur donné à la liste des éditeurs pour File. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.
Paramètres
| Nom | Type | Description |
|---|---|---|
user | User | Représentation de l'utilisateur à ajouter. |
Renvois
File : ce File, 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
add Editors(emailAddresses)
Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de File. Si l'un des utilisateurs figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.
Paramètres
| Nom | Type | Description |
|---|---|---|
email | String[] | Tableau des adresses e-mail des utilisateurs à ajouter. |
Renvois
File : ce File, 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
add Viewer(emailAddress)
Ajoute l'utilisateur donné à la liste des spectateurs de File. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.
Paramètres
| Nom | Type | Description |
|---|---|---|
email | String | Adresse e-mail de l'utilisateur à ajouter. |
Renvois
File : ce File, 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
add Viewer(user)
Ajoute l'utilisateur donné à la liste des spectateurs de File. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.
Paramètres
| Nom | Type | Description |
|---|---|---|
user | User | Représentation de l'utilisateur à ajouter. |
Renvois
File : ce File, 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
add Viewers(emailAddresses)
Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de File. 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 |
|---|---|---|
email | String[] | Tableau des adresses e-mail des utilisateurs à ajouter. |
Renvois
File : ce File, 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
get Access(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
| Nom | Type | Description |
|---|---|---|
email | String | Adresse 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
get Access(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
| 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 scopes suivants :
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get As(contentType)
Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "myfile.pdf"). Toutefois, il suppose que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une extension existante qui doit être remplacée. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".
Pour consulter les quotas quotidiens pour les conversions, consultez Quotas pour les services Google. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des quotas plus stricts.
Paramètres
| Nom | Type | Description |
|---|---|---|
content | String | Type MIME vers lequel effectuer la conversion. Pour la plupart des blobs, 'application/pdf' est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, les extensions 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' sont également valides. Pour un document Google Docs, 'text/markdown' est également valide. |
Renvois
Blob : données sous forme de blob.
get Blob()
get Date Created()
get Description()
get Download Url()
Obtient l'URL qui peut être utilisée pour télécharger le fichier. Seuls les utilisateurs autorisés à ouvrir le fichier dans Google Drive peuvent accéder à l'URL. Vous pouvez utiliser cette URL dans un navigateur pour télécharger le fichier, mais vous ne pouvez pas l'utiliser pour récupérer le fichier avec Url. Si vous souhaitez que le contenu du fichier figure dans le script, utilisez get.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the download URLs to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getDownloadUrl()); }
Renvois
String : URL permettant de télécharger le 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.readonly -
https://www.googleapis.com/auth/drive
get Editors()
Obtient la liste des éditeurs pour ce File. Si l'utilisateur qui exécute le script n'a pas accès en modification à File, cette méthode renvoie un tableau vide.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Adds the email addresses in the array as editors of each file. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' // and 'baklavainthebalkans@gmail.com' with valid email addresses. file.addEditors([ 'cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com', ]); // Gets a list of the file editors. const editors = file.getEditors(); // For each file, logs the editors' email addresses to the console. for (const editor of editors) { console.log(editor.getEmail()); } }
Renvois
User[] : si l'utilisateur dispose d'un accès en modification pour ce File, renvoie la liste des éditeurs. Si l'utilisateur ne dispose pas d'un accès en modification, renvoie un tableau vide.
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
get Id()
get Last Updated()
Obtient la date de la dernière mise à jour de File.
Renvois
Date : date de la dernière mise à jour de File
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
get Mime Type()
Récupère le type MIME du fichier.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the MIME type to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getMimeType()); }
Renvois
String : type MIME du 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.readonly -
https://www.googleapis.com/auth/drive
get Name()
get Owner()
Récupère le propriétaire du fichier.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the names of the file owners to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getOwner().getName()); }
Renvois
User : propriétaire du 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.readonly -
https://www.googleapis.com/auth/drive
get Parents()
Obtient une collection de dossiers qui sont les parents immédiats de File.
Renvois
Folder : ensemble de dossiers qui sont les parents immédiats de File
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
get Resource Key()
Obtient la clé de ressource du File requise pour accéder aux éléments partagés à l'aide d'un lien.
Renvois
String : clé de ressource de File.
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
get Security Update Eligible()
Indique si ce File 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 set.
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 à File.
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
get Security Update Enabled()
Indique si ce File 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 File.
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
get Sharing Access()
Indique la classe d'utilisateurs pouvant accéder à File, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
Renvois
Access : classe d'utilisateurs pouvant accéder à File
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
get Sharing Permission()
Obtient l'autorisation accordée aux utilisateurs pouvant accéder à File, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
Renvois
Permission : autorisations accordées aux utilisateurs pouvant accéder à File
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
get Size()
Obtient le nombre d'octets utilisés pour stocker File 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 File 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
get Target Id()
S'il s'agit d'un raccourci, renvoie l'ID de l'élément vers lequel il pointe.
Sinon, elle renvoie null.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the target ID of the shortcut. console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);
Renvois
String : ID de l'article cible.
get Target Mime Type()
S'il s'agit d'un raccourci, renvoie le type MIME de l'élément vers lequel il pointe.
Sinon, elle renvoie null.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the MIME type of the file that the shortcut points to. console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);
Renvois
String : type MIME de l'élément cible.
get Target Resource Key()
Si le fichier est un raccourci, renvoie la clé de ressource de l'élément vers lequel il pointe. Une clé de ressource est un paramètre supplémentaire que vous devez transmettre pour accéder aux fichiers qui ont été partagés à l'aide d'un lien.
Si le fichier n'est pas un raccourci, la fonction renvoie null.
// Gets a file by its ID. // TODO(developer): Replace 'abc123456' with your file ID. const file = DriveApp.getFileById('abc123456'); // If the file is a shortcut, returns the resource key of the file that it // points to. console.log(file.getTargetResourceKey());
Renvois
String : clé de ressource de l'élément cible ou null si le fichier n'est pas un 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.readonly -
https://www.googleapis.com/auth/drive
get Thumbnail()
Obtient une image miniature du fichier ou null si aucune miniature n'existe.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Logs the thumbnail image for each file to the console as a blob, // or null if no thumbnail exists. console.log(file.getThumbnail()); }
Renvois
Blob|null : vignette du 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.readonly -
https://www.googleapis.com/auth/drive
get Url()
Obtient l'URL qui peut être utilisée pour ouvrir File dans une application Google telle que Drive ou Docs.
Renvois
String : URL permettant d'afficher ce File 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
get Viewers()
Obtient la liste des lecteurs et des commentateurs pour ce File. Si l'utilisateur qui exécute le script n'a pas accès en modification à File, cette méthode renvoie un tableau vide.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // For each file, logs the viewers' email addresses to the console. const viewers = file.getViewers(); for (const viewer of viewers) { console.log(viewer.getEmail()); } }
Renvois
User[] : si l'utilisateur dispose d'un accès en modification pour ce File, renvoie la liste des lecteurs et des commentateurs. Si l'utilisateur ne dispose pas d'un accès en modification, renvoie un tableau vide.
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
is Starred()
Détermine si le File a été ajouté aux favoris dans le Drive de l'utilisateur.
Renvois
Boolean : true si le File 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
is Trashed()
Détermine si File se trouve dans la corbeille Drive de l'utilisateur.
Renvois
Boolean : true si le File 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
make Copy()
Crée une copie du fichier.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and logs the file name to the console. console.log(file.makeCopy().getName()); }
Renvois
File : la nouvelle copie.
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
make Copy(destination)
Crée une copie du fichier dans le répertoire de destination.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and adds it to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy(destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
Paramètres
| Nom | Type | Description |
|---|---|---|
destination | Folder | Répertoire dans lequel copier le fichier. |
Renvois
File : la nouvelle copie.
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
make Copy(name)
Crée une copie du fichier et lui attribue le nom fourni.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and sets the name to 'Test-Copy.' const filename = file.makeCopy('Test-Copy'); // Logs the copied file's name to the console. console.log(filename.getName()); }
Paramètres
| Nom | Type | Description |
|---|---|---|
name | String | Nom de fichier à appliquer à la nouvelle copie. |
Renvois
File : la nouvelle copie.
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
make Copy(name, destination)
Crée une copie du fichier dans le répertoire de destination et lui donne le nom fourni.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file, sets the file name, and adds the copied file // to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy('Test-Copy', destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
Paramètres
| Nom | Type | Description |
|---|---|---|
name | String | Nom de fichier à appliquer à la nouvelle copie. |
destination | Folder | Répertoire dans lequel copier le fichier. |
Renvois
File : la nouvelle copie.
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
move To(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
File : ce File, 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
remove Commenter(emailAddress)
Supprime l'utilisateur donné de la liste des commentateurs pour le File. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si File est partagé avec l'ensemble du domaine de l'utilisateur).
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. // TODO(developer): Replace the email with the email of the user you want to // remove. file.removeCommenter('cloudysanfrancisco@gmail.com'); }
Paramètres
| Nom | Type | Description |
|---|---|---|
email | String | Adresse e-mail de l'utilisateur à supprimer. |
Renvois
File : ce File, 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
remove Commenter(user)
Supprime l'utilisateur donné de la liste des commentateurs pour le File. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si File est partagé avec l'ensemble du domaine de l'utilisateur).
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. console.log(file.removeCommenter(Session.getActiveUser())); }
Paramètres
| Nom | Type | Description |
|---|---|---|
user | User | Représentation de l'utilisateur à supprimer. |
Renvois
File : ce File, 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
remove Editor(emailAddress)
Supprime l'utilisateur donné de la liste des éditeurs pour le File. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si File est partagé avec l'ensemble du domaine de l'utilisateur ou si File 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
| Nom | Type | Description |
|---|---|---|
email | String | Adresse e-mail de l'utilisateur à supprimer. |
Renvois
File : ce File, 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
remove Editor(user)
Supprime l'utilisateur donné de la liste des éditeurs pour le File. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si File est partagé avec l'ensemble du domaine de l'utilisateur ou si File 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
| Nom | Type | Description |
|---|---|---|
user | User | Représentation de l'utilisateur à supprimer. |
Renvois
File : ce File, 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
remove Viewer(emailAddress)
Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le File. 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 à File s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si File est partagé avec l'ensemble du domaine de l'utilisateur ou si File se trouve dans un Drive partagé auquel l'utilisateur peut accéder).File
Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des éditeurs.
Paramètres
| Nom | Type | Description |
|---|---|---|
email | String | Adresse e-mail de l'utilisateur à supprimer. |
Renvois
File : ce File 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
remove Viewer(user)
Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le File. 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 à File s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si File est partagé avec l'ensemble du domaine de l'utilisateur ou si File 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
| Nom | Type | Description |
|---|---|---|
user | User | Représentation de l'utilisateur à supprimer. |
Renvois
File : ce File 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
revoke Permissions(emailAddress)
Révoque l'accès à File accordé à l'utilisateur spécifié. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs ayant un accès général (par exemple, si File est partagé avec l'ensemble du domaine de l'utilisateur).
Paramètres
| Nom | Type | Description |
|---|---|---|
email | String | Adresse e-mail de l'utilisateur dont l'accès doit être révoqué. |
Renvois
File : ce File, 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
revoke Permissions(user)
Révoque l'accès à File accordé à l'utilisateur spécifié. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs ayant un accès général (par exemple, si File est partagé avec l'ensemble du domaine de l'utilisateur).
Paramètres
| Nom | Type | Description |
|---|---|---|
user | User | Représentation de l'utilisateur dont l'accès doit être révoqué. |
Renvois
File : ce File, 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
set Content(content)
Écrase le contenu du fichier avec un contenu de remplacement donné. Génère une exception si content est supérieur à 10 Mo.
// Creates a text file with the content 'Hello, world!' const file = DriveApp.createFile('New Text File', 'Hello, world!'); // Logs the content of the text file to the console. console.log(file.getBlob().getDataAsString()); // Updates the content of the text file to 'Updated text!' file.setContent('Updated text!'); // Logs content of the text file to the console. console.log(file.getBlob().getDataAsString());
Paramètres
| Nom | Type | Description |
|---|---|---|
content | String | Nouveau contenu du fichier. |
Renvois
File : ce File, 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
set Description(description)
set Name(name)
set Owner(emailAddress)
Modifie le propriétaire de File. Cette méthode accorde également à l'ancien propriétaire un accès explicite en modification à File.
Paramètres
| Nom | Type | Description |
|---|---|---|
email | String | l'adresse e-mail de l'utilisateur qui doit devenir le nouveau propriétaire ; |
Renvois
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
set Owner(user)
Modifie le propriétaire de File. Cette méthode accorde également à l'ancien propriétaire un accès explicite en modification à File.
Paramètres
| Nom | Type | Description |
|---|---|---|
user | User | représentation de l'utilisateur qui doit devenir le nouveau propriétaire |
Renvois
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
set Security Update Enabled(enabled)
Indique si File 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 File. |
Renvois
File : ce File, 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
set Sharing(accessType, permissionType)
Définit la classe d'utilisateurs pouvant accéder à File 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
| Nom | Type | Description |
|---|---|---|
access | Access | la classe d'utilisateurs qui doit pouvoir accéder à File. |
permission | Permission | les autorisations à accorder aux utilisateurs pouvant accéder à File. |
Renvois
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
set Starred(starred)
Indique si le File est favori dans le Drive de l'utilisateur. La valeur par défaut pour les nouveaux File est false.
Paramètres
| Nom | Type | Description |
|---|---|---|
starred | Boolean | true si le File doit être ajouté aux favoris dans le Drive de l'utilisateur ; false dans le cas contraire |
Renvois
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
set Trashed(trashed)
Indique si le File se trouve dans la corbeille du Drive de l'utilisateur. Seul le propriétaire peut placer le File dans la corbeille. La valeur par défaut pour les nouveaux File est false.
Paramètres
| Nom | Type | Description |
|---|---|---|
trashed | Boolean | true si le File doit être placé dans la corbeille du Drive de l'utilisateur ; false dans le cas contraire |
Renvois
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