Cette page a été traduite par l'API Cloud Translation.

Drive Service

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());
}

Remarque:Les administrateurs de domaines Google Workspace peuvent désactiver le SDK Drive pour leur domaine, ce qui empêche leurs utilisateurs d'installer et d'utiliser des applications Google Drive. Ce paramètre empêche également les utilisateurs d'utiliser les scripts Apps Script, les applications Web et les modules complémentaires qui utilisent le service Drive ou le service Drive avancé (même si le module complémentaire ou l'application Web en question a été installé avant que l'administrateur ne désactive le SDK Drive).

Toutefois, si un module complémentaire utilisant le service Drive est publié pour une installation à l'échelle du domaine et qu'il est installé par l'administrateur pour tout ou partie des utilisateurs du domaine, ou pour tout utilisateur d'Apps Script pour lequel son client OAuth a été ajouté à la liste d'autorisation par l'administrateur du domaine, les modules complémentaires de ces utilisateurs même si le SDK Drive est désactivé dans le domaine.

Classes

Nom	Brève description
`Access`	Énumération représentant les classes des utilisateurs pouvant accéder à un fichier ou un dossier, en plus de tous les utilisateurs individuels disposant d'un accès explicite.
`DriveApp`	Permet aux scripts de créer, de rechercher et de modifier des fichiers et des dossiers dans Google Drive.
`File`	Fichier dans Google Drive.
`FileIterator`	Itérateur permettant aux scripts d'effectuer des itérations sur une collection de fichiers potentiellement volumineuse
`Folder`	Dossier dans Google Drive.
`FolderIterator`	Objet permettant aux scripts d'effectuer des itérations sur une collection potentiellement volumineuse.
`Permission`	Énumération représentant les autorisations accordées aux utilisateurs ayant accès à un fichier ou dossier, en plus des utilisateurs individuels disposant d'un accès explicite.
`User`	Utilisateur associé à un fichier dans Google Drive.

`Access`

Propriétés

Propriété	Type	Description
`ANYONE`	`Enum`	Accessible à tous les internautes via la recherche
`ANYONE_WITH_LINK`	`Enum`	Accessible à toute personne disposant du lien.
`DOMAIN`	`Enum`	Accessible aux utilisateurs de votre domaine via la recherche
`DOMAIN_WITH_LINK`	`Enum`	Accessible 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 des utilisateurs pouvant accéder à un fichier ou un dossier, en plus de tous les utilisateurs individuels disposant d'un accès explicite.
`Permission`	`Permission`	Énumération représentant les autorisations accordées aux utilisateurs ayant accès à un fichier ou dossier, en plus des utilisateurs individuels disposant d'un accès explicite.

Méthodes

Méthode	Type renvoyé	Brève description
`continueFileIterator(continuationToken)`	`FileIterator`	Reprend une itération de fichier à l'aide d'un jeton de continuation d'un itérateur précédent.
`continueFolderIterator(continuationToken)`	`FolderIterator`	Reprend une itération de dossier à l'aide d'un 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 indiqués.
`createFile(name, content, mimeType)`	`File`	Crée un fichier à la racine du Drive de l'utilisateur avec le nom, le contenu et le type MIME donnés.
`createFolder(name)`	`Folder`	Crée un dossier portant le nom indiqué à la racine du Drive de l'utilisateur.
`createShortcut(targetId)`	`File`	Crée un raccourci vers l'ID d'élément Drive fourni et l'affiche.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Crée un raccourci vers l'ID d'élément Drive et la clé de ressource fournis, puis les renvoie.
`enforceSingleParent(value)`	`void`	Active ou désactive l'application du comportement SingleSingle pour tous les appels affectant les éléments parents.
`getFileById(id)`	`File`	Récupère le fichier correspondant à l'ID donné.
`getFileByIdAndResourceKey(id, resourceKey)`	`File`	Récupère le fichier avec l'ID et la clé de ressource donnés.
`getFiles()`	`FileIterator`	Récupère un ensemble de fichiers dans le Drive de l'utilisateur.
`getFilesByName(name)`	`FileIterator`	Récupère tous les fichiers portant le nom indiqué dans le Drive de l'utilisateur.
`getFilesByType(mimeType)`	`FileIterator`	Récupère un ensemble de fichiers du Drive de l'utilisateur qui possèdent le type MIME donné.
`getFolderById(id)`	`Folder`	Récupère le dossier dont l'identifiant est indiqué.
`getFolderByIdAndResourceKey(id, resourceKey)`	`Folder`	Récupère le dossier avec l'ID et la clé de ressource indiqués.
`getFolders()`	`FolderIterator`	Récupère tous les dossiers du Drive de l'utilisateur.
`getFoldersByName(name)`	`FolderIterator`	Récupère tous les dossiers du Drive de l'utilisateur portant le nom indiqué.
`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 actuellement stockés par l'utilisateur dans Drive.
`getTrashedFiles()`	`FileIterator`	Récupère un ensemble de fichiers dans la corbeille du Drive de l'utilisateur.
`getTrashedFolders()`	`FolderIterator`	Récupère un ensemble de dossiers dans la corbeille du Drive de l'utilisateur.
`searchFiles(params)`	`FileIterator`	Récupère tous les fichiers du Drive de l'utilisateur qui correspondent aux critères de recherche indiqués.
`searchFolders(params)`	`FolderIterator`	Récupère tous les dossiers du Drive de l'utilisateur qui correspondent aux critères de recherche indiqués.

`File`

Méthodes

Méthode	Type renvoyé	Brève description
`addCommenter(emailAddress)`	`File`	Ajoutez l'utilisateur donné à la liste des commentateurs du `File`.
`addCommenter(user)`	`File`	Ajoutez l'utilisateur donné à la liste des commentateurs du `File`.
`addCommenters(emailAddresses)`	`File`	Ajoutez le tableau d'utilisateurs donné à la liste des commentateurs du `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 donné à la liste des éditeurs pour `File`.
`addViewer(emailAddress)`	`File`	Ajoute l'utilisateur donné à la liste des lecteurs de `File`.
`addViewer(user)`	`File`	Ajoute l'utilisateur donné à la liste des lecteurs de `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`	Renvoyez les données de cet objet en tant qu'objet 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 `File`.
`getDescription()`	`String`	Récupère la description de `File`.
`getDownloadUrl()`	`String`	Ré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()`	`String`	Récupère l'ID de `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 du `File`.
`getOwner()`	`User`	Récupère le propriétaire du fichier.
`getParents()`	`FolderIterator`	Récupère un ensemble de dossiers qui sont les parents immédiats de `File`.
`getResourceKey()`	`String`	Récupère la clé de ressource de `File` qui est requise pour accéder aux éléments partagés à l'aide d'un lien.
`getSecurityUpdateEligible()`	`Boolean`	Détermine si cette `File` est éligible pour appliquer la mise à jour de sécurité nécessitant une clé de ressource d'accès lorsqu'elle est partagée via un lien.
`getSecurityUpdateEnabled()`	`Boolean`	Détermine si cette clé (`File`) nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien.
`getSharingAccess()`	`Access`	Récupère la classe d'utilisateurs pouvant accéder à `File`, en plus de tous les utilisateurs individuels disposant d'un accès explicite.
`getSharingPermission()`	`Permission`	Récupère l'autorisation accordée aux utilisateurs ayant accès à `File`, en plus de tous les utilisateurs individuels disposant d'un accès explicite.
`getSize()`	`Integer`	Récupère le nombre d'octets utilisés pour stocker `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, la clé de ressource de l'élément vers lequel elle pointe est renvoyée.
`getThumbnail()`	`Blob`	Récupère une vignette du 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 cet élément `File`.
`isShareableByEditors()`	`Boolean`	Détermine si les utilisateurs disposant de droits de modification sur l'`File` sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
`isStarred()`	`Boolean`	Détermine si le `File` a été ajouté aux favoris dans le Drive de l'utilisateur.
`isTrashed()`	`Boolean`	Détermine si l'élément `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 fourni.
`makeCopy(name, destination)`	`File`	Crée une copie du fichier dans le répertoire de destination et le nomme en utilisant 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 pour `File`.
`removeCommenter(user)`	`File`	Supprime l'utilisateur donné de la liste des commentateurs pour `File`.
`removeEditor(emailAddress)`	`File`	Supprime l'utilisateur donné de la liste des éditeurs pour `File`.
`removeEditor(user)`	`File`	Supprime l'utilisateur donné de la liste des éditeurs pour `File`.
`removeViewer(emailAddress)`	`File`	Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour `File`.
`removeViewer(user)`	`File`	Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour `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 du `File`.
`setOwner(emailAddress)`	`File`	Modifie le propriétaire de `File`.
`setOwner(user)`	`File`	Modifie le propriétaire de `File`.
`setSecurityUpdateEnabled(enabled)`	`File`	Indique si `File` nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien.
`setShareableByEditors(shareable)`	`File`	Détermine si les utilisateurs disposant de droits de modification sur 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 de tous les utilisateurs individuels disposant d'un accès explicite.
`setStarred(starred)`	`File`	Détermine si le `File` est ajouté aux favoris dans le Drive de l'utilisateur.
`setTrashed(trashed)`	`File`	Détermine si l'élément `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()` renverra un élément.
`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 donné à la liste des éditeurs pour `Folder`.
`addViewer(emailAddress)`	`Folder`	Ajoute l'utilisateur donné à la liste des lecteurs de `Folder`.
`addViewer(user)`	`Folder`	Ajoute l'utilisateur donné à la liste des lecteurs de `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'un `Blob` donné de données arbitraires.
`createFile(name, content)`	`File`	Crée un fichier texte avec le nom et le contenu indiqués dans le dossier actuel.
`createFile(name, content, mimeType)`	`File`	Crée un fichier dans le dossier actuel avec le nom, le contenu et le type MIME donnés.
`createFolder(name)`	`Folder`	Crée dans le dossier actuel un dossier portant le nom donné.
`createShortcut(targetId)`	`File`	Crée un raccourci vers l'ID d'élément Drive fourni et l'affiche.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Crée un raccourci vers l'ID d'élément Drive et la clé de ressource fournis, puis les 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 cet élément `Folder`.
`getFiles()`	`FileIterator`	Récupère tous les fichiers enfants du dossier actuel.
`getFilesByName(name)`	`FileIterator`	Récupère 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 qui sont associés au type MIME donné.
`getFolders()`	`FolderIterator`	Récupère la 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 de `Folder`.
`getLastUpdated()`	`Date`	Récupère la date de la dernière mise à jour de `Folder`.
`getName()`	`String`	Récupère le nom du `Folder`.
`getOwner()`	`User`	Récupère le propriétaire de `Folder`.
`getParents()`	`FolderIterator`	Récupère un ensemble de dossiers qui sont les parents immédiats de `Folder`.
`getResourceKey()`	`String`	Récupère la clé de ressource de `Folder` qui est requise pour accéder aux éléments partagés à l'aide d'un lien.
`getSecurityUpdateEligible()`	`Boolean`	Détermine si cette `Folder` est éligible pour appliquer la mise à jour de sécurité nécessitant une clé de ressource d'accès lorsqu'elle est partagée via un lien.
`getSecurityUpdateEnabled()`	`Boolean`	Détermine si cette clé (`Folder`) nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien.
`getSharingAccess()`	`Access`	Récupère la classe d'utilisateurs pouvant accéder à `Folder`, en plus de tous les utilisateurs individuels disposant d'un accès explicite.
`getSharingPermission()`	`Permission`	Récupère l'autorisation accordée aux utilisateurs ayant accès à `Folder`, en plus de tous les utilisateurs individuels disposant d'un accès explicite.
`getSize()`	`Integer`	Récupère le nombre d'octets utilisés pour stocker `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 cet élément `Folder`.
`isShareableByEditors()`	`Boolean`	Détermine si les utilisateurs disposant de droits de modification sur l'`Folder` sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
`isStarred()`	`Boolean`	Détermine si le `Folder` a été ajouté aux favoris dans le Drive de l'utilisateur.
`isTrashed()`	`Boolean`	Détermine si l'élément `Folder` se trouve dans la corbeille du Drive de l'utilisateur.
`moveTo(destination)`	`Folder`	Déplace cet élément vers le dossier de destination fourni.
`removeEditor(emailAddress)`	`Folder`	Supprime l'utilisateur donné de la liste des éditeurs pour `Folder`.
`removeEditor(user)`	`Folder`	Supprime l'utilisateur donné de la liste des éditeurs pour `Folder`.
`removeViewer(emailAddress)`	`Folder`	Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour `Folder`.
`removeViewer(user)`	`Folder`	Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour `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 tous les fichiers enfants du dossier actuel qui correspondent aux critères de recherche indiqués.
`searchFolders(params)`	`FolderIterator`	Récupère un ensemble de dossiers enfants du dossier actuel qui correspondent aux critères de recherche indiqués.
`setDescription(description)`	`Folder`	Définit la description de `Folder`.
`setName(name)`	`Folder`	Définit le nom du `Folder`.
`setOwner(emailAddress)`	`Folder`	Modifie le propriétaire de `Folder`.
`setOwner(user)`	`Folder`	Modifie le propriétaire de `Folder`.
`setSecurityUpdateEnabled(enabled)`	`Folder`	Indique si `Folder` nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien.
`setShareableByEditors(shareable)`	`Folder`	Détermine si les utilisateurs disposant de droits de modification sur l'`Folder` sont autorisés à partager 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 accordées à ces utilisateurs, en plus de tous les utilisateurs individuels disposant d'un accès explicite.
`setStarred(starred)`	`Folder`	Détermine si le `Folder` est ajouté aux favoris dans le Drive de l'utilisateur.
`setTrashed(trashed)`	`Folder`	Détermine si l'élément `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()` renverra un élément.
`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 pourront seulement 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 peuvent seulement le consulter, le copier et y ajouter des commentaires.
`OWNER`	`Enum`	L'utilisateur est propriétaire du fichier ou du dossier.
`ORGANIZER`	`Enum`	Utilisateurs pouvant organiser des fichiers et des dossiers au sein d'un Drive partagé.
`FILE_ORGANIZER`	`Enum`	Utilisateurs pouvant modifier, placer dans la corbeille et déplacer du contenu au sein d'un Drive partagé.
`NONE`	`Enum`	L'utilisateur ne dispose d'aucune autorisation pour le fichier ou 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.