Ce service permet aux scripts de créer, rechercher et modifier des fichiers et des dossiers dans Google Drive.
Si votre script utilise un projet Cloud standard au lieu d'un projet Cloud par défaut, vous devez activer manuellement l'API Drive. Dans votre projet Cloud standard, activez l'API Drive:
L'exemple de code suivant montre comment consigner le nom de chaque fichier situé dans le dossier Mon Drive de l'utilisateur :// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
var file = files.next();
console.log(file.getName());
}
Classes
Nom | Brève description |
---|---|
Access | Énumération représentant les classes d'utilisateurs qui peuvent accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
DriveApp | Permet aux scripts de créer, rechercher et modifier des fichiers et des dossiers dans Google Drive. |
File | Un fichier dans Google Drive. |
FileIterator | Itérateur permettant aux scripts d'itérer une collection de fichiers potentiellement volumineuse. |
Folder | Un dossier dans Google Drive. |
FolderIterator | Objet permettant aux scripts d'itérer une collection potentiellement importante de dossiers. |
Permission | Énumération représentant les autorisations accordées aux utilisateurs pouvant accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
User | Utilisateur associé à un fichier dans Google Drive. |
Access
Propriétés
Propriété | Type | Description |
---|---|---|
ANYONE | Enum | Recherche et accès autorisés pour tous les internautes |
ANYONE_WITH_LINK | Enum | Accès autorisé pour tous les utilisateurs disposant du lien |
DOMAIN | Enum | Accès aux utilisateurs de votre domaine via la recherche. |
DOMAIN_WITH_LINK | Enum | Accès aux utilisateurs de votre domaine disposant du lien. |
PRIVATE | Enum | Accès réservé aux utilisateurs disposant d'une autorisation expresse. |
DriveApp
Propriétés
Propriété | Type | Description |
---|---|---|
Access | Access | Énumération représentant les classes d'utilisateurs qui peuvent accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
Permission | Permission | Énumération représentant les autorisations accordées aux utilisateurs pouvant accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | Reprend une itération de fichier à l'aide du jeton de continuation d'un itérateur précédent. |
continueFolderIterator(continuationToken) | FolderIterator | Reprend une itération de dossier à l'aide du jeton de continuation d'un itérateur précédent. |
createFile(blob) | File | Crée un fichier à la racine du Drive de l'utilisateur à partir d'un Blob donné de données arbitraires. |
createFile(name, content) | File | Crée un fichier texte à la racine du Drive de l'utilisateur avec le nom et le contenu spécifiés. |
createFile(name, content, mimeType) | File | Crée un fichier à la racine du Drive de l'utilisateur avec le nom indiqué, le contenu et le type MIME. |
createFolder(name) | Folder | Crée un dossier portant le nom donné à la racine du Drive de l'utilisateur. |
createShortcut(targetId) | File | Crée un raccourci vers l'ID d'élément Drive fourni, puis l'affiche. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Crée un raccourci vers l'ID d'élément Drive et la clé de ressource fournis, puis le renvoie. |
enforceSingleParent(value) | void | Active ou désactive le comportement "applySingleParent" pour tous les appels affectant les parents d'éléments. |
getFileById(id) | File | Récupère le fichier avec l'identifiant donné. |
getFileByIdAndResourceKey(id, resourceKey) | File | Récupère le fichier avec l'ID et la clé de ressource indiqués. |
getFiles() | FileIterator | Récupère une collection de tous les fichiers dans le Drive de l'utilisateur. |
getFilesByName(name) | FileIterator | Récupère une collection de tous les fichiers portant le nom donné dans le Drive de l'utilisateur. |
getFilesByType(mimeType) | FileIterator | Récupère une collection de tous les fichiers du Drive de l'utilisateur qui présentent le type MIME donné. |
getFolderById(id) | Folder | Récupère le dossier avec l'ID donné. |
getFolderByIdAndResourceKey(id, resourceKey) | Folder | Récupère le dossier avec l'ID et la clé de ressource indiqués. |
getFolders() | FolderIterator | Récupère une collection de tous les dossiers dans le Drive de l'utilisateur. |
getFoldersByName(name) | FolderIterator | Récupère une collection de tous les dossiers du Drive de l'utilisateur portant le nom donné. |
getRootFolder() | Folder | Récupère le dossier à la racine du Drive de l'utilisateur. |
getStorageLimit() | Integer | Récupère le nombre d'octets que l'utilisateur est autorisé à stocker dans Drive. |
getStorageUsed() | Integer | Récupère le nombre d'octets que l'utilisateur stocke actuellement dans Drive. |
getTrashedFiles() | FileIterator | Récupère une collection de tous les fichiers dans la corbeille du Drive de l'utilisateur. |
getTrashedFolders() | FolderIterator | Récupère une collection de tous les dossiers contenus dans la corbeille du Drive de l'utilisateur. |
searchFiles(params) | FileIterator | Récupère une collection de tous les fichiers du Drive de l'utilisateur qui correspondent aux critères de recherche indiqués. |
searchFolders(params) | FolderIterator | Récupère une collection de tous les dossiers du Drive de l'utilisateur correspondant aux critères de recherche indiqués. |
File
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addCommenter(emailAddress) | File | Ajouter l'utilisateur indiqué à la liste des commentateurs de File . |
addCommenter(user) | File | Ajouter l'utilisateur indiqué à la liste des commentateurs de File . |
addCommenters(emailAddresses) | File | Ajoutez le tableau d'utilisateurs indiqué à la liste des commentateurs pour File . |
addEditor(emailAddress) | File | Ajoute l'utilisateur donné à la liste des éditeurs pour File . |
addEditor(user) | File | Ajoute l'utilisateur donné à la liste des éditeurs pour File . |
addEditors(emailAddresses) | File | Ajoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour File . |
addViewer(emailAddress) | File | Ajoute l'utilisateur donné à la liste des lecteurs pour File . |
addViewer(user) | File | Ajoute l'utilisateur donné à la liste des lecteurs pour File . |
addViewers(emailAddresses) | File | Ajoute le tableau d'utilisateurs donné à la liste des lecteurs pour File . |
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é. |
getAs(contentType) | Blob | Renvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié. |
getBlob() | Blob | Renvoyez les données contenues dans cet objet sous forme d'objet blob. |
getDateCreated() | Date | Récupère la date de création de File . |
getDescription() | String | Récupère la description de File . |
getDownloadUrl() | String | Récupère l'URL qui peut être utilisée pour télécharger le fichier. |
getEditors() | User[] | Récupère la liste des éditeurs pour ce File . |
getId() | String | Récupère l'ID d'File . |
getLastUpdated() | Date | Récupère la date de la dernière mise à jour de File . |
getMimeType() | String | Récupère le type MIME du fichier. |
getName() | String | Récupère le nom de l'élément File . |
getOwner() | User | Récupère le propriétaire du fichier. |
getParents() | FolderIterator | Récupère une collection de dossiers parents immédiats de File . |
getResourceKey() | String | Récupère la clé de ressource du File requise pour accéder aux éléments partagés à l'aide d'un lien. |
getSecurityUpdateEligible() | Boolean | Détermine si ce File est éligible à l'application de la mise à jour de sécurité nécessitant l'accès à une clé d'accès à la ressource lorsqu'il est partagé via un lien. |
getSecurityUpdateEnabled() | Boolean | Détermine si ce File nécessite une clé d'accès à la ressource lorsqu'il est partagé via un lien. |
getSharingAccess() | Access | Récupère la classe d'utilisateurs qui peut accéder à File , en plus des utilisateurs individuels auxquels l'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 l'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 vers lequel il pointe. |
getTargetMimeType() | String | S'il s'agit d'un raccourci, renvoie le type MIME de l'élément vers lequel il pointe. |
getTargetResourceKey() | String | Si le fichier est un raccourci, renvoie la clé d'accès à la ressource de l'élément vers lequel il pointe. |
getThumbnail() | Blob | Récupère une vignette pour le fichier, ou null si aucune vignette n'existe. |
getUrl() | String | Récupère l'URL permettant d'ouvrir le fichier File dans une application Google telle que Drive ou Docs. |
getViewers() | User[] | Récupère la liste des lecteurs et des commentateurs de ce File . |
isShareableByEditors() | Boolean | Détermine si les utilisateurs autorisés à modifier le File sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations. |
isStarred() | Boolean | Détermine si File a été ajouté aux favoris dans le Drive de l'utilisateur. |
isTrashed() | Boolean | Détermine si le File se trouve dans la corbeille du 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 indiqué. |
makeCopy(name, destination) | File | Crée une copie du fichier dans le répertoire de destination et lui attribue le nom indiqué. |
moveTo(destination) | File | Déplace cet élément dans le dossier de destination fourni. |
removeCommenter(emailAddress) | File | Supprime l'utilisateur indiqué de la liste des commentateurs pour File . |
removeCommenter(user) | File | Supprime l'utilisateur indiqué de la liste des commentateurs pour File . |
removeEditor(emailAddress) | File | Supprime l'utilisateur indiqué de la liste des éditeurs pour File . |
removeEditor(user) | File | Supprime l'utilisateur indiqué de la liste des éditeurs pour File . |
removeViewer(emailAddress) | File | Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de File . |
removeViewer(user) | File | Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de File . |
revokePermissions(emailAddress) | File | Révoque l'accès au File accordé à l'utilisateur donné. |
revokePermissions(user) | File | Révoque l'accès au 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 la File . |
setOwner(emailAddress) | File | Modifie le propriétaire de File . |
setOwner(user) | File | Modifie le propriétaire de File . |
setSecurityUpdateEnabled(enabled) | File | Détermine si l'File nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien. |
setShareableByEditors(shareable) | File | Détermine si les utilisateurs autorisés à modifier le File sont autorisés à partager du contenu 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 qui leur sont accordées, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
setStarred(starred) | File | Détermine si File est ajouté aux favoris dans le Drive de l'utilisateur. |
setTrashed(trashed) | File | Détermine si le File se trouve dans la corbeille du Drive de l'utilisateur. |
FileIterator
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getContinuationToken() | String | Récupère un jeton qui peut être utilisé pour reprendre cette itération ultérieurement. |
hasNext() | Boolean | Détermine si l'appel de next() renvoie un article. |
next() | File | Récupère l'élément suivant dans la collection de fichiers ou de dossiers. |
Folder
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addEditor(emailAddress) | Folder | Ajoute l'utilisateur donné à la liste des éditeurs pour Folder . |
addEditor(user) | Folder | Ajoute l'utilisateur donné à la liste des éditeurs pour Folder . |
addEditors(emailAddresses) | Folder | Ajoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Folder . |
addViewer(emailAddress) | Folder | Ajoute l'utilisateur donné à la liste des lecteurs pour Folder . |
addViewer(user) | Folder | Ajoute l'utilisateur donné à la liste des lecteurs pour 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'une Blob donnée de données arbitraires. |
createFile(name, content) | File | Crée un fichier texte dans le dossier actuel avec le nom et le contenu donnés. |
createFile(name, content, mimeType) | File | Crée un fichier dans le dossier actuel avec le nom donné, le contenu et le type MIME. |
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 l'affiche. |
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 Folder . |
getDescription() | String | Récupère la description de Folder . |
getEditors() | User[] | Récupère la liste des éditeurs pour ce 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 donné. |
getFilesByType(mimeType) | FileIterator | Récupère une collection de tous les fichiers enfants du dossier actuel et possédant le type MIME donné. |
getFolders() | FolderIterator | Récupère une collection de tous les dossiers enfants du dossier actuel. |
getFoldersByName(name) | FolderIterator | Récupère une collection de tous les dossiers enfants du dossier actuel et portant le nom donné. |
getId() | String | Récupère l'ID d'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 parents immédiats de Folder . |
getResourceKey() | String | Récupère la clé de ressource du Folder requise pour accéder aux éléments partagés à l'aide d'un lien. |
getSecurityUpdateEligible() | Boolean | Détermine si ce Folder est éligible à l'application de la mise à jour de sécurité nécessitant l'accès à une clé d'accès à la ressource lorsqu'il est partagé via un lien. |
getSecurityUpdateEnabled() | Boolean | Détermine si ce Folder nécessite une clé d'accès à la ressource lorsqu'il est partagé via un lien. |
getSharingAccess() | Access | Récupère la classe d'utilisateurs qui peut accéder à Folder , en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
getSharingPermission() | Permission | Récupère l'autorisation accordée aux utilisateurs pouvant accéder à Folder , en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé. |
getSize() | Integer | Récupère le nombre d'octets utilisés pour stocker le Folder dans Drive. |
getUrl() | String | Récupère l'URL permettant d'ouvrir le fichier Folder dans une application Google telle que Drive ou Docs. |
getViewers() | User[] | Récupère la liste des lecteurs et des commentateurs de ce Folder . |
isShareableByEditors() | Boolean | Détermine si les utilisateurs autorisés à modifier le Folder sont autorisés à partager du contenu 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 le 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 de Folder . |
removeViewer(user) | Folder | Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Folder . |
revokePermissions(emailAddress) | Folder | Révoque l'accès au Folder accordé à l'utilisateur donné. |
revokePermissions(user) | Folder | Révoque l'accès au Folder accordé à l'utilisateur donné. |
searchFiles(params) | FileIterator | Récupère une collection de tous les fichiers enfants du dossier actuel et correspondant aux critères de recherche indiqués. |
searchFolders(params) | FolderIterator | Récupère une collection de tous les dossiers enfants du dossier actuel et correspondant aux critères de recherche donnés. |
setDescription(description) | Folder | Définit la description de Folder . |
setName(name) | Folder | Définit le nom de la 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 l'Folder nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien. |
setShareableByEditors(shareable) | Folder | Détermine si les utilisateurs autorisés à modifier le Folder sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations. |
setSharing(accessType, permissionType) | Folder | Définit la classe d'utilisateurs pouvant accéder à Folder et les autorisations qui leur sont accordées, en plus des 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 le Folder se trouve dans la corbeille du Drive de l'utilisateur. |
FolderIterator
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getContinuationToken() | String | Récupère un jeton qui peut être utilisé pour reprendre cette itération ultérieurement. |
hasNext() | Boolean | Détermine si l'appel de next() renvoie un article. |
next() | Folder | Récupère l'élément suivant dans la collection de fichiers ou de dossiers. |
Permission
Propriétés
Propriété | Type | Description |
---|---|---|
VIEW | Enum | Les utilisateurs autorisés à accéder au fichier ou au dossier ne peuvent que le consulter ou le copier. |
EDIT | Enum | Les utilisateurs autorisés à accéder au fichier ou au dossier peuvent le modifier. |
COMMENT | Enum | Les utilisateurs autorisés à accéder au fichier ou au dossier ne peuvent que le consulter, le copier ou le commenter. |
OWNER | Enum | L'utilisateur est propriétaire du fichier ou du dossier. |
ORGANIZER | Enum | Utilisateurs pouvant organiser les fichiers et les dossiers dans un Drive partagé. |
FILE_ORGANIZER | Enum | Utilisateurs autorisés à modifier, placer dans la corbeille et déplacer du contenu dans un Drive partagé. |
NONE | Enum | L'utilisateur ne dispose d'aucune autorisation pour le fichier ou le dossier. |
User
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getDomain() | String | Récupère le nom de domaine associé au compte de l'utilisateur. |
getEmail() | String | Récupère l'adresse e-mail de l'utilisateur. |
getName() | String | Récupère le nom de l'utilisateur. |
getPhotoUrl() | String | Récupère l'URL de la photo de l'utilisateur. |