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. Bien que le service Drive intégré soit plus facile à utiliser, il présente certaines limites. Pour bénéficier des fonctionnalités et de l'assistance les plus récentes, et pour accéder aux fichiers ou dossiers dans les Drive partagés, utilisez le service Drive avancé.

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 du 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 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 ont été installés 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 est installé par l'administrateur pour certains ou tous les utilisateurs du domaine, ou si un script dont le client OAuth est autorisé 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`	Énumération représentant les classes d'utilisateurs pouvant accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
`DriveApp`	Permet aux scripts de créer, de trouver et de modifier des fichiers et des dossiers dans Google Drive.
`File`	Un fichier dans Google Drive.
`FileIterator`	Il s'agit d'un itérateur qui permet aux scripts d'itérer sur une collection de fichiers potentiellement volumineuse.
`Folder`	Dossier dans Google Drive.
`FolderIterator`	Objet qui permet aux scripts d'itérer sur une collection potentiellement volumineuse 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é.
`User`	Utilisateur associé à un fichier dans Google Drive.

`Access`

Propriétés

Propriété	Type	Description
`ANYONE`	`Enum`	Tous les internautes peuvent trouver et consulter l'élément.
`ANYONE_WITH_LINK`	`Enum`	Accès autorisé pour tous les utilisateurs disposant du lien.
`DOMAIN`	`Enum`	Les membres de votre domaine peuvent trouver et accéder à l'espace.
`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 d'utilisateurs pouvant accéder à un fichier ou à un dossier, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
`Permission`	`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é.

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 l'itération d'un 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 à 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 spécifiés.
`createFolder(name)`	`Folder`	Crée un dossier à la racine du Drive de l'utilisateur avec le nom donné.
`createShortcut(targetId)`	`File`	Crée un raccourci vers l'ID de l'élément Drive fourni et le renvoie.
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	Crée un raccourci vers l'ID et la clé de ressource de l'élément Drive 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 indiqués.
`getFiles()`	`FileIterator`	Récupère une collection de tous les fichiers du Drive de l'utilisateur.
`getFilesByName(name)`	`FileIterator`	Récupère une collection de tous les fichiers du Drive de l'utilisateur portant le nom indiqué.
`getFilesByType(mimeType)`	`FileIterator`	Obtient une collection de tous les fichiers du Drive de l'utilisateur qui ont le type MIME spécifié.
`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 indiqués.
`getFolders()`	`FolderIterator`	Récupère une collection de tous les dossiers du Drive de l'utilisateur.
`getFoldersByName(name)`	`FolderIterator`	Obtient une collection de 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`	Obtient le nombre d'octets que l'utilisateur est autorisé à stocker dans Drive.
`getStorageUsed()`	`Integer`	Obtient 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 du Drive de l'utilisateur.
`getTrashedFolders()`	`FolderIterator`	Récupère une collection de tous les dossiers de la corbeille du Drive de l'utilisateur.
`searchFiles(params)`	`FileIterator`	Obtient une collection de tous les fichiers du Drive de l'utilisateur qui correspondent aux critères de recherche spécifiés.
`searchFolders(params)`	`FolderIterator`	Obtient une collection de tous les dossiers du Drive de l'utilisateur qui correspondent aux critères de recherche spécifiés.

`File`

Méthodes

Méthode	Type renvoyé	Brève description
`addCommenter(emailAddress)`	`File`	Ajoutez l'utilisateur donné à la liste des commentateurs pour `File`.
`addCommenter(user)`	`File`	Ajoutez l'utilisateur donné à la liste des commentateurs pour `File`.
`addCommenters(emailAddresses)`	`File`	Ajoutez le tableau d'utilisateurs donné à la liste des commentateurs pour `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 de `File`.
`addViewer(emailAddress)`	`File`	Ajoute l'utilisateur donné à la liste des spectateurs de `File`.
`addViewer(user)`	`File`	Ajoute l'utilisateur donné à la liste des spectateurs de `File`.
`addViewers(emailAddresses)`	`File`	Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de `File`.
`getAccess(email)`	`Permission`	Obtient l'autorisation accordée à un utilisateur spécifique.
`getAccess(user)`	`Permission`	Obtient 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`	Renvoie les données de cet objet sous forme de blob.
`getDateCreated()`	`Date`	Obtient la date de création de `File`.
`getDescription()`	`String`	Récupère la description de `File`.
`getDownloadUrl()`	`String`	Obtient l'URL qui peut être utilisée pour télécharger le fichier.
`getEditors()`	`User[]`	Obtient la liste des éditeurs pour ce `File`.
`getId()`	`String`	Récupère l'ID du `File`.
`getLastUpdated()`	`Date`	Obtient 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`	Obtient une collection de dossiers qui sont les parents immédiats de `File`.
`getResourceKey()`	`String`	Obtient la clé de ressource du `File` requise pour accéder aux éléments partagés à l'aide d'un lien.
`getSecurityUpdateEligible()`	`Boolean`	Indique si ce `File` peut appliquer la mise à jour de sécurité qui nécessite une clé d'accès à la ressource lorsqu'il est partagé à l'aide d'un lien.
`getSecurityUpdateEnabled()`	`Boolean`	Indique si ce `File` nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien.
`getSharingAccess()`	`Access`	Indique la classe d'utilisateurs pouvant accéder à `File`, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
`getSharingPermission()`	`Permission`	Obtient l'autorisation accordée aux utilisateurs pouvant accéder à `File`, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
`getSize()`	`Integer`	Obtient 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, renvoie la clé de ressource de l'élément vers lequel il pointe.
`getThumbnail()`	`Blob\|null`	Obtient une image miniature du fichier ou `null` si aucune miniature n'existe.
`getUrl()`	`String`	Obtient l'URL qui peut être utilisée pour ouvrir `File` dans une application Google telle que Drive ou Docs.
`getViewers()`	`User[]`	Obtient la liste des lecteurs et des commentateurs pour ce `File`.
`isShareableByEditors()`	`Boolean`	Détermine si les utilisateurs disposant d'autorisations de modification pour le `File` sont autorisés à le 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 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 donne 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 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 le `File`.
`removeEditor(user)`	`File`	Supprime l'utilisateur donné de la liste des éditeurs pour le `File`.
`removeViewer(emailAddress)`	`File`	Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le `File`.
`removeViewer(user)`	`File`	Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le `File`.
`revokePermissions(emailAddress)`	`File`	Révoque l'accès à `File` accordé à l'utilisateur spécifié.
`revokePermissions(user)`	`File`	Révoque l'accès à `File` accordé à l'utilisateur spécifié.
`setContent(content)`	`File`	Écrase le contenu du fichier avec un contenu 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`	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 droits de modification pour le `File` sont autorisés à le 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 qui leur sont accordées, en plus des utilisateurs individuels auxquels l'accès a été explicitement accordé.
`setStarred(starred)`	`File`	Indique si le `File` est favori dans le Drive de l'utilisateur.
`setTrashed(trashed)`	`File`	Indique si le `File` se trouve dans la corbeille du Drive de l'utilisateur.

`FileIterator`

Méthodes

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

`FolderIterator`

Méthodes

Méthode	Type renvoyé	Brève description
`getContinuationToken()`	`String`	Obtient 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`	Obtient l'élément suivant dans la collection de fichiers ou de dossiers.

`Permission`

Propriétés

Propriété	Type	Description
`VIEW`	`Enum`	Les utilisateurs qui ont accès au fichier ou au dossier ne peuvent que le consulter ou le copier.
`EDIT`	`Enum`	Les utilisateurs qui ont accès au fichier ou au dossier peuvent le modifier.
`COMMENT`	`Enum`	Les utilisateurs qui ont accès au fichier ou au dossier ne peuvent que le consulter, le copier ou le commenter.
`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, 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\|null`	Obtient le nom de domaine associé au compte de l'utilisateur.
`getEmail()`	`String\|null`	Récupère l'adresse e-mail de l'utilisateur.
`getName()`	`String\|null`	Récupère le nom de l'utilisateur.
`getPhotoUrl()`	`String\|null`	Obtient l'URL de la photo de l'utilisateur.

Drive Service Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Classes

Propriétés

Propriétés

Méthodes

Méthodes

Méthodes

Méthodes

Méthodes

Propriétés

Méthodes

Drive Service