Drive Service

Drive

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:

Activer 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

NomBrè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é.
DriveAppPermet aux scripts de créer, rechercher et modifier des fichiers et des dossiers dans Google Drive.
FileUn fichier 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 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é.
UserUtilisateur associé à un fichier dans Google Drive.

Access

Propriétés

PropriétéTypeDescription
ANYONEEnumRecherche et accès autorisés pour tous les internautes
ANYONE_WITH_LINKEnumAccès autorisé pour tous les utilisateurs disposant du lien
DOMAINEnumAccès aux utilisateurs de votre domaine via la recherche.
DOMAIN_WITH_LINKEnumAccès 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 qui peuvent accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
PermissionPermissionÉ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éthodeType renvoyéBrève description
continueFileIterator(continuationToken)FileIteratorReprend une itération de fichier à l'aide du jeton de continuation d'un itérateur précédent.
continueFolderIterator(continuationToken)FolderIteratorReprend une itération de dossier à l'aide du jeton de continuation d'un itérateur précédent.
createFile(blob)FileCrée un fichier à la racine du Drive de l'utilisateur à partir d'un Blob donné 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 spécifiés.
createFile(name, content, mimeType)FileCrée un fichier à la racine du Drive de l'utilisateur avec le nom indiqué, le contenu et le type MIME.
createFolder(name)FolderCrée un dossier portant le nom donné à la racine du Drive de l'utilisateur.
createShortcut(targetId)FileCrée un raccourci vers l'ID d'élément Drive fourni, puis l'affiche.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrée un raccourci vers l'ID d'élément Drive et la clé de ressource fournis, puis le renvoie.
enforceSingleParent(value)voidActive ou désactive le comportement "applySingleParent" pour tous les appels affectant les parents d'éléments.
getFileById(id)FileRécupère le fichier avec l'identifiant donné.
getFileByIdAndResourceKey(id, resourceKey)FileRécupère le fichier avec l'ID et la clé de ressource indiqués.
getFiles()FileIteratorRécupère une collection de tous les fichiers dans le Drive de l'utilisateur.
getFilesByName(name)FileIteratorRécupère une collection de tous les fichiers portant le nom donné dans le Drive de l'utilisateur.
getFilesByType(mimeType)FileIteratorRécupère une collection de tous les fichiers du Drive de l'utilisateur qui présentent le type MIME donné.
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 indiqués.
getFolders()FolderIteratorRécupère une collection de tous les dossiers dans le Drive de l'utilisateur.
getFoldersByName(name)FolderIteratorRécupère une collection de tous les dossiers du Drive de l'utilisateur portant le nom donné.
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 que l'utilisateur stocke actuellement dans Drive.
getTrashedFiles()FileIteratorRécupère une collection de tous les fichiers dans la corbeille du Drive de l'utilisateur.
getTrashedFolders()FolderIteratorRécupère une collection de tous les dossiers contenus dans la corbeille du Drive de l'utilisateur.
searchFiles(params)FileIteratorRécupère une collection de tous les fichiers du Drive de l'utilisateur qui correspondent aux critères de recherche indiqués.
searchFolders(params)FolderIteratorRé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éthodeType renvoyéBrève description
addCommenter(emailAddress)FileAjouter l'utilisateur indiqué à la liste des commentateurs de File.
addCommenter(user)FileAjouter l'utilisateur indiqué à la liste des commentateurs de File.
addCommenters(emailAddresses)FileAjoutez le tableau d'utilisateurs indiqué à la liste des commentateurs pour 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 lecteurs pour File.
addViewer(user)FileAjoute l'utilisateur donné à la liste des lecteurs pour File.
addViewers(emailAddresses)FileAjoute le tableau d'utilisateurs donné à la liste des lecteurs 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)BlobRenvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié.
getBlob()BlobRenvoyez les données contenues dans cet objet sous forme d'objet 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 qui peut être utilisée pour télécharger le fichier.
getEditors()User[]Récupère la liste des éditeurs pour ce File.
getId()StringRécupère l'ID d'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 l'élément File.
getOwner()UserRécupère le propriétaire du fichier.
getParents()FolderIteratorRécupère une collection de dossiers parents immédiats de File.
getResourceKey()StringRécupère la clé de ressource du File requise pour accéder aux éléments partagés à l'aide d'un lien.
getSecurityUpdateEligible()BooleanDé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()BooleanDétermine si ce File nécessite une clé d'accès à la ressource lorsqu'il est partagé via un lien.
getSharingAccess()AccessRé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()PermissionRé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()IntegerRécupère le nombre d'octets utilisés pour stocker le 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()StringSi le fichier est un raccourci, renvoie la clé d'accès à la ressource de l'élément vers lequel il pointe.
getThumbnail()BlobRécupère une vignette 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 autorisés à modifier le File sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations.
isStarred()BooleanDétermine si File a été ajouté aux favoris dans le Drive de l'utilisateur.
isTrashed()BooleanDétermine si le 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 lui attribue le nom indiqué.
makeCopy(name, destination)FileCrée une copie du fichier dans le répertoire de destination et lui attribue le nom indiqué.
moveTo(destination)FileDéplace cet élément dans le dossier de destination fourni.
removeCommenter(emailAddress)FileSupprime l'utilisateur indiqué de la liste des commentateurs pour File.
removeCommenter(user)FileSupprime l'utilisateur indiqué de la liste des commentateurs pour File.
removeEditor(emailAddress)FileSupprime l'utilisateur indiqué de la liste des éditeurs pour File.
removeEditor(user)FileSupprime l'utilisateur indiqué de la liste des éditeurs pour File.
removeViewer(emailAddress)FileSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de File.
removeViewer(user)FileSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de File.
revokePermissions(emailAddress)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)FileÉcrase le contenu du fichier par un remplacement donné.
setDescription(description)FileDéfinit la description de File.
setName(name)FileDéfinit le nom de la File.
setOwner(emailAddress)FileModifie le propriétaire de File.
setOwner(user)FileModifie le propriétaire de File.
setSecurityUpdateEnabled(enabled)FileDétermine si l'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 autorisés à modifier le File sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations.
setSharing(accessType, permissionType)FileDé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)FileDétermine si File est ajouté aux favoris dans le Drive de l'utilisateur.
setTrashed(trashed)FileDétermine si le 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 qui peut être utilisé pour reprendre cette itération ultérieurement.
hasNext()BooleanDétermine si l'appel de next() renvoie un article.
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 lecteurs pour Folder.
addViewer(user)FolderAjoute l'utilisateur donné à la liste des lecteurs pour Folder.
addViewers(emailAddresses)FolderAjoute le tableau d'utilisateurs donné à la liste des lecteurs pour Folder.
createFile(blob)FileCrée un fichier dans le dossier actuel à partir d'une Blob donnée de données arbitraires.
createFile(name, content)FileCrée un fichier texte dans le dossier actuel avec le nom et le contenu donnés.
createFile(name, content, mimeType)FileCrée un fichier dans le dossier actuel avec le nom donné, le contenu et le type MIME.
createFolder(name)FolderCrée un dossier portant le nom donné dans le dossier actuel.
createShortcut(targetId)FileCrée un raccourci vers l'ID d'élément Drive fourni, puis l'affiche.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrée un raccourci vers l'ID d'élément Drive et la clé de ressource fournis, puis le 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 ce Folder.
getFiles()FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel.
getFilesByName(name)FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel et portant le nom donné.
getFilesByType(mimeType)FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel et possédant le type MIME donné.
getFolders()FolderIteratorRécupère une collection de tous les dossiers enfants du dossier actuel.
getFoldersByName(name)FolderIteratorRécupère une collection de tous les dossiers enfants du dossier actuel et portant le nom donné.
getId()StringRécupère l'ID d'Folder.
getLastUpdated()DateRécupère la date de la dernière mise à jour de Folder.
getName()StringRécupère le nom de l'élément Folder.
getOwner()UserRécupère le propriétaire de ce Folder.
getParents()FolderIteratorRécupère une collection de dossiers parents immédiats de Folder.
getResourceKey()StringRécupère la clé de ressource du Folder requise pour accéder aux éléments partagés à l'aide d'un lien.
getSecurityUpdateEligible()BooleanDé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()BooleanDétermine si ce Folder nécessite une clé d'accès à la ressource lorsqu'il est partagé via un lien.
getSharingAccess()AccessRé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()PermissionRé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()IntegerRécupère le nombre d'octets utilisés pour stocker le 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 autorisés à modifier le Folder sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations.
isStarred()BooleanDétermine si Folder a été ajouté aux favoris dans le Drive de l'utilisateur.
isTrashed()BooleanDétermine si le Folder se trouve dans la corbeille du Drive de l'utilisateur.
moveTo(destination)FolderDéplace cet élément dans le dossier de destination fourni.
removeEditor(emailAddress)FolderSupprime l'utilisateur indiqué de la liste des éditeurs pour Folder.
removeEditor(user)FolderSupprime l'utilisateur indiqué de la liste des éditeurs pour Folder.
removeViewer(emailAddress)FolderSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Folder.
removeViewer(user)FolderSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Folder.
revokePermissions(emailAddress)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 une collection de tous les fichiers enfants du dossier actuel et correspondant aux critères de recherche indiqués.
searchFolders(params)FolderIteratorRécupère une collection de tous les dossiers enfants du dossier actuel et correspondant aux critères de recherche donnés.
setDescription(description)FolderDéfinit la description de Folder.
setName(name)FolderDéfinit le nom de la Folder.
setOwner(emailAddress)FolderModifie le propriétaire de Folder.
setOwner(user)FolderModifie le propriétaire de Folder.
setSecurityUpdateEnabled(enabled)FolderDétermine si l'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 autorisés à modifier le Folder sont autorisés à partager du contenu avec d'autres utilisateurs ou à modifier les autorisations.
setSharing(accessType, permissionType)FolderDé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)FolderDétermine si Folder est ajouté aux favoris dans le Drive de l'utilisateur.
setTrashed(trashed)FolderDétermine si le 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 qui peut être utilisé pour reprendre cette itération ultérieurement.
hasNext()BooleanDétermine si l'appel de next() renvoie un article.
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 ne peuvent que 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 ne peuvent que le consulter, le copier ou le commenter.
OWNEREnumL'utilisateur est propriétaire du fichier ou du dossier.
ORGANIZEREnumUtilisateurs pouvant organiser les fichiers et les dossiers dans un Drive partagé.
FILE_ORGANIZEREnumUtilisateurs autorisés à 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.