Class File

Archivo

Un archivo en Google Drive Se puede acceder a los archivos o crearlos desde 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étodos

MétodoTipo de datos que se muestraDescripción breve
addCommenter(emailAddress)FileAgrega el usuario determinado a la lista de comentaristas de File.
addCommenter(user)FileAgrega el usuario determinado a la lista de comentaristas de File.
addCommenters(emailAddresses)FileAgrega el array de usuarios determinado a la lista de comentaristas de File.
addEditor(emailAddress)FileAgrega el usuario determinado a la lista de editores del File.
addEditor(user)FileAgrega el usuario determinado a la lista de editores del File.
addEditors(emailAddresses)FileAgrega el array de usuarios determinado a la lista de editores del File.
addViewer(emailAddress)FileAgrega el usuario determinado a la lista de visualizadores de File.
addViewer(user)FileAgrega el usuario determinado a la lista de visualizadores de File.
addViewers(emailAddresses)FileAgrega el array de usuarios determinado a la lista de visualizadores de File.
getAccess(email)PermissionObtiene el permiso otorgado al usuario determinado.
getAccess(user)PermissionObtiene el permiso otorgado al usuario determinado.
getAs(contentType)BlobMuestra los datos dentro de este objeto como un BLOB convertido al tipo de contenido especificado.
getBlob()BlobMuestra los datos dentro de este objeto como un BLOB.
getDateCreated()DateObtiene la fecha en que se creó el File.
getDescription()StringObtiene la descripción de File.
getDownloadUrl()StringObtiene la URL que se puede usar para descargar el archivo.
getEditors()User[]Obtiene la lista de editores para este File.
getId()StringObtiene el ID de File.
getLastUpdated()DateObtiene la fecha en que se actualizó el File por última vez.
getMimeType()StringObtiene el tipo de MIME del archivo.
getName()StringObtiene el nombre de File.
getOwner()UserObtiene el propietario del archivo.
getParents()FolderIteratorObtiene una colección de carpetas que son superiores inmediatos de File.
getResourceKey()StringObtiene la clave de recurso del File que se requiere para acceder a los elementos que se compartieron a través de un vínculo.
getSecurityUpdateEligible()BooleanObtiene si este File es apto para aplicar la actualización de seguridad que requiere una clave de recurso para acceder cuando se comparte mediante un vínculo.
getSecurityUpdateEnabled()BooleanObtiene si este File requiere una clave de recurso para acceder cuando se comparte mediante un vínculo.
getSharingAccess()AccessObtiene qué clase de usuarios puede acceder a File, además de los usuarios individuales a los que se les otorgó acceso de forma explícita.
getSharingPermission()PermissionObtiene el permiso otorgado a aquellos usuarios que pueden acceder a File, además de los usuarios individuales a los que se les otorgó acceso de manera explícita.
getSize()IntegerObtiene la cantidad de bytes que se usan para almacenar el File en Drive.
getTargetId()StringSi se trata de una combinación de teclas, muestra el ID del elemento al que apunta.
getTargetMimeType()StringSi se trata de un atajo, muestra el tipo de MIME del elemento al que apunta.
getTargetResourceKey()StringSi el archivo es un acceso directo, muestra la clave de recurso del elemento al que apunta.
getThumbnail()BlobObtiene una imagen en miniatura para el archivo o null si no existe una miniatura.
getUrl()StringObtiene la URL que se puede usar para abrir el archivo File en una app de Google, como Drive o Documentos.
getViewers()User[]Obtiene la lista de lectores y comentaristas de este File.
isShareableByEditors()BooleanDetermina si los usuarios con permisos de edición para File pueden compartir contenido con otros usuarios o cambiar los permisos.
isStarred()BooleanDetermina si el elemento File se destacó en la unidad de Drive del usuario.
isTrashed()BooleanDetermina si el elemento File está en la papelera de la unidad de Drive del usuario.
makeCopy()FileCrea una copia del archivo.
makeCopy(destination)FileCrea una copia del archivo en el directorio de destino.
makeCopy(name)FileCrea una copia del archivo y le asigna el nombre proporcionado.
makeCopy(name, destination)FileCrea una copia del archivo en el directorio de destino y le asigna el nombre proporcionado.
moveTo(destination)FileMueve este elemento a la carpeta de destino proporcionada.
removeCommenter(emailAddress)FileQuita al usuario determinado de la lista de comentaristas del File.
removeCommenter(user)FileQuita al usuario determinado de la lista de comentaristas del File.
removeEditor(emailAddress)FileQuita al usuario determinado de la lista de editores del File.
removeEditor(user)FileQuita al usuario determinado de la lista de editores del File.
removeViewer(emailAddress)FileQuita al usuario determinado de la lista de lectores y comentaristas del File.
removeViewer(user)FileQuita al usuario determinado de la lista de lectores y comentaristas del File.
revokePermissions(emailAddress)FileRevoca el acceso al File otorgado al usuario determinado.
revokePermissions(user)FileRevoca el acceso al File otorgado al usuario determinado.
setContent(content)FileReemplaza el contenido del archivo por un reemplazo determinado.
setDescription(description)FileEstablece la descripción de File.
setName(name)FileEstablece el nombre de File.
setOwner(emailAddress)FileCambia el propietario de File.
setOwner(user)FileCambia el propietario de File.
setSecurityUpdateEnabled(enabled)FileEstablece si File requiere una clave de recurso para acceder cuando se comparte mediante un vínculo.
setShareableByEditors(shareable)FileEstablece si los usuarios con permisos de edición para File pueden compartir contenido con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FileConfigura qué clase de usuarios pueden acceder a File y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso de manera explícita.
setStarred(starred)FileEstablece si el elemento File se destacará en la unidad de Drive del usuario.
setTrashed(trashed)FileEstablece si el File está en la papelera de la unidad de Drive del usuario.

Documentación detallada

addCommenter(emailAddress)

Agrega el usuario determinado a la lista de comentaristas de File. Si el usuario ya estaba en la lista de usuarios, este método quita al usuario de la lista.

// 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));
}

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se agregará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addCommenter(user)

Agrega el usuario determinado a la lista de comentaristas de File. Si el usuario ya estaba en la lista de usuarios, este método quita al usuario de la lista.

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

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se agregará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addCommenters(emailAddresses)

Agrega el array de usuarios determinado a la lista de comentaristas de File. Si alguno de los usuarios ya estaba en la lista de usuarios, este método lo quita de la lista de usuarios.

// 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));
}

Parámetros

NombreTipoDescripción
emailAddressesString[]Un array de direcciones de correo electrónico de los usuarios que se agregarán.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addEditor(emailAddress)

Agrega el usuario determinado a la lista de editores del File. Si el usuario ya estaba en la lista de usuarios, este método quita al usuario de la lista.

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se agregará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addEditor(user)

Agrega el usuario determinado a la lista de editores del File. Si el usuario ya estaba en la lista de usuarios, este método quita al usuario de la lista.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se agregará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addEditors(emailAddresses)

Agrega el array de usuarios determinado a la lista de editores del File. Si alguno de los usuarios ya estaba en la lista de usuarios, este método lo quita de la lista de usuarios.

Parámetros

NombreTipoDescripción
emailAddressesString[]Un array de direcciones de correo electrónico de los usuarios que se agregarán.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addViewer(emailAddress)

Agrega el usuario determinado a la lista de visualizadores de File. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se agregará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addViewer(user)

Agrega el usuario determinado a la lista de visualizadores de File. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se agregará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

addViewers(emailAddresses)

Agrega el array de usuarios determinado a la lista de visualizadores de File. Si alguno de los usuarios ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

NombreTipoDescripción
emailAddressesString[]Un array de direcciones de correo electrónico de los usuarios que se agregarán.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getAccess(email)

Obtiene el permiso otorgado al usuario determinado.

Parámetros

NombreTipoDescripción
emailStringla dirección de correo electrónico del usuario cuyos permisos deben verificarse

Devolvedor

Permission: Son los permisos otorgados al usuario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getAccess(user)

Obtiene el permiso otorgado al usuario determinado.

Parámetros

NombreTipoDescripción
userUseruna representación del usuario cuyos permisos deben verificarse

Devolvedor

Permission: Son los permisos otorgados al usuario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getAs(contentType)

Muestra los datos dentro de este objeto como un BLOB convertido al tipo de contenido especificado. Este método agrega la extensión adecuada al nombre de archivo, por ejemplo, “myfile.pdf”. Sin embargo, se supone que la parte del nombre de archivo que sigue al último punto (si existe) es una extensión existente que se debe reemplazar. En consecuencia, “ShoppingList.12.25.2014” se convierte en “ShoppingList.12.25.pdf”.

Para ver las cuotas diarias de las conversiones, consulta Cuotas de los servicios de Google. Los dominios de Google Workspace creados recientemente pueden estar sujetos a cuotas más estrictas de forma temporal.

Parámetros

NombreTipoDescripción
contentTypeStringEl tipo de MIME al que se realizará la conversión. Para la mayoría de los BLOB, 'application/pdf' es la única opción válida. En el caso de las imágenes en formato BMP, GIF, JPEG o PNG, también es válido cualquiera de los valores 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'.

Devolvedor

Blob: Son los datos como un BLOB.


getBlob()

Muestra los datos dentro de este objeto como un BLOB.

Devolvedor

Blob: Son los datos como un BLOB.


getDateCreated()

Obtiene la fecha en que se creó el File.

Devolvedor

Date: Es la fecha en que se creó el File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getDescription()

Obtiene la descripción de File.

Devolvedor

String: Es la descripción de File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getDownloadUrl()

Obtiene la URL que se puede usar para descargar el archivo. Solo los usuarios con permiso para abrir el archivo en Google Drive pueden acceder a la URL. Puedes usar esta URL en un navegador para descargar el archivo, pero no puedes hacerlo con UrlFetchApp. Si quieres ver el contenido del archivo en la secuencia de comandos, usa 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());
}

Devolvedor

String: Es la URL que se puede usar para descargar el archivo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getEditors()

Obtiene la lista de editores para este File. Si el usuario que ejecuta la secuencia de comandos no tiene acceso de edición a File, este método muestra un array vacío.

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

Devolvedor

User[]: Si el usuario tiene acceso de edición para este File, muestra la lista de editores. Si el usuario no tiene acceso de edición, muestra un array vacío.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getId()

Obtiene el ID de File.

Devolvedor

String: Es el ID de File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getLastUpdated()

Obtiene la fecha en que se actualizó el File por última vez.

Devolvedor

Date: Es la fecha en que se actualizó el File por última vez.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getMimeType()

Obtiene el tipo de MIME del archivo.

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

Devolvedor

String: Es el tipo de MIME del archivo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getName()

Obtiene el nombre de File.

Devolvedor

String: Es el nombre de File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getOwner()

Obtiene el propietario del archivo.

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

Devolvedor

User: Es el propietario del archivo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getParents()

Obtiene una colección de carpetas que son superiores inmediatos de File.

Devolvedor

FolderIterator: Es una colección de carpetas que son elementos superiores inmediatos de File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getResourceKey()

Obtiene la clave de recurso del File que se requiere para acceder a los elementos que se compartieron a través de un vínculo.

Devolvedor

String: Es la clave del recurso de File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getSecurityUpdateEligible()

Obtiene si este File es apto para aplicar la actualización de seguridad que requiere una clave de recurso para acceder cuando se comparte mediante un vínculo.

Drive necesita una clave de recurso para acceder a algunos archivos o carpetas que se compartieron a través de un vínculo. Este cambio forma parte de una actualización de seguridad. La actualización está activada de forma predeterminada para los archivos y las carpetas aptos. Si quieres activar o desactivar el requisito de clave de recurso para los archivos aptos, usa setSecurityUpdateEnabled.

Obtén más información sobre la Actualización de seguridad de Google Drive.

Devolvedor

Boolean: Indica si el requisito de clave de recurso se puede aplicar a File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getSecurityUpdateEnabled()

Obtiene si este File requiere una clave de recurso para acceder cuando se comparte mediante un vínculo. Este requisito está activado de forma predeterminada para los archivos y las carpetas aptos. Para activar o desactivar el requisito de clave de recurso en los archivos aptos, usa setSecurityUpdateEnabled.

Obtén más información sobre la Actualización de seguridad de Google Drive.

Devolvedor

Boolean: Indica si el requisito de clave de recurso está habilitado para este File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getSharingAccess()

Obtiene qué clase de usuarios puede acceder a File, además de los usuarios individuales a los que se les otorgó acceso de forma explícita.

Devolvedor

Access: Indica qué clase de usuarios puede acceder a File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getSharingPermission()

Obtiene el permiso otorgado a aquellos usuarios que pueden acceder a File, además de los usuarios individuales a los que se les otorgó acceso de manera explícita.

Devolvedor

Permission: Son los permisos otorgados a los usuarios que pueden acceder a File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getSize()

Obtiene la cantidad de bytes que se usan para almacenar el File en Drive. Ten en cuenta que los archivos de la aplicación de Google Workspace no se consideran en los límites de almacenamiento en Drive y, por lo tanto, muestran 0 bytes.

Devolvedor

Integer: Es la cantidad de bytes que se usan para almacenar el File en Drive.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getTargetId()

Si se trata de una combinación de teclas, muestra el ID del elemento al que apunta.

De lo contrario, muestra 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()}`);

Devolvedor

String: Es el ID del artículo de destino.


getTargetMimeType()

Si se trata de un atajo, muestra el tipo de MIME del elemento al que apunta.

De lo contrario, muestra 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()}`);

Devolvedor

String: Es el tipo de MIME del elemento de destino.


getTargetResourceKey()

Si el archivo es un acceso directo, muestra la clave de recurso del elemento al que apunta. Una clave de recurso es un parámetro adicional que debes pasar para acceder a los archivos que se compartieron mediante un vínculo.

Si el archivo no es un acceso directo, muestra 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());

Devolvedor

String: Es la clave de recurso del elemento de destino o null si el archivo no es un acceso directo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getThumbnail()

Obtiene una imagen en miniatura para el archivo o null si no existe una miniatura.

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

Devolvedor

Blob: Es la imagen en miniatura del archivo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getUrl()

Obtiene la URL que se puede usar para abrir el archivo File en una app de Google, como Drive o Documentos.

Devolvedor

String: Es la URL que se puede usar para ver este File en una app de Google, como Drive o Documentos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getViewers()

Obtiene la lista de lectores y comentaristas de este File. Si el usuario que ejecuta la secuencia de comandos no tiene acceso de edición a File, este método muestra un arreglo vacío.

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

Devolvedor

User[]: Si el usuario tiene acceso de edición para este File, muestra la lista de lectores y comentaristas. Si el usuario no tiene acceso de edición, muestra un array vacío.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

isShareableByEditors()

Determina si los usuarios con permisos de edición para File pueden compartir contenido con otros usuarios o cambiar los permisos.

Devolvedor

Boolean: Es true si los usuarios con permisos de edición pueden compartir contenido con otros usuarios o cambiar los permisos; false si no lo hacen.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

isStarred()

Determina si el elemento File se destacó en la unidad de Drive del usuario.

Devolvedor

Boolean: true si File está destacado en la unidad de Drive del usuario; false si no es así

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

isTrashed()

Determina si el elemento File está en la papelera de la unidad de Drive del usuario.

Devolvedor

Boolean: true si File está en la papelera de la unidad de Drive del usuario; false si no es así

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

makeCopy()

Crea una copia del archivo.

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

Devolvedor

File: Es la nueva copia.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

makeCopy(destination)

Crea una copia del archivo en el directorio de destino.

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

Parámetros

NombreTipoDescripción
destinationFolderEl directorio en el que se copiará el archivo.

Devolvedor

File: Es la nueva copia.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

makeCopy(name)

Crea una copia del archivo y le asigna el nombre proporcionado.

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

Parámetros

NombreTipoDescripción
nameStringEs el nombre de archivo que se debe aplicar a la copia nueva.

Devolvedor

File: Es la nueva copia.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

makeCopy(name, destination)

Crea una copia del archivo en el directorio de destino y le asigna el nombre proporcionado.

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

Parámetros

NombreTipoDescripción
nameStringEs el nombre de archivo que se debe aplicar a la copia nueva.
destinationFolderEl directorio en el que se copiará el archivo.

Devolvedor

File: Es la nueva copia.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

moveTo(destination)

Mueve este elemento a la carpeta de destino proporcionada.

El usuario actual debe ser el propietario del archivo o tener, al menos, acceso de edición a la carpeta superior actual del elemento para poder moverlo a la carpeta de destino.

Parámetros

NombreTipoDescripción
destinationFolderLa carpeta que se convierte en el nuevo superior.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

removeCommenter(emailAddress)

Quita al usuario determinado de la lista de comentaristas del File. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general (por ejemplo, si File se comparte con todo el dominio del usuario).

// 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');
}

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se quitará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

removeCommenter(user)

Quita al usuario determinado de la lista de comentaristas del File. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general (por ejemplo, si File se comparte con todo el dominio del usuario).

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

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se quitará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

removeEditor(emailAddress)

Quita al usuario determinado de la lista de editores del File. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si File se comparte con todo el dominio del usuario o si File está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, esta acción también quita al usuario de la lista de lectores.

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se quitará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

removeEditor(user)

Quita al usuario determinado de la lista de editores del File. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si File se comparte con todo el dominio del usuario o si File está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, esta acción también quita al usuario de la lista de lectores.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se quitará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

removeViewer(emailAddress)

Quita al usuario determinado de la lista de lectores y comentaristas del File. Este método no tiene efecto si el usuario es editor, no lector ni comentarista. Este método tampoco impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general (por ejemplo, si File se comparte con todo el dominio del usuario o si File está en una unidad compartida a la que el usuario puede acceder).

En el caso de los archivos de Drive, esta acción también quita al usuario de la lista de editores.

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que se quitará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

removeViewer(user)

Quita al usuario determinado de la lista de lectores y comentaristas del File. Este método no tiene efecto si el usuario es editor, no lector. Este método tampoco impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general (por ejemplo, si File se comparte con todo el dominio del usuario o si el File está en una unidad compartida a la que el usuario puede acceder).

En el caso de los archivos de Drive, esta acción también quita al usuario de la lista de editores.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se quitará.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

revokePermissions(emailAddress)

Revoca el acceso al File otorgado al usuario determinado. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general (por ejemplo, si File se comparte con todo el dominio del usuario).

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario cuyo acceso se debe revocar.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

revokePermissions(user)

Revoca el acceso al File otorgado al usuario determinado. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general (por ejemplo, si File se comparte con todo el dominio del usuario).

Parámetros

NombreTipoDescripción
userUserRepresentación del usuario cuyo acceso se debe revocar.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setContent(content)

Reemplaza el contenido del archivo por un reemplazo determinado. Arroja una excepción si content supera los 10 MB.

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

Parámetros

NombreTipoDescripción
contentStringEs el nuevo contenido del archivo.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setDescription(description)

Establece la descripción de File.

Parámetros

NombreTipoDescripción
descriptionStringla nueva descripción de File

Devolvedor

File: Este File, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setName(name)

Establece el nombre de File.

Parámetros

NombreTipoDescripción
nameStringel nombre nuevo de File

Devolvedor

File: Este File, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setOwner(emailAddress)

Cambia el propietario de File. Este método también le otorga al propietario anterior acceso de edición explícito a File.

Parámetros

NombreTipoDescripción
emailAddressStringla dirección de correo electrónico del usuario que debe convertirse en el nuevo propietario

Devolvedor

File: Este File, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setOwner(user)

Cambia el propietario de File. Este método también le otorga al propietario anterior acceso de edición explícito a File.

Parámetros

NombreTipoDescripción
userUseruna representación del usuario que debe convertirse en el nuevo propietario

Devolvedor

File: Este File, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setSecurityUpdateEnabled(enabled)

Establece si File requiere una clave de recurso para acceder cuando se comparte mediante un vínculo. Los archivos y las carpetas aptos están habilitados de forma predeterminada.

Obtén más información sobre la Actualización de seguridad de Google Drive.

Parámetros

NombreTipoDescripción
enabledBooleanSi se habilita el requisito de clave de recurso para File.

Devolvedor

File: Es este File para encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setShareableByEditors(shareable)

Establece si los usuarios con permisos de edición para File pueden compartir contenido con otros usuarios o cambiar los permisos. El valor predeterminado para una File nueva es true.

Parámetros

NombreTipoDescripción
shareableBooleantrue si los usuarios con permisos de edición deben tener permiso para compartir contenido con otros usuarios o cambiar los permisos; false si no lo hacen

Devolvedor

File: Este File, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setSharing(accessType, permissionType)

Configura qué clase de usuarios pueden acceder a File y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso de manera explícita.

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

Parámetros

NombreTipoDescripción
accessTypeAccessqué clase de usuarios debería poder acceder al File
permissionTypePermissionlos permisos que se deben otorgar a los usuarios que puedan acceder a File

Devolvedor

File: Este File, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setStarred(starred)

Establece si el elemento File se destacará en la unidad de Drive del usuario. El valor predeterminado para los objetos File nuevos es false.

Parámetros

NombreTipoDescripción
starredBooleantrue si se debe destacar File en la unidad de Drive del usuario; false si no es así

Devolvedor

File: Este File, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setTrashed(trashed)

Establece si el File está en la papelera de la unidad de Drive del usuario. Solo el propietario puede enviar el File a la papelera. El valor predeterminado de los elementos File nuevos es false.

Parámetros

NombreTipoDescripción
trashedBooleantrue si el File debe moverse a la papelera de la unidad de Drive del usuario; false si no es así

Devolvedor

File: Este File, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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