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 le nom 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 les applications Google Drive. Ce paramètre empêche également les utilisateurs d'utiliser des scripts Apps Script, des applications Web et des 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 n'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 est installé par l'administrateur pour certains ou tous les utilisateurs du domaine, ou si un script dont l'ID client OAuth est ajouté à la liste d'autorisation par l'administrateur du domaine, le module complémentaire fonctionne pour ces utilisateurs même si le SDK Drive est désactivé dans le domaine.

Classes

Nom	Brève description
`Access`	Enumération représentant les classes d'utilisateurs autorisés à accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`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 qui permet aux scripts d'itérer sur une collection potentiellement importante de fichiers.
`Folder`	Dossier dans Google Drive
`FolderIterator`	Objet permettant aux scripts d'itérer sur une collection potentiellement importante de dossiers.
`Permission`	Enumération représentant les autorisations accordées aux utilisateurs pouvant accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`User`	Utilisateur associé à un fichier dans Google Drive.

`Access`

Propriétés

Propriété	Type	Description
`ANYONE`	`Enum`	Recherche et accès autorisés pour tous les internautes
`ANYONE_WITH_LINK`	`Enum`	Tout utilisateur disposant du lien peut y accéder.
`DOMAIN`	`Enum`	Les membres de votre domaine peuvent le trouver et y accéder.
`DOMAIN_WITH_LINK`	`Enum`	Les utilisateurs de votre domaine disposant du lien peuvent y accéder.
`PRIVATE`	`Enum`	Accès réservé aux utilisateurs disposant d'une autorisation expresse.

`DriveApp`

Propriétés

Propriété	Type	Description
`Access`	`Access`	Enumération représentant les classes d'utilisateurs autorisés à accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`Permission`	`Permission`	Enumération représentant les autorisations accordées aux utilisateurs pouvant accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.

Méthodes

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

`File`

Méthodes

Méthode	Type renvoyé	Brève description
`addCommenter(emailAddress)`	`File`	Ajoutez l'utilisateur donné à la liste des commentateurs de la `File`.
`addCommenter(user)`	`File`	Ajoutez l'utilisateur donné à la liste des commentateurs de la `File`.
`addCommenters(emailAddresses)`	`File`	Ajoutez le tableau d'utilisateurs donné à la liste des commentateurs de l'`File`.
`addEditor(emailAddress)`	`File`	Ajoute l'utilisateur donné à la liste des éditeurs de l'`File`.
`addEditor(user)`	`File`	Ajoute l'utilisateur donné à la liste des éditeurs de l'`File`.
`addEditors(emailAddresses)`	`File`	Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de l'`File`.
`addViewer(emailAddress)`	`File`	Ajoute l'utilisateur donné à la liste des spectateurs de l'`File`.
`addViewer(user)`	`File`	Ajoute l'utilisateur donné à la liste des spectateurs de l'`File`.
`addViewers(emailAddresses)`	`File`	Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de l'`File`.
`getAccess(email)`	`Permission`	Récupère l'autorisation accordée à un utilisateur spécifique.
`getAccess(user)`	`Permission`	Récupère l'autorisation accordée à un utilisateur spécifique.
`getAs(contentType)`	`Blob`	Renvoie les données de cet objet sous forme de 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 l'`File`.
`getDescription()`	`String`	Récupère la description de l'`File`.
`getDownloadUrl()`	`String`	Récupère l'URL permettant de télécharger le fichier.
`getEditors()`	`User[]`	Récupère la liste des éditeurs de cet objet `File`.
`getId()`	`String`	Récupère l'ID du `File`.
`getLastUpdated()`	`Date`	Récupère la date de la dernière mise à jour de l'`File`.
`getMimeType()`	`String`	Récupère le type MIME du fichier.
`getName()`	`String`	Récupère le nom de l'`File`.
`getOwner()`	`User`	Récupère le propriétaire du fichier.
`getParents()`	`FolderIterator`	Récupère une collection de dossiers qui sont des parents immédiats de l'`File`.
`getResourceKey()`	`String`	Récupère la clé de ressource de l'`File` requise pour accéder aux éléments partagés à l'aide d'un lien.
`getSecurityUpdateEligible()`	`Boolean`	Indique si cet élément `File` peut appliquer la mise à jour de sécurité qui nécessite une clé d'accès aux ressources lorsqu'il est partagé à l'aide d'un lien.
`getSecurityUpdateEnabled()`	`Boolean`	Indique si cet élément `File` nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien.
`getSharingAccess()`	`Access`	Permet d'obtenir la classe d'utilisateurs pouvant accéder à `File`, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`getSharingPermission()`	`Permission`	Récupère l'autorisation accordée aux utilisateurs pouvant accéder à `File`, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`getSize()`	`Integer`	Récupère le nombre d'octets utilisés pour stocker le `File` dans Drive.
`getTargetId()`	`String`	S'il s'agit d'un raccourci, renvoie l'ID de l'élément auquel il fait référence.
`getTargetMimeType()`	`String`	S'il s'agit d'un raccourci, renvoie le type MIME de l'élément auquel il fait référence.
`getTargetResourceKey()`	`String`	Si le fichier est un raccourci, renvoie la clé de ressource de l'élément auquel il fait référence.
`getThumbnail()`	`Blob`	Récupère une image miniature du fichier ou `null` si aucune miniature n'existe.
`getUrl()`	`String`	Récupère l'URL permettant d'ouvrir le `File` dans une application Google telle que Drive ou Docs.
`getViewers()`	`User[]`	Récupère la liste des lecteurs et des commentateurs de cet `File`.
`isShareableByEditors()`	`Boolean`	Détermine si les utilisateurs disposant d'autorisations de modification pour le `File` sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
`isStarred()`	`Boolean`	Détermine si l'`File` a été ajouté aux favoris dans Drive de l'utilisateur.
`isTrashed()`	`Boolean`	Détermine si l'`File` se trouve dans la corbeille de 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 lui attribue 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 de l'`File`.
`removeCommenter(user)`	`File`	Supprime l'utilisateur donné de la liste des commentateurs de l'`File`.
`removeEditor(emailAddress)`	`File`	Supprime l'utilisateur donné de la liste des éditeurs de l'`File`.
`removeEditor(user)`	`File`	Supprime l'utilisateur donné de la liste des éditeurs de l'`File`.
`removeViewer(emailAddress)`	`File`	Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'`File`.
`removeViewer(user)`	`File`	Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'`File`.
`revokePermissions(emailAddress)`	`File`	Révoque l'accès à l'`File` accordé à l'utilisateur donné.
`revokePermissions(user)`	`File`	Révoque l'accès à l'`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 de l'`File`.
`setOwner(emailAddress)`	`File`	Modifie le propriétaire de l'`File`.
`setOwner(user)`	`File`	Modifie le propriétaire de l'`File`.
`setSecurityUpdateEnabled(enabled)`	`File`	Indique si `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 disposant des autorisations de modification de 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 des utilisateurs individuels auxquels un accès a été explicitement accordé.
`setStarred(starred)`	`File`	Indique si l'`File` est ajouté aux favoris dans Drive de l'utilisateur.
`setTrashed(trashed)`	`File`	Indique si l'`File` se trouve dans la corbeille de Drive de l'utilisateur.

`FileIterator`

Méthodes

Méthode	Type renvoyé	Brève description
`getContinuationToken()`	`String`	Récupère un jeton pouvant être utilisé pour 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 de 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 de l'`Folder`.
`addEditor(user)`	`Folder`	Ajoute l'utilisateur donné à la liste des éditeurs de l'`Folder`.
`addEditors(emailAddresses)`	`Folder`	Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de l'`Folder`.
`addViewer(emailAddress)`	`Folder`	Ajoute l'utilisateur donné à la liste des spectateurs de l'`Folder`.
`addViewer(user)`	`Folder`	Ajoute l'utilisateur donné à la liste des spectateurs de l'`Folder`.
`addViewers(emailAddresses)`	`Folder`	Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de l'`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 dans le répertoire actuel avec le nom et le contenu donnés.
`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 un dossier dans le dossier actuel avec le nom donné.
`createShortcut(targetId)`	`File`	Crée un raccourci vers l'ID d'élément Drive fourni, puis le renvoie.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Crée un raccourci vers l'ID de l'élément Drive et la clé de ressource fournis, puis le renvoie.
`getAccess(email)`	`Permission`	Récupère l'autorisation accordée à un utilisateur spécifique.
`getAccess(user)`	`Permission`	Récupère l'autorisation accordée à un utilisateur spécifique.
`getDateCreated()`	`Date`	Récupère la date de création de l'`Folder`.
`getDescription()`	`String`	Récupère la description de l'`Folder`.
`getEditors()`	`User[]`	Récupère la liste des éditeurs de cet objet `Folder`.
`getFiles()`	`FileIterator`	Récupère une collection de tous les fichiers qui sont enfants du dossier actuel.
`getFilesByName(name)`	`FileIterator`	Récupère une collection de tous les fichiers qui sont enfants du dossier actuel et portent le nom donné.
`getFilesByType(mimeType)`	`FileIterator`	Récupère une collection de tous les fichiers enfants du dossier actuel et ayant le type MIME donné.
`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 qui sont enfants du dossier actuel et portent le nom donné.
`getId()`	`String`	Récupère l'ID du `Folder`.
`getLastUpdated()`	`Date`	Récupère la date de la dernière mise à jour de l'`Folder`.
`getName()`	`String`	Récupère le nom de l'`Folder`.
`getOwner()`	`User`	Récupère le propriétaire de cet élément `Folder`.
`getParents()`	`FolderIterator`	Récupère une collection de dossiers qui sont des parents immédiats de l'`Folder`.
`getResourceKey()`	`String`	Récupère la clé de ressource de l'`Folder` requise pour accéder aux éléments partagés à l'aide d'un lien.
`getSecurityUpdateEligible()`	`Boolean`	Indique si cet élément `Folder` peut appliquer la mise à jour de sécurité qui nécessite une clé d'accès aux ressources lorsqu'il est partagé à l'aide d'un lien.
`getSecurityUpdateEnabled()`	`Boolean`	Indique si cet élément `Folder` nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien.
`getSharingAccess()`	`Access`	Permet d'obtenir la classe d'utilisateurs pouvant accéder à `Folder`, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`getSharingPermission()`	`Permission`	Récupère l'autorisation accordée aux utilisateurs pouvant accéder à `Folder`, en plus des utilisateurs individuels auxquels un accès a été explicitement accordé.
`getSize()`	`Integer`	Récupère le nombre d'octets utilisés pour stocker le `Folder` dans Drive.
`getUrl()`	`String`	Récupère l'URL permettant d'ouvrir le `Folder` dans une application Google telle que Drive ou Docs.
`getViewers()`	`User[]`	Récupère la liste des lecteurs et des commentateurs de cet `Folder`.
`isShareableByEditors()`	`Boolean`	Détermine si les utilisateurs disposant d'autorisations de modification pour le `Folder` sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
`isStarred()`	`Boolean`	Détermine si l'`Folder` a été ajouté aux favoris dans Drive de l'utilisateur.
`isTrashed()`	`Boolean`	Détermine si l'`Folder` se trouve dans la corbeille de 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 de l'`Folder`.
`removeEditor(user)`	`Folder`	Supprime l'utilisateur donné de la liste des éditeurs de l'`Folder`.
`removeViewer(emailAddress)`	`Folder`	Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'`Folder`.
`removeViewer(user)`	`Folder`	Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'`Folder`.
`revokePermissions(emailAddress)`	`Folder`	Révoque l'accès à l'`Folder` accordé à l'utilisateur donné.
`revokePermissions(user)`	`Folder`	Révoque l'accès à l'`Folder` accordé à l'utilisateur donné.
`searchFiles(params)`	`FileIterator`	Récupère une collection de tous les fichiers qui sont enfants du dossier actuel et correspondent aux critères de recherche donnés.
`searchFolders(params)`	`FolderIterator`	Récupère une collection de tous les dossiers qui sont enfants du dossier actuel et correspondent aux critères de recherche donnés.
`setDescription(description)`	`Folder`	Définit la description de `Folder`.
`setName(name)`	`Folder`	Définit le nom de l'`Folder`.
`setOwner(emailAddress)`	`Folder`	Modifie le propriétaire de l'`Folder`.
`setOwner(user)`	`Folder`	Modifie le propriétaire de l'`Folder`.
`setSecurityUpdateEnabled(enabled)`	`Folder`	Indique si `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 disposant des autorisations de modification de 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 des utilisateurs individuels auxquels un accès a été explicitement accordé.
`setStarred(starred)`	`Folder`	Indique si l'`Folder` est ajouté aux favoris dans Drive de l'utilisateur.
`setTrashed(trashed)`	`Folder`	Indique si l'`Folder` se trouve dans la corbeille de Drive de l'utilisateur.

`FolderIterator`

Méthodes

Méthode	Type renvoyé	Brève description
`getContinuationToken()`	`String`	Récupère un jeton pouvant être utilisé pour 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 de 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 ne peuvent le consulter ou le copier que.
`EDIT`	`Enum`	Les utilisateurs qui peuvent accéder au fichier ou au dossier peuvent le modifier.
`COMMENT`	`Enum`	Les utilisateurs autorisés à accéder au fichier ou au dossier ne peuvent le consulter, le copier ou le commenter que.
`OWNER`	`Enum`	L'utilisateur est le propriétaire du fichier ou du dossier.
`ORGANIZER`	`Enum`	Utilisateurs autorisés à organiser des fichiers et des dossiers dans un Drive partagé
`FILE_ORGANIZER`	`Enum`	Utilisateurs autorisés à modifier, supprimer et déplacer du contenu dans un Drive partagé
`NONE`	`Enum`	L'utilisateur ne dispose d'aucune autorisation pour le fichier ou le 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.