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

Remarque:Administrateurs Google Workspace désactiver le SDK Drive pour leur domaine, ce qui empêche leurs utilisateurs d'installer et d'utiliser Applications 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 service ou Advanced Drive Service (même si le module complémentaire ou l'application Web ont été installés avant que l'administrateur n'ait désactivé SDK Drive).

Toutefois, si un module complémentaire utilisant le service Drive est publié pour une installation au niveau du domaine et installé par l'administrateur pour certains ou tous les utilisateurs du domaine, ou pour tout script qui Le client OAuth figure sur 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`	É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é.
`DriveApp`	Autorise les scripts à créer, rechercher et modifier des fichiers et des dossiers dans Google Drive.
`File`	Un fichier dans Google Drive.
`FileIterator`	Itérateur permettant aux scripts d'effectuer des itérations sur une collection de fichiers potentiellement volumineuse.
`Folder`	Un dossier dans Google Drive
`FolderIterator`	Objet 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é.
`User`	Utilisateur associé à un fichier dans Google Drive.

`Access`

Propriétés

Propriété	Type	Description
`ANYONE`	`Enum`	Accès à tous les internautes via la recherche
`ANYONE_WITH_LINK`	`Enum`	Accessible à tous les utilisateurs disposant du lien.
`DOMAIN`	`Enum`	Accès 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 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é.
`Permission`	`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é.

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 issu d'un itérateur précédent.
`continueFolderIterator(continuationToken)`	`FolderIterator`	Reprend une itération de dossier à l'aide d'un jeton de continuation issu 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 portant le nom et le contenu indiqués à 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 fournis.
`createFolder(name)`	`Folder`	Crée un dossier portant le nom donné à la racine du Drive de l'utilisateur.
`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 d'é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 d'éléments.
`getFileById(id)`	`File`	Récupère le fichier associé à 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 présents dans le Drive de l'utilisateur.
`getFilesByName(name)`	`FileIterator`	Récupère une collection de tous les fichiers du Drive de l'utilisateur portant le nom donné.
`getFilesByType(mimeType)`	`FileIterator`	Récupère une collection de tous les fichiers du Drive de l'utilisateur qui présentent le type MIME donné.
`getFolderById(id)`	`Folder`	Récupère le dossier ayant l'ID donné.
`getFolderByIdAndResourceKey(id, resourceKey)`	`Folder`	Récupère le dossier avec l'ID et la clé de ressource fournis.
`getFolders()`	`FolderIterator`	Récupère une collection de tous les dossiers du Drive de l'utilisateur.
`getFoldersByName(name)`	`FolderIterator`	Récupère une collection de tous les dossiers du Drive de l'utilisateur portant le nom donné.
`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 l'ensemble des fichiers placés dans la corbeille du Drive de l'utilisateur.
`getTrashedFolders()`	`FolderIterator`	Récupère la collection de tous les dossiers placés dans la corbeille du Drive de l'utilisateur.
`searchFiles(params)`	`FileIterator`	Récupère une collection de tous les fichiers du Drive de l'utilisateur correspondant à la recherche donnée. critères.
`searchFolders(params)`	`FolderIterator`	Récupère une collection de tous les dossiers du Drive de l'utilisateur correspondant à la recherche donnée. critères.

`File`

Méthodes

Méthode	Type renvoyé	Brève description
`addCommenter(emailAddress)`	`File`	Ajouter l'utilisateur indiqué à la liste des commentateurs de `File`.
`addCommenter(user)`	`File`	Ajouter l'utilisateur indiqué à la liste des commentateurs de `File`.
`addCommenters(emailAddresses)`	`File`	Ajouter le tableau d'utilisateurs donné à la liste des commentateurs pour `File`.
`addEditor(emailAddress)`	`File`	Ajoute l'utilisateur donné à la liste des éditeurs de `File`.
`addEditor(user)`	`File`	Ajoute l'utilisateur donné à la liste des éditeurs de `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 contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié.
`getBlob()`	`Blob`	Renvoyez les données contenues dans cet objet sous forme de blob.
`getDateCreated()`	`Date`	Récupère la date de création de l'élément `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 de l'élément `File`.
`getOwner()`	`User`	Récupère le propriétaire du fichier.
`getParents()`	`FolderIterator`	Récupère une collection de dossiers qui sont les parents immédiats de `File`.
`getResourceKey()`	`String`	Ré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()`	`Boolean`	Dé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()`	`Boolean`	Dé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()`	`Access`	Ré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()`	`Permission`	Ré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()`	`Integer`	Récupère le nombre d'octets utilisés pour stocker `File` dans Drive.
`getTargetId()`	`String`	S'il s'agit d'un raccourci, cette fonction renvoie l'ID de l'élément vers lequel il pointe.
`getTargetMimeType()`	`String`	S'il s'agit d'un raccourci, cette fonction renvoie le type MIME de l'élément vers lequel il pointe.
`getTargetResourceKey()`	`String`	Si le fichier est un raccourci, renvoie la clé d'accès à la ressource de l'élément vers lequel il pointe.
`getThumbnail()`	`Blob`	Récupère une vignette pour le fichier ou `null` si aucune vignette n'existe.
`getUrl()`	`String`	Ré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()`	`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 `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`	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 dans le dossier de destination fourni.
`removeCommenter(emailAddress)`	`File`	Supprime l'utilisateur indiqué de la liste des commentateurs pour `File`.
`removeCommenter(user)`	`File`	Supprime l'utilisateur indiqué de la liste des commentateurs pour `File`.
`removeEditor(emailAddress)`	`File`	Supprime l'utilisateur indiqué de la liste des éditeurs pour `File`.
`removeEditor(user)`	`File`	Supprime l'utilisateur indiqué de la liste des éditeurs pour `File`.
`removeViewer(emailAddress)`	`File`	Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour `File`.
`removeViewer(user)`	`File`	Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour `File`.
`revokePermissions(emailAddress)`	`File`	Révoque l'accès à `File` accordé à l'utilisateur donné.
`revokePermissions(user)`	`File`	Révoque l'accès à `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 `File`.
`setOwner(emailAddress)`	`File`	Modifie le propriétaire de `File`.
`setOwner(user)`	`File`	Modifie le propriétaire de `File`.
`setSecurityUpdateEnabled(enabled)`	`File`	Dé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)`	`File`	Détermine si les utilisateurs autorisés à modifier le `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`, 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)`	`File`	Détermine si `File` est ajouté aux favoris dans le Drive de l'utilisateur.
`setTrashed(trashed)`	`File`	Détermine 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 qui peut être utilisé pour reprendre cette itération ultérieurement.
`hasNext()`	`Boolean`	Détermine si l'appel de `next()` renvoie un article.
`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 de `Folder`.
`addEditor(user)`	`Folder`	Ajoute l'utilisateur donné à la liste des éditeurs de `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 avec le nom, le contenu et le type MIME dans le dossier actuel.
`createFolder(name)`	`Folder`	Crée un dossier portant le nom donné dans le dossier actuel.
`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 d'élément Drive et la clé de ressource fournis, puis le 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 l'élément `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 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 et portant le nom indiqué.
`getFilesByType(mimeType)`	`FileIterator`	Récupère une collection de tous les fichiers enfants du dossier actuel et possédant 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 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 de l'élément `Folder`.
`getOwner()`	`User`	Récupère le propriétaire de ce `Folder`.
`getParents()`	`FolderIterator`	Récupère une collection de dossiers qui sont les parents immédiats de `Folder`.
`getResourceKey()`	`String`	Ré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()`	`Boolean`	Dé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()`	`Boolean`	Dé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()`	`Access`	Ré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()`	`Permission`	Ré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()`	`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 `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()`	`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 `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 dans le dossier de destination fourni.
`removeEditor(emailAddress)`	`Folder`	Supprime l'utilisateur indiqué de la liste des éditeurs pour `Folder`.
`removeEditor(user)`	`Folder`	Supprime l'utilisateur indiqué de la liste des éditeurs pour `Folder`.
`removeViewer(emailAddress)`	`Folder`	Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour `Folder`.
`removeViewer(user)`	`Folder`	Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour `Folder`.
`revokePermissions(emailAddress)`	`Folder`	Révoque l'accès à `Folder` accordé à l'utilisateur donné.
`revokePermissions(user)`	`Folder`	Révoque l'accès à `Folder` accordé à l'utilisateur donné.
`searchFiles(params)`	`FileIterator`	Récupère une collection de tous les fichiers enfants du dossier actuel et correspondant à la recherche donnée. critères.
`searchFolders(params)`	`FolderIterator`	Récupère une collection de tous les dossiers enfants du dossier actuel et correspondant à la recherche donnée. critères.
`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é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)`	`Folder`	Détermine si les utilisateurs autorisés à modifier le `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`, 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)`	`Folder`	Détermine si `Folder` est ajouté aux favoris dans le Drive de l'utilisateur.
`setTrashed(trashed)`	`Folder`	Détermine 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 qui peut être utilisé pour reprendre cette itération ultérieurement.
`hasNext()`	`Boolean`	Détermine si l'appel de `next()` renvoie un article.
`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 uniquement 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 autorisés à accéder au fichier ou au dossier peuvent uniquement le consulter, le copier ou y ajouter des commentaires.
`OWNER`	`Enum`	L'utilisateur est propriétaire du fichier ou du dossier.
`ORGANIZER`	`Enum`	Utilisateurs pouvant organiser les fichiers et les dossiers d'un Drive partagé.
`FILE_ORGANIZER`	`Enum`	Utilisateurs autorisés à modifier le contenu d'un Drive partagé, à le placer dans la corbeille et à le déplacer.
`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.