Class File

Fichier

Un fichier dans Google Drive. Les fichiers peuvent être consultés ou créés depuis DriveApp.

// Trash every untitled spreadsheet that hasn't been updated in a week.
var files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  var file = files.next();
  if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) {
    file.setTrashed(true);
  }
}

Méthodes

MéthodeType renvoyéBrève description
addCommenter(emailAddress)FileAjouter l'utilisateur indiqué à la liste des commentateurs de File.
addCommenter(user)FileAjouter l'utilisateur indiqué à la liste des commentateurs de File.
addCommenters(emailAddresses)FileAjouter le tableau d'utilisateurs donné à la liste des commentateurs pour File.
addEditor(emailAddress)FileAjoute l'utilisateur donné à la liste des éditeurs de File.
addEditor(user)FileAjoute l'utilisateur donné à la liste des éditeurs de File.
addEditors(emailAddresses)FileAjoute le tableau d'utilisateurs donné à la liste des éditeurs pour File.
addViewer(emailAddress)FileAjoute l'utilisateur donné à la liste des lecteurs de File.
addViewer(user)FileAjoute l'utilisateur donné à la liste des lecteurs de File.
addViewers(emailAddresses)FileAjoute le tableau d'utilisateurs donné à la liste des lecteurs pour File.
getAccess(email)PermissionRécupère l'autorisation accordée à l'utilisateur donné.
getAccess(user)PermissionRécupère l'autorisation accordée à l'utilisateur donné.
getAs(contentType)BlobRenvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié.
getBlob()BlobRenvoyez les données contenues dans cet objet sous forme de blob.
getDateCreated()DateRécupère la date de création de l'élément File.
getDescription()StringRécupère la description de File.
getDownloadUrl()StringRé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()StringRécupère l'ID de File.
getLastUpdated()DateRécupère la date de la dernière mise à jour de File.
getMimeType()StringRécupère le type MIME du fichier.
getName()StringRécupère le nom de l'élément File.
getOwner()UserRécupère le propriétaire du fichier.
getParents()FolderIteratorRécupère une collection de dossiers qui sont les parents immédiats de File.
getResourceKey()StringRé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()BooleanDé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()BooleanDé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()AccessRé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()PermissionRé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()IntegerRécupère le nombre d'octets utilisés pour stocker File dans Drive.
getTargetId()StringS'il s'agit d'un raccourci, cette fonction renvoie l'ID de l'élément vers lequel il pointe.
getTargetMimeType()StringS'il s'agit d'un raccourci, cette fonction renvoie le type MIME de l'élément vers lequel il pointe.
getTargetResourceKey()StringSi le fichier est un raccourci, renvoie la clé d'accès à la ressource de l'élément vers lequel il pointe.
getThumbnail()BlobRécupère une vignette pour le fichier ou null si aucune vignette n'existe.
getUrl()StringRé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()BooleanDétermine si les utilisateurs disposant de droits de modification sur File sont autorisés à partager avec d'autres utilisateurs ou modifier les autorisations.
isStarred()BooleanDétermine si File a été ajouté aux favoris dans le Drive de l'utilisateur.
isTrashed()BooleanDétermine si File se trouve dans la corbeille du Drive de l'utilisateur.
makeCopy()FileCrée une copie du fichier.
makeCopy(destination)FileCrée une copie du fichier dans le répertoire de destination.
makeCopy(name)FileCrée une copie du fichier et lui attribue le nom fourni.
makeCopy(name, destination)FileCrée une copie du fichier dans le répertoire de destination et lui attribue le nom fourni.
moveTo(destination)FileDéplace cet élément dans le dossier de destination fourni.
removeCommenter(emailAddress)FileSupprime l'utilisateur indiqué de la liste des commentateurs pour File.
removeCommenter(user)FileSupprime l'utilisateur indiqué de la liste des commentateurs pour File.
removeEditor(emailAddress)FileSupprime l'utilisateur indiqué de la liste des éditeurs pour File.
removeEditor(user)FileSupprime l'utilisateur indiqué de la liste des éditeurs pour File.
removeViewer(emailAddress)FileSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour File.
removeViewer(user)FileSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour File.
revokePermissions(emailAddress)FileRévoque l'accès à File accordé à l'utilisateur donné.
revokePermissions(user)FileRévoque l'accès à File accordé à l'utilisateur donné.
setContent(content)FileÉcrase le contenu du fichier par un remplacement donné.
setDescription(description)FileDéfinit la description de File.
setName(name)FileDéfinit le nom de File.
setOwner(emailAddress)FileModifie le propriétaire de File.
setOwner(user)FileModifie le propriétaire de File.
setSecurityUpdateEnabled(enabled)FileDé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)FileDétermine si les utilisateurs autorisés à modifier le File sont autorisés à partager avec d'autres utilisateurs ou modifier les autorisations.
setSharing(accessType, permissionType)FileDé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)FileDétermine si File est ajouté aux favoris dans le Drive de l'utilisateur.
setTrashed(trashed)FileDétermine si File se trouve dans la corbeille du Drive de l'utilisateur.

Documentation détaillée

addCommenter(emailAddress)

Ajouter l'utilisateur indiqué à la liste des commentateurs de File. Si l'utilisateur était figurant déjà dans la liste des lecteurs, cette méthode écarte l'utilisateur de la liste des lecteurs.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you
// want to add as a commenter.
while (files.hasNext()) {
  const file = files.next();
  email = 'cloudysanfrancisco@gmail.com';
  console.log(file.addCommenter(email));
}

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

addCommenter(user)

Ajouter l'utilisateur indiqué à la liste des commentateurs de File. Si l'utilisateur était figurant déjà dans la liste des lecteurs, cette méthode écarte l'utilisateur de la liste des lecteurs.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Adds the active user as a commenter.
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter(Session.getActiveUser());
}

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

addCommenters(emailAddresses)

Ajouter le tableau d'utilisateurs donné à la liste des commentateurs pour File. Le cas échéant des utilisateurs figuraient déjà dans la liste des lecteurs, cette méthode les met en retrait de la liste les lecteurs.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

while (files.hasNext()) {
  const file = files.next();
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and
  // 'baklavainthebalkans@gmail.com' with the email addresses to add as commenters.
  const emails = ['cloudysanfrancisco@gmail.com','baklavainthebalkans@gmail.com'];
  console.log(file.addCommenters(emails));
}

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

addEditor(emailAddress)

Ajoute l'utilisateur donné à la liste des éditeurs de File. Si l'utilisateur était déjà dans la liste des lecteurs, cette méthode met l'utilisateur hors de la liste des lecteurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

addEditor(user)

Ajoute l'utilisateur donné à la liste des éditeurs de File. Si l'utilisateur était déjà dans la liste des lecteurs, cette méthode met l'utilisateur hors de la liste des lecteurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

addEditors(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des éditeurs pour File. Si l'une des valeurs que les utilisateurs figuraient déjà dans la liste des lecteurs, cette méthode les met en retrait de la liste les lecteurs.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

addViewer(emailAddress)

Ajoute l'utilisateur donné à la liste des lecteurs de File. Si l'utilisateur était déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

addViewer(user)

Ajoute l'utilisateur donné à la liste des lecteurs de File. Si l'utilisateur était déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

addViewers(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des lecteurs pour File. Si l'une des valeurs si des utilisateurs figuraient déjà dans la liste des éditeurs, cette méthode n'a aucun effet pour eux.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

getAccess(email)

Récupère l'autorisation accordée à l'utilisateur donné.

Paramètres

NomTypeDescription
emailStringL'adresse e-mail de l'utilisateur dont les autorisations doivent être vérifiées

Renvois

Permission : autorisations accordées à l'utilisateur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAccess(user)

Récupère l'autorisation accordée à l'utilisateur donné.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur dont les autorisations doivent être vérifiées

Renvois

Permission : autorisations accordées à l'utilisateur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAs(contentType)

Renvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié. Ce ajoute l'extension appropriée au nom du fichier (par exemple, "myfile.pdf"). Cependant, il suppose que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une à remplacer. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour connaître les quotas quotidiens de conversion, consultez la page Quotas Services. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des règles des quotas.

Paramètres

NomTypeDescription
contentTypeStringType MIME vers lequel effectuer la conversion. Pour la plupart des blobs, 'application/pdf' correspond à est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, les valeurs 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' le sont également. valide. Pour un document Google Docs, 'text/markdown' est également valide.

Renvois

Blob : données sous forme de blob.


getBlob()

Renvoyez les données contenues dans cet objet sous forme de blob.

Renvois

Blob : données sous forme de blob.


getDateCreated()

Récupère la date de création de l'élément File.

Renvois

Date : date de création de l'élément File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDescription()

Récupère la description de File.

Renvois

String : description de File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDownloadUrl()

Récupère l'URL permettant de télécharger le fichier. Uniquement les utilisateurs autorisés à ouvrir le fichier dans Google Drive peuvent accéder à l'URL. Vous pouvez utiliser cette URL dans un navigateur pour télécharger le fichier, mais que vous ne pouvez pas utiliser pour récupérer le fichier avec UrlFetchApp. Si vous souhaitez que le contenu dans le script, utilisez getBlob().

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the download URLs to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getDownloadUrl());
}

Renvois

String : URL permettant de télécharger le fichier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getEditors()

Récupère la liste des éditeurs pour cet élément File. Si l'utilisateur qui exécute le script n'est pas autorisé à modifier File, cette méthode renvoie un tableau vide.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Adds the email addresses in the array as editors of each file.
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com'
  // and 'baklavainthebalkans@gmail.com' with valid email addresses.
  file.addEditors(['cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com']);

  // Gets a list of the file editors.
  const editors = file.getEditors();

  // For each file, logs the editors' email addresses to the console.
  for (const editor of editors) {
    console.log(editor.getEmail());
  }
}

Renvois

User[] : si l'utilisateur est autorisé à modifier ce File, renvoie la liste des éditeurs. Si l'utilisateur n'est pas autorisé à le modifier, un tableau vide est renvoyé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getId()

Récupère l'ID de File.

Renvois

String : ID du File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getLastUpdated()

Récupère la date de la dernière mise à jour de File.

Renvois

Date : date de la dernière mise à jour de l'élément File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getMimeType()

Récupère le type MIME du fichier.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the MIME type to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getMimeType());
}

Renvois

String : type MIME du fichier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getName()

Récupère le nom de l'élément File.

Renvois

String : nom du File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getOwner()

Récupère le propriétaire du fichier.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the names of the file owners to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getOwner().getName());
}

Renvois

User : propriétaire du fichier

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getParents()

Récupère une collection de dossiers qui sont les parents immédiats de File.

Renvois

FolderIterator : ensemble de dossiers qui sont les parents immédiats du File.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getResourceKey()

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.

Renvois

String : clé d'accès à la ressource de File.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEligible()

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.

Drive a besoin d'une clé d'accès à la ressource pour accéder à certains fichiers ou dossiers qui ont été partagés à l'aide d'un . Ce changement s'inscrit dans le cadre d'une mise à jour de sécurité. La mise à jour est activée par défaut pour des fichiers et des dossiers. Pour activer ou désactiver l'exigence de clé d'accès aux ressources pour les fichiers éligibles, utilisez setSecurityUpdateEnabled

En savoir plus sur la mise à jour de sécurité pour Google Drive

Renvois

Boolean : indique si l'exigence de clé de ressource peut être appliquée pour File.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEnabled()

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. Cette exigence est activée par défaut pour les fichiers et dossiers éligibles. Pour activer ou désactiver l'exigence de clé d'accès à la ressource pour les fichiers éligibles, utilisez setSecurityUpdateEnabled.

En savoir plus sur la mise à jour de sécurité pour Google Drive

Renvois

Boolean : indique si l'exigence de clé de ressource est activée pour ce File.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingAccess()

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é.

Renvois

Access : classe d'utilisateurs pouvant accéder à File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingPermission()

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é.

Renvois

Permission : autorisations accordées aux utilisateurs ayant accès au File.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSize()

Récupère le nombre d'octets utilisés pour stocker File dans Drive. Notez que Les fichiers des applications Google Workspace ne sont pas comptabilisés dans les limites de stockage Drive et renvoient donc 0 octets.

Renvois

Integer : nombre d'octets utilisés pour stocker le File dans Drive

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getTargetId()

S'il s'agit d'un raccourci, cette fonction renvoie l'ID de l'élément vers lequel il pointe.

Sinon, elle renvoie null.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the target ID of the shortcut.
console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);

Renvois

String : ID de l'élément cible.


getTargetMimeType()

S'il s'agit d'un raccourci, cette fonction renvoie le type MIME de l'élément vers lequel il pointe.

Sinon, elle renvoie null.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the MIME type of the file that the shortcut points to.
console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);

Renvois

String : type MIME de l'élément cible.


getTargetResourceKey()

Si le fichier est un raccourci, renvoie la clé d'accès à la ressource de l'élément vers lequel il pointe. Une clé d'accès à la ressource un paramètre supplémentaire que vous devez transmettre pour accéder aux fichiers partagés à l'aide d'un .

Si le fichier n'est pas un raccourci, il renvoie null.

// Gets a file by its ID.
// TODO(developer): Replace 'abc123456' with your file ID.
const file = DriveApp.getFileById('abc123456');

// If the file is a shortcut, returns the resource key of the file that it points to.
console.log(file.getTargetResourceKey());

Renvois

String : clé d'accès à la ressource de l'élément cible ou null si le fichier n'est pas un raccourci

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getThumbnail()

Récupère une vignette pour le fichier ou null si aucune vignette n'existe.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Logs the thumbnail image for each file to the console as a blob,
  // or null if no thumbnail exists.
  console.log(file.getThumbnail());
}

Renvois

Blob : vignette du fichier

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getUrl()

Récupère l'URL permettant d'ouvrir File dans une appli Google, par exemple Drive ou Docs.

Renvois

String : l'URL qui peut être utilisée pour afficher ce File dans une appli Google comme Drive ou Docs

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getViewers()

Récupère la liste des lecteurs et des commentateurs de File. Si l'utilisateur qui exécute le script et n'est pas autorisé à modifier File, cette méthode renvoie un tableau vide.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // For each file, logs the viewers' email addresses to the console.
  const viewers = file.getViewers();
  for (viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

Renvois

User[] : si l'utilisateur est autorisé à modifier ce File, renvoie la liste des les lecteurs et les commentateurs. Si l'utilisateur n'est pas autorisé à le modifier, un tableau vide est renvoyé.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isShareableByEditors()

Détermine si les utilisateurs disposant de droits de modification sur File sont autorisés à partager avec d'autres utilisateurs ou modifier les autorisations.

Renvois

Boolean : true si les utilisateurs disposant de droits de modification sont autorisés à partager du contenu avec d'autres utilisateurs ou modifier les autorisations ; false si ce n'est pas le cas

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isStarred()

Détermine si File a été ajouté aux favoris dans le Drive de l'utilisateur.

Renvois

Boolean : true si File est ajouté aux favoris dans le Drive de l'utilisateur false si ce n'est pas le cas

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isTrashed()

Détermine si File se trouve dans la corbeille du Drive de l'utilisateur.

Renvois

Boolean : true si File se trouve dans la corbeille du Drive de l'utilisateur false si ce n'est pas le cas

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

makeCopy()

Crée une copie du fichier.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and logs the file name to the console.
  console.log(file.makeCopy().getName());
}

Renvois

File : nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

makeCopy(destination)

Crée une copie du fichier dans le répertoire de destination.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and adds it to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy(destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

Paramètres

NomTypeDescription
destinationFolderRépertoire dans lequel copier le fichier.

Renvois

File : nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

makeCopy(name)

Crée une copie du fichier et lui attribue le nom fourni.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and sets the name to 'Test-Copy.'
  const filename = file.makeCopy('Test-Copy');

  // Logs the copied file's name to the console.
  console.log(filename.getName());
}

Paramètres

NomTypeDescription
nameStringNom de fichier à appliquer à la nouvelle copie.

Renvois

File : nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

makeCopy(name, destination)

Crée une copie du fichier dans le répertoire de destination et lui attribue le nom fourni.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file, sets the file name, and adds the copied file
  // to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy('Test-Copy', destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

Paramètres

NomTypeDescription
nameStringNom de fichier à appliquer à la nouvelle copie.
destinationFolderRépertoire dans lequel copier le fichier.

Renvois

File : nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

moveTo(destination)

Déplace cet élément dans le dossier de destination fourni.

L'utilisateur actuel doit être le propriétaire du fichier ou avoir au moins un accès en modification aux dossier parent actuel afin de déplacer l'élément vers le dossier de destination.

Paramètres

NomTypeDescription
destinationFolderDossier qui devient le nouveau parent.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

removeCommenter(emailAddress)

Supprime l'utilisateur indiqué de la liste des commentateurs pour File. Cette méthode n'empêche pas les utilisateurs d'accéder au File s'ils appartiennent à une classe d'utilisateurs qui disposent d'un accès général, par exemple si le File est partagé avec l'utilisateur dans l'ensemble du domaine.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  // TODO(developer): Replace the email with the email of the user you want to remove.
  file.removeCommenter('cloudysanfrancisco@gmail.com');
}

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

removeCommenter(user)

Supprime l'utilisateur indiqué de la liste des commentateurs pour File. Cette méthode n'empêche pas les utilisateurs d'accéder au File s'ils appartiennent à une classe d'utilisateurs qui disposent d'un accès général, par exemple si le File est partagé avec l'utilisateur dans l'ensemble du domaine.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  console.log(file.removeCommenter(Session.getActiveUser()));
}

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

removeEditor(emailAddress)

Supprime l'utilisateur indiqué de la liste des éditeurs pour File. Cette méthode ne permet pas empêcher les utilisateurs d'accéder au File s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple, si le File est partagé avec l'ensemble domaine, ou si File se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des lecteurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

removeEditor(user)

Supprime l'utilisateur indiqué de la liste des éditeurs pour File. Cette méthode ne permet pas empêcher les utilisateurs d'accéder au File s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple, si le File est partagé avec l'ensemble domaine, ou si File se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des lecteurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

removeViewer(emailAddress)

Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour File. Ce n'a aucun effet si l'utilisateur est un éditeur, et non un lecteur ou un commentateur. Cette méthode permet également n'empêche pas les utilisateurs d'accéder au File s'ils appartiennent à une classe d'utilisateurs qui disposer d'un accès général (par exemple, si le File est partagé avec le compte l'ensemble du domaine, ou si le File se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des éditeurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Renvois

File : File pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

removeViewer(user)

Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour File. Ce n'a aucun effet si l'utilisateur est un éditeur et non un lecteur. Cette méthode ne bloque pas non plus utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs ayant des droits d'accès l'accès, par exemple si le File est partagé avec l'ensemble du domaine de l'utilisateur ; si File se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également supprimé de la liste des éditeurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

File : File pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

revokePermissions(emailAddress)

Révoque l'accès à File accordé à l'utilisateur donné. Cette méthode ne permet pas empêcher les utilisateurs d'accéder au File s'ils appartiennent à une classe d'utilisateurs qui disposer d'un accès général (par exemple, si le File est partagé avec le compte dans l'ensemble du domaine.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur dont l'accès doit être révoqué.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

revokePermissions(user)

Révoque l'accès à File accordé à l'utilisateur donné. Cette méthode ne permet pas empêcher les utilisateurs d'accéder au File s'ils appartiennent à une classe d'utilisateurs qui disposer d'un accès général (par exemple, si le File est partagé avec le compte dans l'ensemble du domaine.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur dont l'accès doit être révoqué.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setContent(content)

Écrase le contenu du fichier par un remplacement donné. Une exception est générée si la taille de content est supérieure à 10 Mo.

// Creates a text file with the content 'Hello, world!'
file = DriveApp.createFile('New Text File', 'Hello, world!');

// Logs the content of the text file to the console.
console.log(file.getBlob().getDataAsString());

// Updates the content of the text file to 'Updated text!'
file.setContent('Updated text!')

// Logs content of the text file to the console.
console.log(file.getBlob().getDataAsString());

Paramètres

NomTypeDescription
contentStringNouveau contenu du fichier.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setDescription(description)

Définit la description de File.

Paramètres

NomTypeDescription
descriptionStringla nouvelle description de File

Renvois

File : File, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setName(name)

Définit le nom de File.

Paramètres

NomTypeDescription
nameStringNouveau nom de File

Renvois

File : File, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setOwner(emailAddress)

Modifie le propriétaire de File. Cette méthode donne également au propriétaire précédent autorisation explicite de modifier File.

Paramètres

NomTypeDescription
emailAddressStringL'adresse e-mail de l'utilisateur qui doit devenir le nouveau propriétaire

Renvois

File : File, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setOwner(user)

Modifie le propriétaire de File. Cette méthode donne également au propriétaire précédent autorisation explicite de modifier File.

Paramètres

NomTypeDescription
userUserune représentation de l'utilisateur qui doit devenir le nouveau propriétaire ;

Renvois

File : File, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setSecurityUpdateEnabled(enabled)

Détermine si File a besoin d'une clé d'accès à la ressource lorsqu'il est partagés à l'aide d'un lien. Les fichiers et dossiers éligibles sont activés par défaut.

En savoir plus sur la mise à jour de sécurité pour Google Drive

Paramètres

NomTypeDescription
enabledBooleanPermet d'activer ou non l'exigence de clé ressource pour File.

Renvois

File : File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setShareableByEditors(shareable)

Détermine si les utilisateurs autorisés à modifier le File sont autorisés à partager avec d'autres utilisateurs ou modifier les autorisations. La valeur par défaut pour un nouveau File est true

Paramètres

NomTypeDescription
shareableBooleantrue si les utilisateurs disposant de droits de modification doivent être autorisés à partager avec d’autres utilisateurs ou de modifier les autorisations ; false si ce n'est pas le cas

Renvois

File : File, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setSharing(accessType, permissionType)

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é.

// Creates a folder that anyone on the Internet can read from and write to. (Domain
// administrators can prohibit this setting for users of a Google Workspace domain.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Paramètres

NomTypeDescription
accessTypeAccessla classe d'utilisateurs qui doit pouvoir accéder à File
permissionTypePermissionles autorisations à accorder aux utilisateurs ayant accès au File.

Renvois

File : File, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setStarred(starred)

Détermine si File est ajouté aux favoris dans le Drive de l'utilisateur. Par défaut, les nouvelles valeurs File sont false.

Paramètres

NomTypeDescription
starredBooleantrue si File doit être ajouté aux favoris dans la Drive false si ce n'est pas le cas

Renvois

File : File, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive

setTrashed(trashed)

Détermine si File se trouve dans la corbeille du Drive de l'utilisateur. Seuls les le propriétaire peut supprimer File. La valeur par défaut pour les nouveaux File est false.

Paramètres

NomTypeDescription
trashedBooleantrue si File doit être placé dans la corbeille de dans le Drive de l'utilisateur ; false si ce n'est pas le cas

Renvois

File : File, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

  • https://www.googleapis.com/auth/drive