Drive Service

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Drive

Ce service permet aux scripts de créer, de rechercher et de modifier des fichiers et des dossiers dans Google Drive.

// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

Classes

NomBrève description
AccessÉnumération représentant les classes d'utilisateurs pouvant accéder à un fichier ou à un dossier, en plus des utilisateurs individuels disposant d'un accès explicite.
DriveAppPermet aux scripts de créer, de rechercher et de modifier des fichiers et des dossiers dans Google Drive.
FileFichier dans Google Drive.
FileIteratorItérateur permettant aux scripts d'itérer une collection de fichiers potentiellement volumineuse
FolderUn dossier dans Google Drive.
FolderIteratorObjet permettant aux scripts d'itérer sur une collection potentiellement volumineuse de dossiers.
PermissionÉnumération représentant les autorisations accordées aux utilisateurs ayant accès à un fichier ou à un dossier, en plus des utilisateurs individuels disposant d'un accès explicite.
UserUtilisateur associé à un fichier dans Google Drive.

Access

Propriétés

PropriétéTypeDescription
ANYONEEnumAccessible à tous les internautes via la recherche
ANYONE_WITH_LINKEnumAccessible à tous les utilisateurs disposant du lien
DOMAINEnumAccessible aux utilisateurs de votre domaine via la recherche
DOMAIN_WITH_LINKEnumAccessible aux utilisateurs de votre domaine disposant du lien
PRIVATEEnumAccès réservé aux utilisateurs disposant d'une autorisation expresse.

DriveApp

Propriétés

PropriétéTypeDescription
AccessAccessÉnumération représentant les classes d'utilisateurs pouvant accéder à un fichier ou à un dossier, en plus des utilisateurs individuels disposant d'un accès explicite.
PermissionPermissionÉnumération représentant les autorisations accordées aux utilisateurs ayant accès à un fichier ou à un dossier, en plus des utilisateurs individuels disposant d'un accès explicite.

Méthodes

MéthodeType renvoyéBrève description
continueFileIterator(continuationToken)FileIteratorReprend une itération de fichier à l'aide d'un jeton de continuation provenant d'un itérateur précédent.
continueFolderIterator(continuationToken)FolderIteratorReprend une itération de dossier à l'aide d'un jeton de continuation provenant d'un itérateur précédent.
createFile(blob)FileCrée un fichier à la racine du Drive de l'utilisateur à partir d'une Blob donnée de données arbitraires.
createFile(name, content)FileCrée un fichier texte à la racine du Drive de l'utilisateur avec le nom et le contenu indiqués.
createFile(name, content, mimeType)FileCrée un fichier à la racine du Drive de l'utilisateur avec le nom, le contenu et le type MIME indiqués.
createFolder(name)FolderCrée un dossier avec le nom indiqué à la racine du Drive de l'utilisateur.
createShortcut(targetId)FileCrée un raccourci vers l'ID d'élément Drive fourni et l'affiche.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrée un raccourci vers l'ID d'élément Drive et la clé d'accès à la ressource fournis, puis les renvoie.
enforceSingleParent(value)voidActive ou désactive le comportement d'application d'un seul parent pour tous les appels d'élément.
getFileById(id)FileRécupère le fichier avec l'ID donné.
getFileByIdAndResourceKey(id, resourceKey)FileRécupère le fichier avec l'ID et la clé de ressource donnés.
getFiles()FileIteratorRécupère tous les fichiers du Drive de l'utilisateur.
getFilesByName(name)FileIteratorRécupère tous les fichiers portant le nom indiqué dans le Drive de l'utilisateur.
getFilesByType(mimeType)FileIteratorRécupère tous les fichiers du type Drive dans le Drive de l'utilisateur.
getFolderById(id)FolderRécupère le dossier avec l'ID donné.
getFolderByIdAndResourceKey(id, resourceKey)FolderRécupère le dossier avec l'ID et la clé de ressource donnés.
getFolders()FolderIteratorRécupère tous les dossiers du Drive de l'utilisateur.
getFoldersByName(name)FolderIteratorRécupère tous les dossiers du nom de l'utilisateur dans Drive.
getRootFolder()FolderRécupère le dossier à la racine du Drive de l'utilisateur.
getStorageLimit()IntegerRécupère le nombre d'octets que l'utilisateur est autorisé à stocker dans Drive.
getStorageUsed()IntegerRécupère le nombre d'octets actuellement stockés par l'utilisateur dans Drive.
getTrashedFiles()FileIteratorRécupère tous les fichiers de la corbeille du Drive de l'utilisateur.
getTrashedFolders()FolderIteratorRécupère tous les dossiers dans la corbeille du Drive de l'utilisateur.
searchFiles(params)FileIteratorRécupère tous les fichiers du Drive de l'utilisateur qui correspondent aux critères de recherche indiqués.
searchFolders(params)FolderIteratorRécupère tous les dossiers du Drive de l'utilisateur qui correspondent aux critères de recherche indiqués.

File

Méthodes

MéthodeType renvoyéBrève description
addCommenter(emailAddress)FileAjoutez l'utilisateur donné à la liste des commentateurs du File.
addCommenter(user)FileAjoutez l'utilisateur donné à la liste des commentateurs du File.
addCommenters(emailAddresses)FileAjoutez le tableau d'utilisateurs indiqué à la liste des commentateurs de File.
addEditor(emailAddress)FileAjoute l'utilisateur donné à la liste des éditeurs pour File.
addEditor(user)FileAjoute l'utilisateur donné à la liste des éditeurs pour File.
addEditors(emailAddresses)FileAjoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour File.
addViewer(emailAddress)FileAjoute l'utilisateur donné à la liste des utilisateurs de File.
addViewer(user)FileAjoute l'utilisateur donné à la liste des utilisateurs de File.
addViewers(emailAddresses)FileAjoute le tableau d'utilisateurs indiqué à la liste des utilisateurs pour File.
getAccess(email)PermissionRécupère l'autorisation accordée à l'utilisateur donné.
getAccess(user)PermissionRécupère l'autorisation accordée à l'utilisateur donné.
getAs(contentType)BlobRenvoyez les données de cet objet en tant qu'objet blob converti au type de contenu spécifié.
getBlob()BlobRenvoyez les données de cet objet en tant que blob.
getDateCreated()DateRécupère la date de création de File.
getDescription()StringRécupère la description de File.
getDownloadUrl()StringRécupère l'URL permettant de télécharger le fichier.
getEditors()User[]Récupère la liste des éditeurs pour cet objet File.
getId()StringRécupère l'ID de File.
getLastUpdated()DateRécupère la date de la dernière mise à jour de File.
getMimeType()StringRécupère le type MIME du fichier.
getName()StringRécupère le nom de File.
getOwner()UserRécupère le propriétaire de File.
getParents()FolderIteratorRécupère un ensemble de dossiers qui sont les parents immédiats de File.
getResourceKey()StringRécupère la clé d'accès à la ressource File requise pour accéder aux éléments partagés à l'aide d'un lien.
getSecurityUpdateEligible()BooleanDétermine si cette valeur (File) peut appliquer la mise à jour de sécurité nécessitant une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
getSecurityUpdateEnabled()BooleanDétermine si cette File nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
getSharingAccess()AccessRécupère la classe d'utilisateurs pouvant accéder à File, en plus des utilisateurs individuels disposant d'un accès explicite.
getSharingPermission()PermissionRécupère l'autorisation accordée aux utilisateurs ayant accès à File, en plus des utilisateurs individuels disposant d'un accès explicite.
getSize()IntegerRécupère le nombre d'octets utilisés pour stocker l'élément File dans Drive.
getTargetId()StringS'il s'agit d'un raccourci, renvoie l'ID de l'élément vers lequel il pointe.
getTargetMimeType()StringS'il s'agit d'un raccourci, renvoie le type MIME de l'élément vers lequel il pointe.
getTargetResourceKey()StringS'il s'agit d'un raccourci, affiche la clé d'accès à la ressource de l'élément vers lequel il pointe.
getThumbnail()BlobRécupère une image miniature pour le fichier ou null si aucune vignette n'existe.
getUrl()StringRé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()BooleanDétermine si les utilisateurs disposant de droits de modification sur File sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
isStarred()BooleanDétermine si le File a été ajouté aux favoris dans le Drive de l'utilisateur.
isTrashed()BooleanDétermine si l'élément File se trouve dans la corbeille du Drive de l'utilisateur.
makeCopy()Filecrée une copie du fichier ;
makeCopy(destination)FileCrée une copie du fichier dans le répertoire de destination.
makeCopy(name)FileCrée une copie du fichier et le nomme en utilisant le nom fourni.
makeCopy(name, destination)FileCrée une copie du fichier dans le répertoire de destination et le nomme en utilisant le nom fourni.
moveTo(destination)FileDéplace cet élément vers le dossier de destination fourni.
removeCommenter(emailAddress)FileSupprime l'utilisateur donné de la liste des commentateurs du File.
removeCommenter(user)FileSupprime l'utilisateur donné de la liste des commentateurs du File.
removeEditor(emailAddress)FileSupprime l'utilisateur donné de la liste des éditeurs pour File.
removeEditor(user)FileSupprime l'utilisateur donné de la liste des éditeurs pour File.
removeViewer(emailAddress)FileSupprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour File.
removeViewer(user)FileSupprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour File.
revokePermissions(user)FileRévoque l'accès au File accordé à l'utilisateur donné.
revokePermissions(user)FileRévoque l'accès au File accordé à l'utilisateur donné.
setContent(content)FileCe paramètre permet d'écraser le contenu du fichier par un élément de remplacement donné.
setDescription(description)FileDéfinit la description de File.
setName(name)FileDéfinit le nom de File.
setOwner(emailAddress)FileModifie le propriétaire de File.
setOwner(user)FileModifie le propriétaire de File.
setSecurityUpdateEnabled(enabled)FileIndique si File nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
setShareableByEditors(shareable)FileDétermine si les utilisateurs disposant de droits de modification sur File sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
setSharing(accessType, permissionType)FileDéfinit la classe d'utilisateurs pouvant accéder à File et les autorisations accordées à ces utilisateurs, en plus des utilisateurs qui en ont explicitement bénéficié.
setStarred(starred)FileCe paramètre détermine si le File est suivi dans le Drive de l'utilisateur.
setTrashed(trashed)FileDétermine si l'élément File se trouve dans la corbeille du Drive de l'utilisateur.

FileIterator

Méthodes

MéthodeType renvoyéBrève description
getContinuationToken()StringRécupère un jeton permettant de reprendre cette itération par la suite.
hasNext()BooleanDétermine si l'appel de next() renvoie un élément.
next()FileRécupère l'élément suivant dans la collection de fichiers ou de dossiers.

Folder

Méthodes

MéthodeType renvoyéBrève description
addEditor(emailAddress)FolderAjoute l'utilisateur donné à la liste des éditeurs pour Folder.
addEditor(user)FolderAjoute l'utilisateur donné à la liste des éditeurs pour Folder.
addEditors(emailAddresses)FolderAjoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Folder.
addViewer(emailAddress)FolderAjoute l'utilisateur donné à la liste des utilisateurs de Folder.
addViewer(user)FolderAjoute l'utilisateur donné à la liste des utilisateurs de Folder.
addViewers(emailAddresses)FolderAjoute le tableau d'utilisateurs indiqué à la liste des utilisateurs pour Folder.
createFile(blob)FileCrée un fichier dans le dossier actuel à partir d'un Blob donné de données arbitraires.
createFile(name, content)FileCrée un fichier texte avec le nom et le contenu indiqués dans le dossier actuel.
createFile(name, content, mimeType)FileCrée un fichier dans le dossier actuel avec le nom, le contenu et le type MIME indiqués.
createFolder(name)FolderCrée dans le dossier actuel un dossier portant le nom indiqué.
createShortcut(targetId)FileCrée un raccourci vers l'ID d'élément Drive fourni et l'affiche.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrée un raccourci vers l'ID d'élément Drive et la clé d'accès à la ressource fournis, puis les renvoie.
getAccess(email)PermissionRécupère l'autorisation accordée à l'utilisateur donné.
getAccess(user)PermissionRécupère l'autorisation accordée à l'utilisateur donné.
getDateCreated()DateRécupère la date de création de Folder.
getDescription()StringRécupère la description de Folder.
getEditors()User[]Récupère la liste des éditeurs pour cet objet Folder.
getFiles()FileIteratorRécupère tous les fichiers enfants du dossier actuel.
getFilesByName(name)FileIteratorRécupère tous les fichiers enfants du dossier actuel et portant le nom donné.
getFilesByType(mimeType)FileIteratorRécupère tous les fichiers enfants du dossier actuel et du type MIME indiqué.
getFolders()FolderIteratorRécupère tous les dossiers enfants du dossier actuel.
getFoldersByName(name)FolderIteratorRécupère tous les dossiers enfants du dossier actuel et portant le nom spécifié.
getId()StringRécupère l'ID de Folder.
getLastUpdated()DateRécupère la date de la dernière mise à jour de Folder.
getName()StringRécupère le nom de Folder.
getOwner()UserRécupère le propriétaire de Folder.
getParents()FolderIteratorRécupère un ensemble de dossiers qui sont les parents immédiats de Folder.
getResourceKey()StringRécupère la clé d'accès à la ressource Folder requise pour accéder aux éléments partagés à l'aide d'un lien.
getSecurityUpdateEligible()BooleanDétermine si cette valeur (Folder) peut appliquer la mise à jour de sécurité nécessitant une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
getSecurityUpdateEnabled()BooleanDétermine si cette Folder nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
getSharingAccess()AccessRécupère la classe d'utilisateurs pouvant accéder à Folder, en plus des utilisateurs individuels disposant d'un accès explicite.
getSharingPermission()PermissionRécupère l'autorisation accordée aux utilisateurs ayant accès à Folder, en plus des utilisateurs individuels disposant d'un accès explicite.
getSize()IntegerRécupère le nombre d'octets utilisés pour stocker l'élément Folder dans Drive.
getUrl()StringRé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()BooleanDétermine si les utilisateurs disposant de droits de modification sur Folder sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
isStarred()BooleanDétermine si le Folder a été ajouté aux favoris dans le Drive de l'utilisateur.
isTrashed()BooleanDétermine si l'élément Folder se trouve dans la corbeille du Drive de l'utilisateur.
moveTo(destination)FolderDéplace cet élément vers le dossier de destination fourni.
removeEditor(emailAddress)FolderSupprime l'utilisateur donné de la liste des éditeurs pour Folder.
removeEditor(user)FolderSupprime l'utilisateur donné de la liste des éditeurs pour Folder.
removeViewer(emailAddress)FolderSupprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour Folder.
removeViewer(user)FolderSupprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour Folder.
revokePermissions(user)FolderRévoque l'accès au Folder accordé à l'utilisateur donné.
revokePermissions(user)FolderRévoque l'accès au Folder accordé à l'utilisateur donné.
searchFiles(params)FileIteratorRécupère tous les fichiers enfants du dossier actuel qui correspondent aux critères de recherche indiqués.
searchFolders(params)FolderIteratorRécupère tous les dossiers enfants du dossier actuel qui correspondent aux critères de recherche indiqués.
setDescription(description)FolderDéfinit la description de Folder.
setName(name)FolderDéfinit le nom de Folder.
setOwner(emailAddress)FolderModifie le propriétaire de Folder.
setOwner(user)FolderModifie le propriétaire de Folder.
setSecurityUpdateEnabled(enabled)FolderIndique si Folder nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
setShareableByEditors(shareable)FolderDétermine si les utilisateurs disposant de droits de modification sur Folder sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
setSharing(accessType, permissionType)FolderDéfinit la classe d'utilisateurs pouvant accéder à Folder et les autorisations accordées à ces utilisateurs, en plus des utilisateurs qui en ont explicitement bénéficié.
setStarred(starred)FolderCe paramètre détermine si le Folder est suivi dans le Drive de l'utilisateur.
setTrashed(trashed)FolderDétermine si l'élément Folder se trouve dans la corbeille du Drive de l'utilisateur.

FolderIterator

Méthodes

MéthodeType renvoyéBrève description
getContinuationToken()StringRécupère un jeton permettant de reprendre cette itération par la suite.
hasNext()BooleanDétermine si l'appel de next() renvoie un élément.
next()FolderRécupère l'élément suivant dans la collection de fichiers ou de dossiers.

Permission

Propriétés

PropriétéTypeDescription
VIEWEnumLes utilisateurs autorisés à accéder au fichier ou au dossier peuvent seulement le consulter ou le copier.
EDITEnumLes utilisateurs autorisés à accéder au fichier ou au dossier peuvent le modifier.
COMMENTEnumLes utilisateurs autorisés à accéder au fichier ou au dossier peuvent seulement le consulter, le copier et le commenter.
OWNEREnumL'utilisateur est propriétaire du fichier ou du dossier.
ORGANIZEREnumUtilisateurs pouvant organiser des fichiers et des dossiers dans un Drive partagé.
FILE_ORGANIZEREnumUtilisateurs pouvant modifier, placer dans la corbeille et déplacer du contenu dans un Drive partagé.
NONEEnumL'utilisateur ne dispose d'aucune autorisation pour le fichier ou le dossier.

User

Méthodes

MéthodeType renvoyéBrève description
getDomain()StringRécupère le nom de domaine associé au compte de l'utilisateur.
getEmail()StringRécupère l'adresse e-mail de l'utilisateur.
getName()StringRécupère le nom de l'utilisateur.
getPhotoUrl()StringRécupère l'URL de la photo de l'utilisateur.