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.
const files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  const 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 al usuario especificado a la lista de comentaristas de File.
addCommenter(user)FileAgrega al 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 especificado a la lista de editores de File.
addEditor(user)FileAgrega el usuario especificado a la lista de editores de File.
addEditors(emailAddresses)FileAgrega el array de usuarios determinado a la lista de editores de File.
addViewer(emailAddress)FileAgrega al usuario determinado a la lista de usuarios de File.
addViewer(user)FileAgrega al usuario determinado a la lista de usuarios de File.
addViewers(emailAddresses)FileAgrega el array de usuarios determinado a la lista de usuarios de File.
getAccess(email)PermissionObtiene el permiso otorgado a un usuario específico.
getAccess(user)PermissionObtiene el permiso otorgado a un usuario específico.
getAs(contentType)BlobMuestra los datos dentro de este objeto como un blob convertido al tipo de contenido especificado.
getBlob()BlobDevuelve los datos dentro de este objeto como un blob.
getDateCreated()DateObtiene la fecha en la 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 de este File.
getId()StringObtiene el ID del File.
getLastUpdated()DateObtiene la fecha en que se actualizó File por última vez.
getMimeType()StringObtiene el tipo 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 inmediatas de File.
getResourceKey()StringObtiene la clave de recurso del File que se requiere para acceder a los elementos que se compartieron con un vínculo.
getSecurityUpdateEligible()BooleanObtiene si este File es apto para aplicar la actualización de seguridad que requiere una clave de recurso para el acceso cuando se comparte con un vínculo.
getSecurityUpdateEnabled()BooleanObtiene si este File requiere una clave de recurso para el acceso cuando se comparte con 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 los usuarios que pueden acceder a File, además de los usuarios individuales a los que se les otorgó acceso de forma explícita.
getSize()IntegerObtiene la cantidad de bytes que se usan para almacenar el File en Drive.
getTargetId()StringSi se trata de un atajo, muestra el ID del elemento al que apunta.
getTargetMimeType()StringSi se trata de un atajo, muestra el tipo mime del elemento al que apunta.
getTargetResourceKey()StringSi el archivo es un atajo, muestra la clave de recurso del elemento al que apunta.
getThumbnail()BlobObtiene una imagen en miniatura del archivo o null si no existe una miniatura.
getUrl()StringObtiene la URL que se puede usar para abrir el File en una app de Google, como Drive o Documentos.
getViewers()User[]Obtiene la lista de usuarios y comentaristas de este File.
isShareableByEditors()BooleanDetermina si los usuarios con permisos de edición en File pueden compartir con otros usuarios o cambiar los permisos.
isStarred()BooleanDetermina si el File se marcó como favorito en Drive del usuario.
isTrashed()BooleanDetermina si el File está en la papelera 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 asígnale 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 de File.
removeCommenter(user)FileQuita al usuario determinado de la lista de comentaristas de File.
removeEditor(emailAddress)FileQuita al usuario determinado de la lista de editores de File.
removeEditor(user)FileQuita al usuario determinado de la lista de editores de File.
removeViewer(emailAddress)FileQuita al usuario determinado de la lista de usuarios y comentaristas de File.
removeViewer(user)FileQuita al usuario determinado de la lista de usuarios y comentaristas de File.
revokePermissions(emailAddress)FileRevoca el acceso a File otorgado al usuario determinado.
revokePermissions(user)FileRevoca el acceso a 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 del 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 el acceso cuando se comparte con un vínculo.
setShareableByEditors(shareable)FileEstablece si los usuarios con permisos de edición en File pueden compartir con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FileEstablece qué clase de usuarios puede acceder a File y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso de forma explícita.
setStarred(starred)FileEstablece si la File se marcará como favorita en Drive del usuario.
setTrashed(trashed)FileEstablece si el File está en la papelera de Drive del usuario.

Documentación detallada

addCommenter(emailAddress)

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

const files = DriveApp.getFilesByName('Test');

// Loops through the files
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter('hello@example.com');
}

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que quieres agregar.

Volver

File: Este File, para encadenar.

Autorización

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

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

addCommenter(user)

Agrega al usuario especificado a la lista de comentaristas de File. Si el usuario ya estaba en la lista de usuarios, este método lo quita 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á.

Volver

File: Este File, para encadenar.

Autorización

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

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

// 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[]Es un array de direcciones de correo electrónico de los usuarios que se agregarán.

Volver

File: Este File, para encadenar.

Autorización

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

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

addEditor(emailAddress)

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

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que quieres agregar.

Volver

File: Este File, para encadenar.

Autorización

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

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

addEditor(user)

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

Parámetros

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

Volver

File: Este File, para encadenar.

Autorización

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

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

addEditors(emailAddresses)

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

Parámetros

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

Volver

File: Este File, para encadenar.

Autorización

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

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

addViewer(emailAddress)

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

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que quieres agregar.

Volver

File: Este File, para encadenar.

Autorización

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

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

addViewer(user)

Agrega al usuario determinado a la lista de usuarios 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á.

Volver

File: Este File, para encadenar.

Autorización

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

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

addViewers(emailAddresses)

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

Parámetros

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

Volver

File: Este File, para encadenar.

Autorización

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

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

getAccess(email)

Obtiene el permiso otorgado a un usuario específico. El método no admite mostrar permisos para un Grupo de Google ni permisos heredados a través de Grupos de Google.

Parámetros

NombreTipoDescripción
emailStringLa dirección de correo electrónico del usuario cuyos permisos se deben verificar. No se admiten los Grupos de Google.

Volver

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 ámbitos:

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

getAccess(user)

Obtiene el permiso otorgado a un usuario específico. El método no admite mostrar permisos para un Grupo de Google ni permisos heredados a través de Grupos de Google.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario cuyos permisos se deben verificar.

Volver

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 ámbitos:

  • 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 del archivo, por ejemplo, "miarchivo.pdf". Sin embargo, se da por sentado que la parte del nombre de archivo que sigue al último punto (si corresponde) es una extensión existente que se debe reemplazar. Por lo tanto, "ShoppingList.12.25.2014" se convierte en "ShoppingList.12.25.pdf".

Para ver las cuotas diarias de conversiones, consulta Cuotas de los servicios de Google. Es posible que los dominios de Google Workspace recién creados estén sujetos temporalmente a cuotas más estrictas.

Parámetros

NombreTipoDescripción
contentTypeStringEs el tipo de MIME al que se debe realizar la conversión. Para la mayoría de los blobs, 'application/pdf' es la única opción válida. Para las imágenes en formato BMP, GIF, JPEG o PNG, también son válidos 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'. Para un documento de Documentos de Google, 'text/markdown' también es válido.

Volver

Blob: Los datos como un BLOB.


getBlob()

Devuelve los datos dentro de este objeto como un blob.

Volver

Blob: Los datos como un BLOB.


getDateCreated()

Obtiene la fecha en la que se creó el File.

Volver

Date: Es la fecha en la 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 ámbitos:

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

getDescription()

Obtiene la descripción de File.

Volver

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 ámbitos:

  • 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 que tengan 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 usarla para recuperar el archivo con UrlFetchApp. Si quieres que el contenido del archivo esté 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());
}

Volver

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 ámbitos:

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

getEditors()

Obtiene la lista de editores 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 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());
  }
}

Volver

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 ámbitos:

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

getId()

Obtiene el ID del File.

Volver

String: Es el ID del File.

Autorización

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

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

getLastUpdated()

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

Volver

Date: Es la fecha en la que se actualizó 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 ámbitos:

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

getMimeType()

Obtiene el tipo 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());
}

Volver

String: Es el tipo 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 ámbitos:

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

getName()

Obtiene el nombre de File.

Volver

String: Es el nombre del File.

Autorización

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

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

Volver

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 ámbitos:

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

getParents()

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

Volver

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

Autorización

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

  • 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 con un vínculo.

Volver

String: Es la clave de recursos de File.

Autorización

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

  • 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 el acceso cuando se comparte con un vínculo.

Drive requiere una clave de recurso para acceder a algunos archivos o carpetas que se compartieron con un vínculo. Este cambio forma parte de una actualización de seguridad. La actualización se activa de forma predeterminada para los archivos y las carpetas aptos. Para activar o desactivar el requisito de clave de recursos para los archivos aptos, usa setSecurityUpdateEnabled.

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

Volver

Boolean: Indica si se puede aplicar el requisito de clave de recursos para File.

Autorización

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

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

getSecurityUpdateEnabled()

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

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

Volver

Boolean: Indica si el requisito de clave de recursos 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 ámbitos:

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

Volver

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 ámbitos:

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

getSharingPermission()

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

Volver

Permission: 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 ámbitos:

  • 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 tienen en cuenta en los límites de almacenamiento de Drive y, por lo tanto, muestran 0 bytes.

Volver

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 ámbitos:

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

getTargetId()

Si se trata de un atajo, 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()}`);

Volver

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

Volver

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


getTargetResourceKey()

Si el archivo es un atajo, 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 con un vínculo.

Si el archivo no es un atajo, se 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());

Volver

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

Autorización

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

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

getThumbnail()

Obtiene una imagen en miniatura del 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());
}

Volver

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 ámbitos:

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

getUrl()

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

Volver

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 ámbitos:

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

getViewers()

Obtiene la lista de usuarios 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 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();

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

Volver

User[]: Si el usuario tiene acceso de edición para este File, muestra la lista de usuarios 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 ámbitos:

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

isShareableByEditors()

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

Volver

Boolean: true si los usuarios con permisos de edición pueden compartir con otros usuarios o cambiar los permisos; false de lo contrario

Autorización

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

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

isStarred()

Determina si el File se marcó como favorito en Drive del usuario.

Volver

Boolean: true si el File está destacado en Drive del usuario; false si no

Autorización

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

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

isTrashed()

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

Volver

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

Autorización

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

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

Volver

File: Es la copia nueva.

Autorización

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

  • 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
destinationFolderEs el directorio en el que se copiará el archivo.

Volver

File: Es la copia nueva.

Autorización

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

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

makeCopy(name)

Crea una copia del archivo y asígnale 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.

Volver

File: Es la copia nueva.

Autorización

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

  • 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.
destinationFolderEs el directorio en el que se copiará el archivo.

Volver

File: Es la copia nueva.

Autorización

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

  • 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 moverlo a la carpeta de destino.

Parámetros

NombreTipoDescripción
destinationFolderEs la carpeta que se convierte en la nueva carpeta superior.

Volver

File: Este File, para encadenar.

Autorización

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

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

removeCommenter(emailAddress)

Quita al usuario determinado de la lista de comentaristas de File. Este método no bloquea el acceso de los usuarios a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el 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 quieres quitar.

Volver

File: Este File, para encadenar.

Autorización

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

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

removeCommenter(user)

Quita al usuario determinado de la lista de comentaristas de File. Este método no bloquea el acceso de los usuarios a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el 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á.

Volver

File: Este File, para encadenar.

Autorización

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

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

removeEditor(emailAddress)

Quita al usuario determinado de la lista de editores de 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 se encuentra en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de usuarios con permiso de lectura.

Parámetros

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

Volver

File: Este File, para encadenar.

Autorización

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

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

removeEditor(user)

Quita al usuario determinado de la lista de editores de 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 se encuentra en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de usuarios con permiso de lectura.

Parámetros

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

Volver

File: Este File, para encadenar.

Autorización

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

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

removeViewer(emailAddress)

Quita al usuario determinado de la lista de usuarios y comentaristas de File. Este método no tiene efecto si el usuario es editor, no un usuario que mira o comenta. Este método tampoco bloquea a los usuarios para que 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, también se quita al usuario de la lista de editores.

Parámetros

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

Volver

File: Este File para el encadenamiento.

Autorización

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

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

removeViewer(user)

Quita al usuario determinado de la lista de usuarios y comentaristas de File. Este método no tiene efecto si el usuario es un editor, no un usuario. 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 se encuentra en una unidad compartida a la que el usuario puede acceder.

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

Parámetros

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

Volver

File: Este File para el encadenamiento.

Autorización

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

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

revokePermissions(emailAddress)

Revoca el acceso a File otorgado al usuario determinado. Este método no bloquea a los usuarios para que 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.

Volver

File: Este File, para encadenar.

Autorización

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

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

revokePermissions(user)

Revoca el acceso a File otorgado al usuario determinado. Este método no bloquea a los usuarios para que 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
userUserEs una representación del usuario cuyo acceso se debe revocar.

Volver

File: Este File, para encadenar.

Autorización

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

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

setContent(content)

Reemplaza el contenido del archivo por un reemplazo determinado. Genera una excepción si content es superior a 10 MB.

// Creates a text file with the content 'Hello, world!'
const 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 contenido nuevo del archivo.

Volver

File: Este File, para encadenar.

Autorización

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

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

setDescription(description)

Establece la descripción de File.

Parámetros

NombreTipoDescripción
descriptionStringla nueva descripción del File

Volver

File: Este File, para encadenar

Autorización

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

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

setName(name)

Establece el nombre del File.

Parámetros

NombreTipoDescripción
nameStringel nombre nuevo de File

Volver

File: Este File, para encadenar

Autorización

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

  • 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

Volver

File: Este File, para encadenar

Autorización

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

  • 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

Volver

File: Este File, para encadenar

Autorización

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

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

setSecurityUpdateEnabled(enabled)

Establece si File requiere una clave de recurso para el acceso cuando se comparte con 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 para Google Drive.

Parámetros

NombreTipoDescripción
enabledBooleanIndica si se debe habilitar el requisito de clave de recursos para File.

Volver

File: Este File, para encadenar.

Autorización

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

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

setShareableByEditors(shareable)

Establece si los usuarios con permisos de edición en File pueden compartir con otros usuarios o cambiar los permisos. El valor predeterminado para un File nuevo es true.

Parámetros

NombreTipoDescripción
shareableBooleantrue si los usuarios con permisos de edición deben poder compartir con otros usuarios o cambiar los permisos; false de lo contrario

Volver

File: Este File, para encadenar

Autorización

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

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

setSharing(accessType, permissionType)

Establece qué clase de usuarios puede acceder a File y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso de forma 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.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parámetros

NombreTipoDescripción
accessTypeAccessqué clase de usuarios debe poder acceder a File
permissionTypePermissionlos permisos que se deben otorgar a los usuarios que pueden acceder a File

Volver

File: Este File, para encadenar

Autorización

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

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

setStarred(starred)

Establece si la File se marcará como favorita en Drive del usuario. El valor predeterminado para los File nuevos es false.

Parámetros

NombreTipoDescripción
starredBooleantrue si el File debe marcarse como favorito en Drive del usuario; false de lo contrario

Volver

File: Este File, para encadenar

Autorización

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

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

setTrashed(trashed)

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

Parámetros

NombreTipoDescripción
trashedBooleantrue si el File se debe mover a la papelera de la unidad del usuario; false de lo contrario

Volver

File: Este File, para encadenar

Autorización

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

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