Drive Service

Drive

Ce service permet aux scripts de créer, de rechercher et de 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, activer manuellement l'API Drive. Dans votre projet Cloud standard, activez l'API Drive:

<ph type="x-smartling-placeholder"></ph> Activer l'API Drive

L'exemple de code suivant montre comment consigner les noms de chaque fichier dans le fichier Dossier "Mon Drive" :
// 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());
}
<ph type="x-smartling-placeholder">

Classes

NomBrève description
AccessÉnumération représentant les classes d'utilisateurs qui peuvent accéder à un fichier ou à un dossier, en plus de tout individu les utilisateurs à qui l'accès a été explicitement accordé.
DriveAppAutorise les scripts à créer, rechercher et modifier des fichiers et des dossiers dans Google Drive.
FileUn fichier dans Google Drive.
FileIteratorItérateur permettant aux scripts d'effectuer des itérations sur une collection de fichiers potentiellement volumineuse.
FolderUn dossier dans Google Drive
FolderIteratorObjet permettant aux scripts d'effectuer des itérations sur une collection de dossiers potentiellement volumineuse.
PermissionÉnumération représentant les autorisations accordées aux utilisateurs qui peuvent accéder à un fichier ou à un dossier, en plus les utilisateurs individuels auxquels l'accès a été explicitement accordé.
UserUtilisateur associé à un fichier dans Google Drive.

Access

Propriétés

PropriétéTypeDescription
ANYONEEnumAccès à tous les internautes via la recherche
ANYONE_WITH_LINKEnumAccessible à tous les utilisateurs disposant du lien.
DOMAINEnumAccès 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 qui peuvent accéder à un fichier ou à un dossier, en plus de tout individu les utilisateurs à qui l'accès a été explicitement accordé.
PermissionPermissionÉnumération représentant les autorisations accordées aux utilisateurs qui peuvent accéder à un fichier ou à un dossier, en plus les 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 d'un jeton de continuation issu d'un itérateur précédent.
continueFolderIterator(continuationToken)FolderIteratorReprend une itération de dossier à l'aide d'un jeton de continuation issu 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 portant le nom et le contenu indiqués à la racine du Drive de l'utilisateur.
createFile(name, content, mimeType)FileCrée un fichier à la racine du Drive de l'utilisateur avec le nom, le contenu et le type MIME fournis.
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 le renvoie.
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 "EnforceSingleParent" pour tous les appels affectant les parents d'éléments.
getFileById(id)FileRécupère le fichier associé à 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 une collection de tous les fichiers présents dans le Drive de l'utilisateur.
getFilesByName(name)FileIteratorRécupère une collection de tous les fichiers du Drive de l'utilisateur portant le nom donné.
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 ayant l'ID donné.
getFolderByIdAndResourceKey(id, resourceKey)FolderRécupère le dossier avec l'ID et la clé de ressource fournis.
getFolders()FolderIteratorRécupère une collection de tous les dossiers du 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 actuellement stockés par l'utilisateur dans Drive.
getTrashedFiles()FileIteratorRécupère l'ensemble des fichiers placés dans la corbeille du Drive de l'utilisateur.
getTrashedFolders()FolderIteratorRécupère la collection de tous les dossiers placés dans la corbeille du Drive de l'utilisateur.
searchFiles(params)FileIteratorRécupère une collection de tous les fichiers du Drive de l'utilisateur correspondant à la recherche donnée. critères.
searchFolders(params)FolderIteratorRécupère une collection de tous les dossiers du Drive de l'utilisateur correspondant à la recherche donnée. critères.

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)FileAjouter le tableau d'utilisateurs donné à la liste des commentateurs pour File.
addEditor(emailAddress)FileAjoute l'utilisateur donné à la liste des éditeurs de File.
addEditor(user)FileAjoute l'utilisateur donné à la liste des éditeurs de File.
addEditors(emailAddresses)FileAjoute le tableau d'utilisateurs donné à la liste des éditeurs pour File.
addViewer(emailAddress)FileAjoute l'utilisateur donné à la liste des lecteurs de File.
addViewer(user)FileAjoute l'utilisateur donné à la liste des lecteurs de 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)BlobRenvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié.
getBlob()BlobRenvoyez les données contenues dans cet objet sous forme de blob.
getDateCreated()DateRécupère la date de création de l'élément 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 élément 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 l'élément File.
getOwner()UserRécupère le propriétaire du fichier.
getParents()FolderIteratorRécupère une collection de dossiers qui sont les parents immédiats de File.
getResourceKey()StringRécupère la clé d'accès à la ressource de l'objet File nécessaire pour accéder aux éléments ont été partagées à l'aide d'un lien.
getSecurityUpdateEligible()BooleanDétermine si cet File est éligible à l'application de la mise à jour de sécurité qui nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
getSecurityUpdateEnabled()BooleanDétermine si cet élément File a besoin d'une clé d'accès à la ressource en cas d' partagés à l'aide d'un lien.
getSharingAccess()AccessRécupère la classe d'utilisateurs qui peuvent accéder à File, en dehors de tous les individus. les utilisateurs à qui l'accès a été explicitement accordé.
getSharingPermission()PermissionRécupère l'autorisation accordée aux utilisateurs ayant accès à File. en plus de tous les utilisateurs individuels auxquels l'accès a été explicitement accordé.
getSize()IntegerRécupère le nombre d'octets utilisés pour stocker File dans Drive.
getTargetId()StringS'il s'agit d'un raccourci, cette fonction renvoie l'ID de l'élément vers lequel il pointe.
getTargetMimeType()StringS'il s'agit d'un raccourci, cette fonction 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 File dans une appli Google, par exemple Drive ou Docs.
getViewers()User[]Récupère la liste des lecteurs et des commentateurs de 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 File a été ajouté aux favoris dans le Drive de l'utilisateur.
isTrashed()BooleanDétermine si 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 fourni.
makeCopy(name, destination)FileCrée une copie du fichier dans le répertoire de destination et lui attribue le nom fourni.
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 pour File.
removeViewer(user)FileSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour File.
revokePermissions(emailAddress)FileRévoque l'accès à File accordé à l'utilisateur donné.
revokePermissions(user)FileRévoque l'accès à 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 File.
setOwner(emailAddress)FileModifie le propriétaire de File.
setOwner(user)FileModifie le propriétaire de File.
setSecurityUpdateEnabled(enabled)FileDétermine si File a besoin d'une clé d'accès à la ressource lorsqu'il est partagés à l'aide d'un lien.
setShareableByEditors(shareable)FileDétermine si les utilisateurs autorisés à modifier le 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, ainsi que les autorisations. ces utilisateurs se voient accorder l'accès, outre les 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 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 de Folder.
addEditor(user)FolderAjoute l'utilisateur donné à la liste des éditeurs de Folder.
addEditors(emailAddresses)FolderAjoute le tableau d'utilisateurs donné à la liste des éditeurs pour Folder.
addViewer(emailAddress)FolderAjoute l'utilisateur donné à la liste des lecteurs de Folder.
addViewer(user)FolderAjoute l'utilisateur donné à la liste des lecteurs de 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'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 avec le nom, le contenu et le type MIME dans le dossier actuel.
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 le renvoie.
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 l'élément Folder.
getDescription()StringRécupère la description de Folder.
getEditors()User[]Récupère la liste des éditeurs pour cet élément 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 indiqué.
getFilesByType(mimeType)FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel et possédant le type MIME spécifié.
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 de 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 qui sont les parents immédiats de Folder.
getResourceKey()StringRécupère la clé d'accès à la ressource de l'objet Folder nécessaire pour accéder aux éléments ont été partagées à l'aide d'un lien.
getSecurityUpdateEligible()BooleanDétermine si cet Folder est éligible à l'application de la mise à jour de sécurité qui nécessite une clé d'accès à la ressource lorsqu'elle est partagée via un lien.
getSecurityUpdateEnabled()BooleanDétermine si cet élément Folder a besoin d'une clé d'accès à la ressource en cas d' partagés à l'aide d'un lien.
getSharingAccess()AccessRécupère la classe d'utilisateurs qui peuvent accéder à Folder, en dehors de tous les individus. les utilisateurs à qui l'accès a été explicitement accordé.
getSharingPermission()PermissionRécupère l'autorisation accordée aux utilisateurs ayant accès à Folder. en plus de tous les utilisateurs individuels auxquels l'accès a été explicitement accordé.
getSize()IntegerRécupère le nombre d'octets utilisés pour stocker Folder dans Drive.
getUrl()StringRécupère l'URL permettant d'ouvrir Folder dans une appli Google, par exemple Drive ou Docs.
getViewers()User[]Récupère la liste des lecteurs et des commentateurs de 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 Folder a été ajouté aux favoris dans le Drive de l'utilisateur.
isTrashed()BooleanDétermine si 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 pour Folder.
removeViewer(user)FolderSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour Folder.
revokePermissions(emailAddress)FolderRévoque l'accès à Folder accordé à l'utilisateur donné.
revokePermissions(user)FolderRévoque l'accès à Folder accordé à l'utilisateur donné.
searchFiles(params)FileIteratorRécupère une collection de tous les fichiers enfants du dossier actuel et correspondant à la recherche donnée. critères.
searchFolders(params)FolderIteratorRécupère une collection de tous les dossiers enfants du dossier actuel et correspondant à la recherche donnée. critères.
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)FolderDétermine si Folder a besoin d'une clé d'accès à la ressource lorsqu'il est partagés à l'aide d'un lien.
setShareableByEditors(shareable)FolderDétermine si les utilisateurs autorisés à modifier le 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, ainsi que les autorisations. ces utilisateurs se voient accorder l'accès, outre les 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 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 peuvent uniquement le consulter ou le copier.
EDITEnumLes utilisateurs qui ont accès au fichier ou au dossier peuvent le modifier.
COMMENTEnumLes utilisateurs autorisés à accéder au fichier ou au dossier peuvent uniquement le consulter, le copier ou y ajouter des commentaires.
OWNEREnumL'utilisateur est propriétaire du fichier ou du dossier.
ORGANIZEREnumUtilisateurs pouvant organiser les fichiers et les dossiers d'un Drive partagé.
FILE_ORGANIZEREnumUtilisateurs autorisés à modifier le contenu d'un Drive partagé, à le placer dans la corbeille et à le déplacer.
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.