Class File

Fichier

Fichier dans Google Drive. Vous pouvez accéder aux fichiers ou les créer 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)FileAjoutez l'utilisateur donné à la liste des auteurs de commentaires pour le File.
addCommenter(user)FileAjoutez l'utilisateur donné à la liste des auteurs de commentaires pour le File.
addCommenters(emailAddresses)FileAjoutez le tableau d'utilisateurs donné à la liste des commentateurs de File.
addEditor(emailAddress)FileAjoute l'utilisateur donné à la liste des éditeurs pour File.
addEditor(user)FileAjoute l'utilisateur donné à la liste des éditeurs pour 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 pour File.
addViewer(user)FileAjoute l'utilisateur donné à la liste des lecteurs pour 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)BlobRenvoie les données de cet objet en tant que blob converti au type de contenu spécifié.
getBlob()BlobRenvoie les données de cet objet en tant que blob.
getDateCreated()DateRécupère la date de création de 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 ce 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 File.
getOwner()UserRécupère le propriétaire du fichier.
getParents()FolderIteratorRécupère un ensemble de dossiers qui sont les parents immédiats de File.
getResourceKey()StringRécupère la clé de ressource de la classe File nécessaire pour accéder aux éléments partagés à l'aide d'un lien.
getSecurityUpdateEligible()BooleanDétermine si cette File est éligible pour appliquer la mise à jour de sécurité nécessitant une clé de ressource pour l'accès lorsqu'elle est partagée à l'aide d'un lien.
getSecurityUpdateEnabled()BooleanDétermine si cette File nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien.
getSharingAccess()AccessPermet d'identifier la classe d'utilisateur pouvant accéder au File, en plus des utilisateurs individuels auxquels un accès explicite a été accordé.
getSharingPermission()PermissionRécupère l'autorisation accordée aux utilisateurs ayant accès au File en plus des utilisateurs individuels disposant d'un accès explicite.
getSize()IntegerRécupère le nombre d'octets utilisés pour stocker l'élément File dans Drive.
getTargetId()StringS'il s'agit d'un raccourci, renvoie l'ID de l'élément vers lequel il pointe.
getTargetMimeType()StringS'il s'agit d'un raccourci, renvoie le type MIME de l'élément vers lequel il pointe.
getTargetResourceKey()StringSi le fichier est un raccourci, affiche la clé de la ressource de l'élément vers lequel il pointe.
getThumbnail()BlobRécupère une vignette du fichier ou null si aucune vignette n'existe.
getUrl()StringRécupère l'URL permettant d'ouvrir File dans une application Google telle que Drive ou Docs.
getViewers()User[]Récupère la liste des lecteurs et des commentateurs pour ce File.
isShareableByEditors()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 le 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)FileCette opération crée une copie du fichier et le nomme en fonction du nom indiqué.
makeCopy(name, destination)FileCrée une copie du fichier dans le répertoire de destination et le nomme en fonction du nom indiqué.
moveTo(destination)FileDéplace cet élément vers le dossier de destination fourni.
removeCommenter(emailAddress)FileSupprime l'utilisateur donné de la liste des commentateurs pour le File.
removeCommenter(user)FileSupprime l'utilisateur donné de la liste des commentateurs pour le File.
removeEditor(emailAddress)FileSupprime l'utilisateur donné de la liste des éditeurs pour File.
removeEditor(user)FileSupprime l'utilisateur donné de la liste des éditeurs pour File.
removeViewer(emailAddress)FileSupprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour le File.
removeViewer(user)FileSupprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour le File.
revokePermissions(emailAddress)FileRévoque l'accès au File accordé à l'utilisateur donné.
revokePermissions(user)FileRévoque l'accès au File accordé à l'utilisateur donné.
setContent(content)FileÉcrase le contenu du fichier par un élément de remplacement donné.
setDescription(description)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éfinit si le File nécessite une clé de ressource pour l'accès lorsqu'il est partagé à l'aide d'un lien.
setShareableByEditors(shareable)FileIndique si les utilisateurs autorisés à modifier le fichier File sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations.
setSharing(accessType, permissionType)FileDéfinit la classe des utilisateurs pouvant accéder à File et les autorisations accordées à ces utilisateurs, en plus des utilisateurs individuels disposant d'un accès explicite.
setStarred(starred)FileIndique si le suivi de File est activé dans le Drive de l'utilisateur.
setTrashed(trashed)FileIndique si File se trouve dans la corbeille du Drive de l'utilisateur.

Documentation détaillée

addCommenter(emailAddress)

Ajoutez l'utilisateur donné à la liste des auteurs de commentaires pour le File. Si l'utilisateur figure déjà dans la liste, cette méthode le met en avant.

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

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

addCommenter(user)

Ajoutez l'utilisateur donné à la liste des auteurs de commentaires pour le File. Si l'utilisateur figure déjà dans la liste, cette méthode le met en avant.

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

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

addCommenters(emailAddresses)

Ajoutez le tableau d'utilisateurs donné à la liste des commentateurs de File. Si l'un des utilisateurs figure déjà dans la liste, cette méthode le place en dehors de la liste.

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

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

addEditor(emailAddress)

Ajoute l'utilisateur donné à la liste des éditeurs pour File. Si l'utilisateur figure déjà dans la liste, cette méthode le place hors de la liste.

Paramètres

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

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

addEditor(user)

Ajoute l'utilisateur donné à la liste des éditeurs pour File. Si l'utilisateur figure déjà dans la liste, cette méthode le place hors de la liste.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'un des utilisateurs figure déjà dans la liste, cette méthode le place en dehors de la liste.

Paramètres

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

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

addViewer(emailAddress)

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

Paramètres

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

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

addViewer(user)

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

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'un des utilisateurs figurait 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.

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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
emailStringAdresse e-mail de l'utilisateur dont les autorisations doivent être vérifiées

Aller-retour

Permission : autorisations accordées à l'utilisateur

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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

Aller-retour

Permission : autorisations accordées à l'utilisateur

Autorisation

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

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

getAs(contentType)

Renvoie les données de cet objet en tant que blob converti au type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "monfichier.pdf"). Nous supposons toutefois que la partie du nom de fichier qui suit la dernière période (le cas échéant) est une extension existante qui doit être remplacée. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour afficher les quotas quotidiens de conversions, consultez la section Quotas pour les services Google. Les domaines Google Workspace qui viennent d'être créés peuvent être temporairement soumis à des quotas plus stricts.

Paramètres

NomTypeDescription
contentTypeStringType MIME vers lequel effectuer la conversion. Pour la plupart des blobs, 'application/pdf' est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' sont également valides.

Aller-retour

Blob : données sous forme de blob.


getBlob()

Renvoie les données de cet objet en tant que blob.

Aller-retour

Blob : données sous forme de blob.


getDateCreated()

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

Aller-retour

Date : date à laquelle le File a été créé

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Aller-retour

String : description de File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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. Seuls 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 vous ne pouvez pas l'utiliser pour récupérer le fichier avec UrlFetchApp. Si vous souhaitez afficher le contenu du fichier 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());
}

Aller-retour

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 ce 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());
  }
}

Aller-retour

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Aller-retour

String : ID de File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Aller-retour

Date : date de la dernière mise à jour de File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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());
}

Aller-retour

String : type MIME du fichier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 File.

Aller-retour

String : nom de File

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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());
}

Aller-retour

User : propriétaire du fichier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 un ensemble de dossiers qui sont les parents immédiats de File.

Aller-retour

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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é de ressource de la classe File nécessaire pour accéder aux éléments partagés à l'aide d'un lien.

Aller-retour

String : clé de ressource de File.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 cette File est éligible pour appliquer la mise à jour de sécurité nécessitant une clé de ressource pour l'accès lorsqu'elle est partagée à l'aide d'un lien.

Drive nécessite une clé de ressource pour accéder à certains fichiers ou dossiers partagés à l'aide d'un lien. Cette modification s'inscrit dans une mise à jour de sécurité. La mise à jour est activée par défaut pour les fichiers et les dossiers éligibles. Pour activer ou désactiver l'exigence de clé de ressource pour les fichiers éligibles, utilisez setSecurityUpdateEnabled.

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

Aller-retour

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 avec 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 cette File nécessite une clé de ressource pour l'accès lorsqu'elle est partagée via un lien. Cette exigence est activée par défaut pour les fichiers et les dossiers éligibles. Pour activer ou désactiver cette fonctionnalité pour les fichiers éligibles, utilisez setSecurityUpdateEnabled.

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

Aller-retour

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 avec un ou plusieurs des champs d'application suivants:

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

getSharingAccess()

Permet d'identifier la classe d'utilisateur pouvant accéder au File, en plus des utilisateurs individuels auxquels un accès explicite a été accordé.

Aller-retour

Access : classe permettant d'accéder à File.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 au File en plus des utilisateurs individuels disposant d'un accès explicite.

Aller-retour

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 l'élément File dans Drive. Notez que les fichiers d'application Google Workspace ne sont pas comptabilisés dans les limites de stockage Drive et renvoient donc 0 octets.

Aller-retour

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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, renvoie l'ID de l'élément vers lequel il pointe.

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

Aller-retour

String : ID de l'élément cible


getTargetMimeType()

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

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

Aller-retour

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


getTargetResourceKey()

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

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

Aller-retour

String : clé de 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 avec 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 du 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());
}

Aller-retour

Blob : vignette du fichier.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 application Google telle que Drive ou Docs.

Aller-retour

String : URL permettant d'afficher ce File dans une application Google telle que Drive ou Docs

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 pour ce 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();

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

Aller-retour

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Aller-retour

Boolean : true si les utilisateurs autorisés à modifier le fichier sont autorisés à partager avec d'autres utilisateurs ou à modifier les autorisations ; false dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 le File a été ajouté aux favoris dans le Drive de l'utilisateur.

Aller-retour

Boolean : true si le suivi est activé dans le Drive de l'utilisateur File (false, dans le cas contraire)

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Aller-retour

Boolean : true si File se trouve dans la corbeille du Drive de l'utilisateur false dans le cas contraire

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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());
}

Aller-retour

File : nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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.

Aller-retour

File : nouvelle copie.

Autorisation

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

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

makeCopy(name)

Cette opération crée une copie du fichier et le nomme en fonction du nom indiqué.

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

Aller-retour

File : nouvelle copie.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 le nomme en fonction du nom indiqué.

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

Aller-retour

File : nouvelle copie.

Autorisation

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

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

moveTo(destination)

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

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

Paramètres

NomTypeDescription
destinationFolderDossier qui devient le nouveau parent.

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

removeCommenter(emailAddress)

Supprime l'utilisateur donné de la liste des commentateurs pour le File. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple si File est partagé avec l'ensemble de leur 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.

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

removeCommenter(user)

Supprime l'utilisateur donné de la liste des commentateurs pour le File. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple si File est partagé avec l'ensemble de leur 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.

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

removeEditor(emailAddress)

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

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

Paramètres

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

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

removeEditor(user)

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

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

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

removeViewer(emailAddress)

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

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

Paramètres

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

Aller-retour

File : File pour le chaînage.

Autorisation

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

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

removeViewer(user)

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

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

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Aller-retour

File : File pour le chaînage.

Autorisation

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

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

revokePermissions(emailAddress)

Révoque l'accès au File accordé à l'utilisateur donné. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple si File est partagé avec l'ensemble de leur domaine.

Paramètres

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

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

revokePermissions(user)

Révoque l'accès au File accordé à l'utilisateur donné. Cette méthode n'empêche pas les utilisateurs d'accéder à File s'ils appartiennent à une classe d'utilisateurs ayant un accès général, par exemple si File est partagé avec l'ensemble de leur domaine.

Paramètres

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

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

setContent(content)

Écrase le contenu du fichier par un élément de remplacement donné. Génère une exception si la valeur 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.

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 la File

Aller-retour

File : ce File s'enchaîne

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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
nameStringle nouveau nom du File

Aller-retour

File : ce File s'enchaîne

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 accorde également au propriétaire précédent un accès en modification explicite à File.

Paramètres

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

Aller-retour

File : ce File s'enchaîne

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 accorde également au propriétaire précédent un accès en modification explicite à File.

Paramètres

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

Aller-retour

File : ce File s'enchaîne

Autorisation

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

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

setSecurityUpdateEnabled(enabled)

Définit si le File nécessite une clé de ressource pour l'accès lorsqu'il est partagé à 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 la clé de ressource requise pour le File.

Aller-retour

File : cet élément File, pour le chaînage.

Autorisation

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

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

setShareableByEditors(shareable)

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

Paramètres

NomTypeDescription
shareableBooleantrue si les utilisateurs disposant de droits de modification doivent être partagés avec d'autres utilisateurs ou modifier les autorisations. false dans le cas contraire.

Aller-retour

File : ce File s'enchaîne

Autorisation

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

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

setSharing(accessType, permissionType)

Définit la classe des utilisateurs pouvant accéder à File et les autorisations accordées à ces utilisateurs, en plus des utilisateurs individuels disposant d'un accès explicite.

// 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 des utilisateurs doit pouvoir accéder à File
permissionTypePermissionles autorisations à accorder aux utilisateurs ayant accès au File

Aller-retour

File : ce File s'enchaîne

Autorisation

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

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

setStarred(starred)

Indique si le suivi de File est activé dans le Drive de l'utilisateur. La valeur par défaut pour les nouveaux File est false.

Paramètres

NomTypeDescription
starredBooleantrue si l'utilisateur doit suivre File dans le Drive de l'utilisateur ; false dans le cas contraire

Aller-retour

File : ce File s'enchaîne

Autorisation

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

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

setTrashed(trashed)

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

Paramètres

NomTypeDescription
trashedBooleantrue si l'élément File doit être placé dans la corbeille du Drive de l'utilisateur ; false dans le cas contraire.

Aller-retour

File : ce File s'enchaîne

Autorisation

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

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