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.

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 les noms de chaque fichier 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());
}

Remarque:Les administrateurs 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 a été installé avant que l'administrateur ait désactivé 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 certains utilisateurs ou tous les utilisateurs du domaine, ou pour tout script dont le client OAuth est ajouté à la liste d'autorisation par l'administrateur du domaine, les modules complémentaires fonctionnent pour 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 des utilisateurs individuels disposant d'un accès explicite.
`DriveApp`	Permet aux scripts de créer, rechercher et 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 potentiellement volumineuse.
`Folder`	Un dossier dans Google Drive
`FolderIterator`	Objet permettant aux scripts d'effectuer des itérations sur un ensemble de dossiers potentiellement volumineux.
`Permission`	Énumération représentant les autorisations accordées aux utilisateurs qui peuvent accéder à un fichier ou à un 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`	Tous les internautes peuvent rechercher l'élément et y accéder.
`ANYONE_WITH_LINK`	`Enum`	Accessible à tous les utilisateurs disposant du lien
`DOMAIN`	`Enum`	Les membres de votre domaine peuvent rechercher les éléments et y accéder.
`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 des utilisateurs pouvant accéder à un fichier ou à un dossier, en plus des utilisateurs individuels disposant d'un accès explicite.
`Permission`	`Permission`	Énumération représentant les autorisations accordées aux utilisateurs qui peuvent accéder à un fichier ou à un 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 provenant d'un itérateur précédent.
`continueFolderIterator(continuationToken)`	`FolderIterator`	Reprend une itération de dossier à l'aide d'un jeton de continuation provenant 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` de données arbitraires.
`createFile(name, content)`	`File`	Crée un fichier texte avec le nom et le contenu indiqués dans la racine du Drive de l'utilisateur.
`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 indiqués.
`createFolder(name)`	`Folder`	Crée un dossier avec le nom donné à la racine du Drive de l'utilisateur.
`createShortcut(targetId)`	`File`	Crée un raccourci vers l'ID de l'élément Drive fourni, puis l'affiche.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Crée un raccourci vers l'ID de l'élément Drive et la clé de ressource fournis, puis l'affiche.
`enforceSingleParent(value)`	`void`	Active ou désactive le comportement applySingleParent pour tous les appels affectant les parents de l'élément.
`getFileById(id)`	`File`	Récupère le fichier avec l'ID indiqué.
`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 tous les fichiers de type MIME du Drive d'un utilisateur.
`getFolderById(id)`	`Folder`	Récupère le dossier avec l'ID indiqué.
`getFolderByIdAndResourceKey(id, resourceKey)`	`Folder`	Récupère le dossier avec l'ID et la clé de ressource donnés.
`getFolders()`	`FolderIterator`	Récupère tous les dossiers dans le Drive de l'utilisateur.
`getFoldersByName(name)`	`FolderIterator`	Récupère un ensemble de dossiers contenant le nom attribué dans le Drive de l'utilisateur.
`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 stockés par l'utilisateur dans Drive.
`getTrashedFiles()`	`FileIterator`	Récupère un ensemble de tous les 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 auteurs de commentaires pour le `File`.
`addCommenter(user)`	`File`	Ajoutez l'utilisateur donné à la liste des auteurs de commentaires pour le `File`.
`addCommenters(emailAddresses)`	`File`	Ajoutez le tableau d'utilisateurs donné à la liste des commentateurs de `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 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 de cet objet en tant que blob converti au type de contenu spécifié.
`getBlob()`	`Blob`	Renvoie les données de cet objet en tant que 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 ce `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 de `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 la classe `File` nécessaire 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 pour l'accès lorsqu'elle est partagée à l'aide d'un lien.
`getSecurityUpdateEnabled()`	`Boolean`	Détermine si cette `File` nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien.
`getSharingAccess()`	`Access`	Permet d'identifier la classe d'utilisateur pouvant accéder au `File`, en plus des utilisateurs individuels auxquels un accès explicite a été accordé.
`getSharingPermission()`	`Permission`	Récupère l'autorisation accordée aux utilisateurs ayant accès au `File` en plus des utilisateurs individuels disposant d'un accès explicite.
`getSize()`	`Integer`	Récupère le nombre d'octets utilisés pour stocker l'élément `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, affiche la clé de la ressource de l'élément vers lequel il pointe.
`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 `File` dans une application Google telle que Drive ou Docs.
`getViewers()`	`User[]`	Récupère la liste des lecteurs et des commentateurs pour ce `File`.
`isShareableByEditors()`	`Boolean`	Détermine si les utilisateurs disposant de droits de modification sur `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 `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`	Cette opération crée une copie du fichier et le nomme en fonction du nom indiqué.
`makeCopy(name, destination)`	`File`	Crée une copie du fichier dans le répertoire de destination et le nomme en fonction du nom indiqué.
`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 le `File`.
`removeCommenter(user)`	`File`	Supprime l'utilisateur donné de la liste des commentateurs pour le `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 le `File`.
`removeViewer(user)`	`File`	Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour le `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 élément de remplacement donné.
`setDescription(description)`	`File`	Définit la description de `File`.
`setName(name)`	`File`	Définit le nom de `File`.
`setOwner(emailAddress)`	`File`	Modifie le propriétaire de `File`.
`setOwner(user)`	`File`	Modifie le propriétaire de `File`.
`setSecurityUpdateEnabled(enabled)`	`File`	Définit si le `File` nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien.
`setShareableByEditors(shareable)`	`File`	Indique si les utilisateurs autorisés à modifier le fichier `File` sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
`setSharing(accessType, permissionType)`	`File`	Définit la classe des utilisateurs pouvant accéder à `File` et les autorisations accordées à ces utilisateurs, en plus des utilisateurs individuels disposant d'un accès explicite.
`setStarred(starred)`	`File`	Indique si le suivi de `File` est activé dans le Drive de l'utilisateur.
`setTrashed(trashed)`	`File`	Indique si `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 permettant de reprendre cette itération ultérieurement.
`hasNext()`	`Boolean`	Détermine si l'appel de `next()` renvoie 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 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'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 indiqués.
`createFolder(name)`	`Folder`	Crée un dossier avec le nom donné dans le dossier actuel.
`createShortcut(targetId)`	`File`	Crée un raccourci vers l'ID de l'élément Drive fourni, puis l'affiche.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Crée un raccourci vers l'ID de l'élément Drive et la clé de ressource fournis, puis l'affiche.
`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 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 tous les fichiers enfants du dossier actuel qui sont de type MIME.
`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 spécifié.
`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 de `Folder`.
`getOwner()`	`User`	Récupère le propriétaire de ce `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 la classe `Folder` nécessaire 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 pour l'accès lorsqu'elle est partagée à l'aide d'un lien.
`getSecurityUpdateEnabled()`	`Boolean`	Détermine si cette `Folder` nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien.
`getSharingAccess()`	`Access`	Permet d'identifier la classe d'utilisateur pouvant accéder au `Folder`, en plus des utilisateurs individuels auxquels un accès explicite a été accordé.
`getSharingPermission()`	`Permission`	Récupère l'autorisation accordée aux utilisateurs ayant accès au `Folder` en plus des utilisateurs individuels disposant d'un accès explicite.
`getSize()`	`Integer`	Récupère le nombre d'octets utilisés pour stocker l'élément `Folder` dans Drive.
`getUrl()`	`String`	Récupère l'URL permettant d'ouvrir `Folder` dans une application Google telle que Drive ou Docs.
`getViewers()`	`User[]`	Récupère la liste des lecteurs et des commentateurs pour ce `Folder`.
`isShareableByEditors()`	`Boolean`	Détermine si les utilisateurs disposant de droits de modification sur `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 `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 le `Folder`.
`removeViewer(user)`	`Folder`	Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour le `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 de `Folder`.
`setOwner(emailAddress)`	`Folder`	Modifie le propriétaire de `Folder`.
`setOwner(user)`	`Folder`	Modifie le propriétaire de `Folder`.
`setSecurityUpdateEnabled(enabled)`	`Folder`	Définit si le `Folder` nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien.
`setShareableByEditors(shareable)`	`Folder`	Indique si les utilisateurs autorisés à modifier le fichier `Folder` sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
`setSharing(accessType, permissionType)`	`Folder`	Définit la classe des utilisateurs pouvant accéder à `Folder` et les autorisations accordées à ces utilisateurs, en plus des utilisateurs individuels disposant d'un accès explicite.
`setStarred(starred)`	`Folder`	Indique si le suivi de `Folder` est activé dans le Drive de l'utilisateur.
`setTrashed(trashed)`	`Folder`	Indique si `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 permettant de reprendre cette itération ultérieurement.
`hasNext()`	`Boolean`	Détermine si l'appel de `next()` renvoie 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 peuvent 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 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 n'est pas autorisé à accéder au fichier ou au 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.