Fichier dans Google Drive Vous pouvez accéder aux fichiers ou en créer à partir de DriveApp
.
// 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 |
---|---|---|
addCommenter(emailAddress) | File | Ajoutez l'utilisateur donné à la liste des commentateurs de la File . |
addCommenter(user) | File | Ajoutez l'utilisateur donné à la liste des commentateurs de la File . |
addCommenters(emailAddresses) | File | Ajoutez le tableau d'utilisateurs donné à la liste des commentateurs de l'File . |
addEditor(emailAddress) | File | Ajoute l'utilisateur donné à la liste des éditeurs de l'File . |
addEditor(user) | File | Ajoute l'utilisateur donné à la liste des éditeurs de l'File . |
addEditors(emailAddresses) | File | Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de l'File . |
addViewer(emailAddress) | File | Ajoute l'utilisateur donné à la liste des spectateurs de l'File . |
addViewer(user) | File | Ajoute l'utilisateur donné à la liste des spectateurs de l'File . |
addViewers(emailAddresses) | File | Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de l'File . |
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. |
getAs(contentType) | Blob | Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié. |
getBlob() | Blob | Renvoyez les données de cet objet sous forme de blob. |
getDateCreated() | Date | Récupère la date de création de l'File . |
getDescription() | String | Récupère la description de l'File . |
getDownloadUrl() | String | Récupère l'URL permettant de télécharger le fichier. |
getEditors() | User[] | Récupère la liste des éditeurs de cet objet File . |
getId() | String | Récupère l'ID du File . |
getLastUpdated() | Date | Récupère la date de la dernière mise à jour de l'File . |
getMimeType() | String | Récupère le type MIME du fichier. |
getName() | String | Récupère le nom de l'File . |
getOwner() | User | Récupère le propriétaire du fichier. |
getParents() | FolderIterator | Récupère une collection de dossiers qui sont des parents immédiats de l'File . |
getResourceKey() | String | Récupère la clé de ressource de l'File requise pour accéder aux éléments partagés à l'aide d'un lien. |
getSecurityUpdateEligible() | Boolean | Indique si cet élément File 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 File 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 à File , 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 à File , 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 File dans Drive. |
getTargetId() | String | S'il s'agit d'un raccourci, renvoie l'ID de l'élément auquel il fait référence. |
getTargetMimeType() | String | S'il s'agit d'un raccourci, renvoie le type MIME de l'élément auquel il fait référence. |
getTargetResourceKey() | String | Si le fichier est un raccourci, renvoie la clé de ressource de l'élément auquel il fait référence. |
getThumbnail() | Blob | Récupère une image miniature du fichier ou null si aucune miniature n'existe. |
getUrl() | String | Récupère l'URL permettant d'ouvrir le File dans une application Google telle que Drive ou Docs. |
getViewers() | User[] | Récupère la liste des lecteurs et des commentateurs de cet File . |
isShareableByEditors() | Boolean | Détermine si les utilisateurs disposant d'autorisations de modification pour le File sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations. |
isStarred() | Boolean | Détermine si l'File a été ajouté aux favoris dans Drive de l'utilisateur. |
isTrashed() | Boolean | Détermine si l'File se trouve dans la corbeille de Drive de l'utilisateur. |
makeCopy() | File | Crée une copie du fichier. |
makeCopy(destination) | File | Crée une copie du fichier dans le répertoire de destination. |
makeCopy(name) | File | Crée une copie du fichier et lui attribue le nom fourni. |
makeCopy(name, destination) | File | Crée une copie du fichier dans le répertoire de destination et lui attribue le nom fourni. |
moveTo(destination) | File | Déplace cet élément vers le dossier de destination fourni. |
removeCommenter(emailAddress) | File | Supprime l'utilisateur donné de la liste des commentateurs de l'File . |
removeCommenter(user) | File | Supprime l'utilisateur donné de la liste des commentateurs de l'File . |
removeEditor(emailAddress) | File | Supprime l'utilisateur donné de la liste des éditeurs de l'File . |
removeEditor(user) | File | Supprime l'utilisateur donné de la liste des éditeurs de l'File . |
removeViewer(emailAddress) | File | Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'File . |
removeViewer(user) | File | Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'File . |
revokePermissions(emailAddress) | File | Révoque l'accès à l'File accordé à l'utilisateur donné. |
revokePermissions(user) | File | Révoque l'accès à l'File accordé à l'utilisateur donné. |
setContent(content) | File | Écrase le contenu du fichier par un remplacement donné. |
setDescription(description) | File | Définit la description de File . |
setName(name) | File | Définit le nom de l'File . |
setOwner(emailAddress) | File | Modifie le propriétaire de l'File . |
setOwner(user) | File | Modifie le propriétaire de l'File . |
setSecurityUpdateEnabled(enabled) | File | Indique si File nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien. |
setShareableByEditors(shareable) | File | Indique si les utilisateurs disposant des autorisations de modification de l'File sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations. |
setSharing(accessType, permissionType) | File | Définit la classe d'utilisateurs pouvant accéder à File et les autorisations accordées à ces utilisateurs, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé. |
setStarred(starred) | File | Indique si l'File est ajouté aux favoris dans Drive de l'utilisateur. |
setTrashed(trashed) | File | Définit si l'File se trouve dans la corbeille de Drive de l'utilisateur. |
Documentation détaillée
addCommenter(emailAddress)
Ajoutez l'utilisateur donné à la liste des commentateurs de la File
. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le supprime de la 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 |
---|---|---|
emailAddress | String | Adresse e-mail de l'utilisateur à ajouter. |
Renvois
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
addCommenter(user)
Ajoutez l'utilisateur donné à la liste des commentateurs de l'File
. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le supprime de la 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
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
addCommenters(emailAddresses)
Ajoutez le tableau d'utilisateurs donné à la liste des commentateurs de l'File
. Si l'un des utilisateurs figurait déjà dans la liste des spectateurs, cette méthode le fait sortir de la 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 |
---|---|---|
emailAddresses | String[] | Tableau d'adresses e-mail des utilisateurs à ajouter. |
Renvois
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(emailAddress)
Ajoute l'utilisateur donné à la liste des éditeurs de l'File
. 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
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'File
. 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
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'File
. 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
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'File
. 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
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'File
. 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
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'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 |
---|---|---|
emailAddresses | String[] | Tableau d'adresses e-mail des utilisateurs à ajouter. |
Renvois
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
getAs(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, "monfichier.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 afficher les quotas quotidiens pour les conversions, consultez la section Quotas pour les services Google. Les nouveaux domaines Google Workspace peuvent être temporairement soumis à des quotas plus stricts.
Paramètres
Nom | Type | Description |
---|---|---|
contentType | 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 valeurs '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.
getBlob()
getDateCreated()
Récupère la date de création de l'File
.
Renvois
Date
: date de création de l'File
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'File
.
Renvois
String
: description de File
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
getDownloadUrl()
Récupère l'URL permettant de 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 extraire le fichier avec UrlFetchApp
. Si vous souhaitez que le contenu du fichier figure dans le script, utilisez getBlob()
.
// 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 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 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 des droits de modification pour ce File
, la liste des éditeurs est renvoyée. Si l'utilisateur ne dispose pas de l'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 champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getId()
Récupère l'ID du File
.
Renvois
String
: ID de l'File
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'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 champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getMimeType()
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 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'File
.
Renvois
String
: nom de l'File
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 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 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 File
.
Renvois
FolderIterator
: ensemble de dossiers qui sont des parents immédiats de l'File
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'File
requise pour accéder aux éléments partagés à l'aide d'un lien.
Renvois
String
: clé de ressource de l'File
.
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 File
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 File
.
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 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 cette File
.
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 à File
, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
Renvois
Access
: classe d'utilisateurs autorisés à accéder à File
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 à File
, en plus des utilisateurs individuels auxquels un 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 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 File
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 File
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
getTargetId()
S'il s'agit d'un raccourci, renvoie l'ID de l'élément auquel il fait référence.
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.
getTargetMimeType()
S'il s'agit d'un raccourci, renvoie le type MIME de l'élément auquel il fait référence.
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.
getTargetResourceKey()
Si le fichier est un raccourci, renvoie la clé de ressource de l'élément auquel il fait référence. Une clé de ressource est un paramètre supplémentaire que vous devez transmettre pour accéder aux fichiers partagés à l'aide d'un lien.
Si le fichier n'est pas un raccourci, la valeur null
est renvoyée.
// 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 champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getThumbnail()
Récupère 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
: image miniature du 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.readonly
-
https://www.googleapis.com/auth/drive
getUrl()
Récupère l'URL permettant d'ouvrir le File
dans une application Google telle que Drive ou Docs.
Renvois
String
: URL permettant d'afficher cette 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 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 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 cette File
, renvoie la liste des lecteurs et des commentateurs. Si l'utilisateur ne dispose pas de l'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 champs d'application suivants:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isStarred()
Détermine si l'File
a été ajouté aux favoris dans Drive de l'utilisateur.
Renvois
Boolean
: true
si l'File
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'File
se trouve dans la corbeille de Drive de l'utilisateur.
Renvois
Boolean
: true
si l'File
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
makeCopy()
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
: nouvelle copie.
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
makeCopy(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
: nouvelle copie.
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
makeCopy(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
: nouvelle copie.
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
makeCopy(name, destination)
Crée une copie du fichier dans le répertoire de destination 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, 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
: nouvelle copie.
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
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
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
removeCommenter(emailAddress)
Supprime l'utilisateur donné de la liste des commentateurs de l'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 |
---|---|---|
emailAddress | String | Adresse e-mail de l'utilisateur à supprimer. |
Renvois
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
removeCommenter(user)
Supprime l'utilisateur donné de la liste des commentateurs de l'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
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'File
. Cette méthode n'empêche pas les utilisateurs d'accéder à l'File
s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si l'File
est partagé avec l'ensemble du domaine de l'utilisateur ou si l'File
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
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)
Supprime l'utilisateur donné de la liste des éditeurs de l'File
. Cette méthode n'empêche pas les utilisateurs d'accéder à l'File
s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si l'File
est partagé avec l'ensemble du domaine de l'utilisateur ou si l'File
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 |
---|---|---|
user | User | Représentation de l'utilisateur à supprimer. |
Renvois
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'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 à l'File
s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si l'File
est partagé avec l'ensemble du domaine de l'utilisateur ou si l'File
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
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'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, l'utilisateur est également supprimé de la liste des éditeurs.
Paramètres
Nom | Type | Description |
---|---|---|
user | User | Représentation de l'utilisateur à supprimer. |
Renvois
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'File
accordé à l'utilisateur donné. 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).
Paramètres
Nom | Type | Description |
---|---|---|
emailAddress | String | Adresse e-mail de l'utilisateur dont l'accès doit être révoqué. |
Renvois
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)
Révoque l'accès à l'File
accordé à l'utilisateur donné. 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).
Paramètres
Nom | Type | Description |
---|---|---|
user | User | Représentation de l'utilisateur dont l'accès doit être révoqué. |
Renvois
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
setContent(content)
Écrase le contenu du fichier par un 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
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
setDescription(description)
Définit la description de File
.
Paramètres
Nom | Type | Description |
---|---|---|
description | String | la nouvelle description de l'File |
Renvois
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'File
.
Paramètres
Nom | Type | Description |
---|---|---|
name | String | le nouveau nom du File ; |
Renvois
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'File
. Cette méthode accorde également au propriétaire précédent un accès en modification explicite à File
.
Paramètres
Nom | Type | Description |
---|---|---|
emailAddress | 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 champs d'application suivants:
-
https://www.googleapis.com/auth/drive
setOwner(user)
Modifie le propriétaire de l'File
. Cette méthode accorde également au propriétaire précédent un accès en modification explicite à File
.
Paramètres
Nom | Type | Description |
---|---|---|
user | User | une 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 champs d'application suivants:
-
https://www.googleapis.com/auth/drive
setSecurityUpdateEnabled(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
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 à File
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 à File |
permissionType | Permission | les autorisations à accorder aux utilisateurs autorisés à accéder à File ; |
Renvois
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'File
est ajouté aux favoris dans Drive de l'utilisateur. La valeur par défaut pour les nouveaux File
est false
.
Paramètres
Nom | Type | Description |
---|---|---|
starred | Boolean | true si l'File doit être ajouté aux favoris dans Drive de l'utilisateur ; false sinon |
Renvois
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'File
se trouve dans la corbeille de Drive de l'utilisateur. Seul le propriétaire peut placer l'File
dans la corbeille. La valeur par défaut pour les nouveaux File
est false
.
Paramètres
Nom | Type | Description |
---|---|---|
trashed | Boolean | true si l'File doit être déplacé vers la corbeille de Drive de l'utilisateur ; false sinon |
Renvois
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