Class Folder

Carpeta

Es una carpeta en Google Drive. Se puede acceder a las carpetas o crearlas desde DriveApp. 

// Log the name of every folder in the user's Drive.
const folders = DriveApp.getFolders();
while (folders.hasNext()) {
  const folder = folders.next();
  Logger.log(folder.getName());
}

Métodos

MétodoTipo de datos que se devuelveDescripción breve
addEditor(emailAddress)FolderAgrega el usuario especificado a la lista de editores del Folder.
addEditor(user)FolderAgrega el usuario especificado a la lista de editores del Folder.
addEditors(emailAddresses)FolderAgrega el array de usuarios determinado a la lista de editores del Folder.
addViewer(emailAddress)FolderAgrega el usuario determinado a la lista de usuarios que pueden ver el Folder.
addViewer(user)FolderAgrega el usuario determinado a la lista de usuarios que pueden ver el Folder.
addViewers(emailAddresses)FolderAgrega el array de usuarios proporcionado a la lista de usuarios que pueden ver el Folder.
createFile(blob)FileCrea un archivo en la carpeta actual a partir de un Blob determinado de datos arbitrarios.
createFile(name, content)FileCrea un archivo de texto en la carpeta actual con el nombre y el contenido especificados.
createFile(name, content, mimeType)FileCrea un archivo en la carpeta actual con el nombre, el contenido y el tipo de MIME especificados.
createFolder(name)FolderCrea una carpeta en la carpeta actual con el nombre indicado.
createShortcut(targetId)FileCrea un acceso directo al ID del elemento de Drive proporcionado y lo devuelve.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrea un acceso directo al ID del elemento de Drive y a la clave de recurso proporcionados, y lo devuelve.
getAccess(email)PermissionObtiene el permiso otorgado a un usuario específico.
getAccess(user)PermissionObtiene el permiso otorgado a un usuario específico.
getDateCreated()DateObtiene la fecha en que se creó el objeto Folder.
getDescription()StringObtiene la descripción del Folder.
getEditors()User[]Obtiene la lista de editores de este Folder.
getFiles()FileIteratorObtiene una colección de todos los archivos que son secundarios de la carpeta actual.
getFilesByName(name)FileIteratorObtiene una colección de todos los archivos que son elementos secundarios de la carpeta actual y tienen el nombre determinado.
getFilesByType(mimeType)FileIteratorObtiene una colección de todos los archivos que son elementos secundarios de la carpeta actual y tienen el tipo de MIME determinado.
getFolders()FolderIteratorObtiene una colección de todas las carpetas secundarias de la carpeta actual.
getFoldersByName(name)FolderIteratorObtiene una colección de todas las carpetas secundarias de la carpeta actual que tienen el nombre especificado.
getId()StringObtiene el ID del Folder.
getLastUpdated()DateObtiene la fecha en que se actualizó por última vez el objeto Folder.
getName()StringObtiene el nombre del Folder.
getOwner()UserObtiene el propietario de este Folder.
getParents()FolderIteratorObtiene una colección de carpetas que son superiores inmediatos del Folder.
getResourceKey()StringObtiene la clave de recurso del Folder que se requiere para acceder a los elementos que se compartieron con un vínculo.
getSecurityUpdateEligible()BooleanObtiene si este Folder es apto para aplicar la actualización de seguridad que requiere una clave de recurso para acceder cuando se comparte con un vínculo.
getSecurityUpdateEnabled()BooleanIndica si este Folder requiere una clave de recurso para acceder a él cuando se comparte a través de un vínculo.
getSharingAccess()AccessObtiene la clase de usuarios que pueden acceder al Folder, además de los usuarios individuales a los que se les otorgó acceso explícitamente.
getSharingPermission()PermissionObtiene el permiso otorgado a los usuarios que pueden acceder a Folder, 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 objeto Folder en Drive.
getUrl()StringObtiene la URL que se puede usar para abrir el objeto Folder en una app de Google, como Drive o Documentos.
getViewers()User[]Obtiene la lista de lectores y comentaristas de este Folder.
isShareableByEditors()BooleanDetermina si los usuarios con permisos de edición para el Folder pueden compartirlo con otros usuarios o cambiar los permisos.
isStarred()BooleanDetermina si el Folder se marcó como destacado en el Drive del usuario.
isTrashed()BooleanDetermina si el elemento Folder está en la papelera de la unidad del usuario.
moveTo(destination)FolderMueve este elemento a la carpeta de destino proporcionada.
removeEditor(emailAddress)FolderQuita al usuario especificado de la lista de editores del Folder.
removeEditor(user)FolderQuita al usuario especificado de la lista de editores del Folder.
removeViewer(emailAddress)FolderQuita al usuario determinado de la lista de usuarios que pueden ver y comentar el Folder.
removeViewer(user)FolderQuita al usuario determinado de la lista de usuarios que pueden ver y comentar el Folder.
revokePermissions(emailAddress)FolderRevoca el acceso a Folder que se otorgó al usuario especificado.
revokePermissions(user)FolderRevoca el acceso a Folder que se otorgó al usuario especificado.
searchFiles(params)FileIteratorObtiene una colección de todos los archivos que son elementos secundarios de la carpeta actual y que coinciden con los criterios de búsqueda proporcionados.
searchFolders(params)FolderIteratorObtiene una colección de todas las carpetas secundarias de la carpeta actual que coinciden con los criterios de búsqueda proporcionados.
setDescription(description)FolderEstablece la descripción del Folder.
setName(name)FolderEstablece el nombre del Folder.
setOwner(emailAddress)FolderCambia el propietario de Folder.
setOwner(user)FolderCambia el propietario de Folder.
setSecurityUpdateEnabled(enabled)FolderEstablece si Folder requiere una clave de recurso para acceder cuando se comparte a través de un vínculo.
setShareableByEditors(shareable)FolderEstablece si los usuarios con permisos de edición para el Folder pueden compartirlo con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FolderEstablece qué clase de usuarios puede acceder a Folder 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)FolderEstablece si el Folder se destaca en la unidad del usuario.
setTrashed(trashed)FolderEstablece si el elemento Folder está en la papelera de la unidad del usuario.

Documentación detallada

addEditor(emailAddress)

Agrega el usuario especificado a la lista de editores del Folder. Si el usuario ya estaba en la lista de usuarios, este método lo promueve fuera de ella.

Parámetros

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

Volver

Folder: Es este Folder, 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 alcances:

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

addEditor(user)

Agrega el usuario especificado a la lista de editores del Folder. Si el usuario ya estaba en la lista de usuarios, este método lo promueve fuera de ella.

Parámetros

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

Volver

Folder: Es este Folder, 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 alcances:

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

addEditors(emailAddresses)

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

Parámetros

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

Volver

Folder: Es este Folder, 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 alcances:

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

addViewer(emailAddress)

Agrega el usuario determinado a la lista de usuarios que pueden ver el Folder. 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á.

Volver

Folder: Es este Folder, 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 alcances:

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

addViewer(user)

Agrega el usuario determinado a la lista de usuarios que pueden ver el Folder. 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

Folder: Es este Folder, 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 alcances:

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

addViewers(emailAddresses)

Agrega el array de usuarios proporcionado a la lista de usuarios que pueden ver el Folder. Si alguno de los usuarios ya estaba en la lista de editores, este método no tendrá efecto en ellos.

Parámetros

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

Volver

Folder: Es este Folder, 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 alcances:

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

createFile(blob)

Crea un archivo en la carpeta actual a partir de un Blob determinado de datos arbitrarios.

Parámetros

NombreTipoDescripción
blobBlobSourceSon los datos del archivo nuevo.

Volver

File: Es el archivo nuevo.

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

createFile(name, content)

Crea un archivo de texto en la carpeta actual con el nombre y el contenido especificados. Arroja una excepción si content es mayor que 50 MB. 

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

Parámetros

NombreTipoDescripción
nameStringNombre del archivo nuevo.
contentStringEs el contenido del archivo nuevo.

Volver

File: Es el archivo nuevo.

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

createFile(name, content, mimeType)

Crea un archivo en la carpeta actual con el nombre, el contenido y el tipo de MIME especificados. Se arroja una excepción si content es mayor que 10 MB. 

// Create an HTML file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

Parámetros

NombreTipoDescripción
nameStringNombre del archivo nuevo.
contentStringEs el contenido del archivo nuevo.
mimeTypeStringTipo MIME del archivo nuevo.

Volver

File: Es el archivo nuevo.

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

createFolder(name)

Crea una carpeta en la carpeta actual con el nombre indicado.

Parámetros

NombreTipoDescripción
nameStringEs el nombre de la carpeta nueva.

Volver

Folder: Es la carpeta nueva.

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

createShortcut(targetId)

Crea un acceso directo al ID del elemento de Drive proporcionado y lo devuelve.

Parámetros

NombreTipoDescripción
targetIdStringEs el ID del archivo o la carpeta de destino.

Volver

File: Es el nuevo 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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Crea un acceso directo al ID del elemento de Drive y a la clave de recurso proporcionados, y lo devuelve. Una clave de recurso es un parámetro adicional que se debe pasar para acceder al archivo o la carpeta de destino que se compartió con un vínculo. 

// Creates shortcuts for all folders in the user's drive that have a specific
// name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your
// drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and
  // returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(
      folder.getId(),
      folder.getResourceKey(),
  );
}

Parámetros

NombreTipoDescripción
targetIdStringID del archivo o la carpeta de destino
targetResourceKeyStringEs la clave de recurso del archivo o la carpeta de destino.

Volver

File: Es el nuevo 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

getAccess(email)

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

Parámetros

NombreTipoDescripción
emailStringEs la 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 que se otorgan 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 a un usuario específico. El método no admite la devolución de permisos para un Grupo de Google ni los 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 que se otorgan 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

getDateCreated()

Obtiene la fecha en que se creó el objeto Folder.

Volver

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

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 del Folder.

Volver

String: Es la descripción de Folder.

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 de este Folder. Si el usuario que ejecuta la secuencia de comandos no tiene acceso de edición a Folder, este método devuelve un array vacío. 

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of editors and logs their names to the console.
const editors = folder.getEditors();
for (const editor of editors) {
  console.log(editor.getName());
}

Volver

User[]: Es la lista de editores de este Folder si el usuario tiene acceso de edición o un array vacío en caso contrario.

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

getFiles()

Obtiene una colección de todos los archivos que son secundarios de la carpeta actual.

Volver

FileIterator: Es una colección de todos los archivos que son secundarios de la carpeta actual.

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

getFilesByName(name)

Obtiene una colección de todos los archivos que son elementos secundarios de la carpeta actual y tienen el nombre determinado.

Parámetros

NombreTipoDescripción
nameStringNombre de los archivos que se buscarán.

Volver

FileIterator: Es una colección de todos los archivos que son elementos secundarios de la carpeta actual y tienen el nombre determinado.

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

getFilesByType(mimeType)

Obtiene una colección de todos los archivos que son elementos secundarios de la carpeta actual y tienen el tipo de MIME determinado.

Parámetros

NombreTipoDescripción
mimeTypeStringTipo MIME de los archivos que se buscarán.

Volver

FileIterator: Es una colección de todos los archivos que son elementos secundarios de la carpeta actual y tienen el tipo de MIME determinado.

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

getFolders()

Obtiene una colección de todas las carpetas secundarias de la carpeta actual.

Volver

FolderIterator: Es una colección de todas las carpetas secundarias de la carpeta actual.

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

getFoldersByName(name)

Obtiene una colección de todas las carpetas secundarias de la carpeta actual que tienen el nombre especificado.

Parámetros

NombreTipoDescripción
nameStringNombre de las carpetas que se buscarán.

Volver

FolderIterator: Es una colección de todas las carpetas que son secundarias de la carpeta actual y tienen el nombre determinado.

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 del Folder.

Volver

String: Es el ID del Folder.

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ó por última vez el objeto Folder.

Volver

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

getName()

Obtiene el nombre del Folder.

Volver

String: El nombre del Folder

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 de este Folder. 

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the owner of the folder and logs the name to the console.
const folderOwner = folder.getOwner();
console.log(folderOwner.getName());

Volver

User: Es el propietario de este Folder.

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 del Folder.

Volver

FolderIterator: Es una colección de carpetas que son las carpetas superiores inmediatas del Folder.

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 Folder que se requiere para acceder a los elementos que se compartieron con un vínculo.

Volver

String: Es la clave del recurso de Folder.

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 Folder es apto para aplicar la actualización de seguridad que requiere una clave de recurso para acceder 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 está activada de forma predeterminada para los archivos y las carpetas aptos. Para 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 para compartir archivos de Google Drive.

Volver

Boolean: Indica si se puede aplicar el requisito de clave de recurso para Folder.

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

Indica si este Folder requiere una clave de recurso para acceder a él cuando se comparte a través de 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 para los archivos aptos, usa setSecurityUpdateEnabled.

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

Volver

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

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 la clase de usuarios que pueden acceder al Folder, además de los usuarios individuales a los que se les otorgó acceso explícitamente.

Volver

Access: Qué clase de usuarios puede acceder a Folder

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 los usuarios que pueden acceder a Folder, además de los usuarios individuales a los que se les otorgó acceso de forma explícita.

Volver

Permission: Son los permisos que se otorgan a los usuarios que pueden acceder a Folder.

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 objeto Folder en Drive. Ten en cuenta que los archivos de aplicaciones de Google Workspace no se incluyen en los límites de almacenamiento de Drive y, por lo tanto, devuelven 0 bytes.

Volver

Integer: Es la cantidad de bytes que se usan para almacenar el objeto Folder 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

getUrl()

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

Volver

String: Es la URL que se puede usar para ver este Folder 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 Folder. Si el usuario que ejecuta la secuencia de comandos no tiene acceso de edición al objeto Folder, este método devuelve un array vacío. 

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (const viewer of viewers) {
  console.log(viewer.getName());
}

Volver

User[]: Es la lista de usuarios que pueden ver y comentar este Folder si el usuario tiene acceso de edición o un array vacío en caso contrario.

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 el Folder pueden compartirlo 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 si no pueden

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 Folder se marcó como destacado en el Drive del usuario.

Volver

Boolean: true si el elemento Folder se destaca 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 Folder está en la papelera de la unidad del usuario.

Volver

Boolean: true si el Folder está en la papelera del 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

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 principal 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

Folder: Este Folder, 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 alcances:

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

removeEditor(emailAddress)

Quita al usuario especificado de la lista de editores del Folder. Este método no impide que los usuarios accedan al Folder si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el Folder se comparte con todo el dominio del usuario o si el Folder 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 visualizadores.

Parámetros

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

Volver

Folder: Es este Folder, 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 alcances:

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

removeEditor(user)

Quita al usuario especificado de la lista de editores del Folder. Este método no impide que los usuarios accedan al Folder si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el Folder se comparte con todo el dominio del usuario o si el Folder 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 visualizadores.

Parámetros

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

Volver

Folder: Es este Folder, 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 alcances:

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

removeViewer(emailAddress)

Quita al usuario determinado de la lista de usuarios que pueden ver y comentar el Folder. Este método no tiene efecto si el usuario es editor, no visor o comentarista. Este método tampoco impide que los usuarios accedan al Folder si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el Folder se comparte con todo el dominio del usuario o si el Folder 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
emailAddressStringEs la dirección de correo electrónico del usuario que se quitará.

Volver

Folder: Es Folder 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 alcances:

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

removeViewer(user)

Quita al usuario determinado de la lista de usuarios que pueden ver y comentar el Folder. Este método no tiene efecto si el usuario es editor y no visor. Este método tampoco impide que los usuarios accedan al Folder si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el Folder se comparte con todo el dominio del usuario o si el Folder 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

Folder: Es Folder 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 alcances:

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

revokePermissions(emailAddress)

Revoca el acceso a Folder que se otorgó al usuario especificado. Este método no impide que los usuarios accedan a Folder si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el Folder se comparte con todo el dominio del usuario.

Parámetros

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

Volver

Folder: Es este Folder, 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 alcances:

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

revokePermissions(user)

Revoca el acceso a Folder que se otorgó al usuario especificado. Este método no impide que los usuarios accedan a Folder si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el Folder se comparte con todo el dominio del usuario.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario cuyo acceso se debe revocar.

Volver

Folder: Es este Folder, 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 alcances:

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

searchFiles(params)

Obtiene una colección de todos los archivos que son elementos secundarios de la carpeta actual y que coinciden con los criterios de búsqueda proporcionados. Los criterios de búsqueda se detallan en la documentación del SDK de Google Drive. Ten en cuenta que el servicio de Drive usa la versión 2 de la API de Drive y algunos campos de consulta difieren de la versión 3. Revisa las diferencias entre los campos de v2 y v3.

El argumento params es una cadena de consulta que puede contener valores de cadena, por lo que debes tener cuidado de escapar las comillas correctamente (por ejemplo, "title contains 'Gulliver\\'s Travels'" o 'title contains "Gulliver\'s Travels"'). 

// Logs the name of every file that are children of the current folder and modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

Parámetros

NombreTipoDescripción
paramsStringSon los criterios de búsqueda, como se detalla en la documentación del SDK de Google Drive.

Volver

FileIterator: Es una colección de todos los archivos que son secundarios de la carpeta actual y que coinciden con los criterios de búsqueda.

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

searchFolders(params)

Obtiene una colección de todas las carpetas secundarias de la carpeta actual que coinciden con los criterios de búsqueda proporcionados. Los criterios de búsqueda se detallan en la documentación del SDK de Google Drive. Ten en cuenta que el servicio de Drive usa la versión 2 de la API de Drive y algunos campos de consulta difieren de la versión 3. Revisa las diferencias entre los campos de v2 y v3.

El argumento params es una cadena de consulta que puede contener valores de cadena, por lo que debes tener cuidado de escapar las comillas correctamente (por ejemplo, "title contains 'Gulliver\\'s Travels'" o 'title contains "Gulliver\'s Travels"'). 

// Logs the name of every folder that are children of the current folder and you own and is starred.
const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

Parámetros

NombreTipoDescripción
paramsStringSon los criterios de búsqueda, como se detalla en la documentación del SDK de Google Drive.

Volver

FolderIterator: Es una colección de todas las carpetas secundarias de la carpeta actual que coinciden con los criterios de búsqueda.

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

setDescription(description)

Establece la descripción del Folder.

Parámetros

NombreTipoDescripción
descriptionStringLa nueva descripción de Folder

Volver

Folder: Este Folder, para encadenar

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 del Folder.

Parámetros

NombreTipoDescripción
nameStringEl nombre nuevo del Folder

Volver

Folder: Este Folder, para encadenar

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 Folder. Este método también otorga al propietario anterior acceso explícito de edición al Folder.

Drive no admite el cambio de propiedad de los elementos que son propiedad de cuentas de gmail.com, pero sí lo admite para las cuentas de Workspace.

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que debería convertirse en el nuevo propietario.

Volver

Folder: Es este Folder, 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 alcances:

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

setOwner(user)

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

Drive no admite el cambio de propiedad de los elementos que son propiedad de cuentas de gmail.com, pero sí lo admite para las cuentas de Workspace.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que debería convertirse en el nuevo propietario.

Volver

Folder: Es este Folder, 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 alcances:

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

setSecurityUpdateEnabled(enabled)

Establece si Folder requiere una clave de recurso para acceder cuando se comparte a través de 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 compartir archivos de Google Drive.

Parámetros

NombreTipoDescripción
enabledBooleanIndica si se debe habilitar el requisito de clave de recurso para Folder.

Volver

Folder: Es este Folder, 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 alcances:

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

setShareableByEditors(shareable)

Establece si los usuarios con permisos de edición para el Folder pueden compartirlo con otros usuarios o cambiar los permisos. El valor predeterminado para un Folder nuevo es true.

Parámetros

NombreTipoDescripción
shareableBooleantrue si se debe permitir que los usuarios con permisos de edición compartan contenido con otros usuarios o cambien los permisos; false si no se debe permitir

Volver

Folder: Este Folder, para encadenar

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)

Establece qué clase de usuarios puede acceder a Folder 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 debería poder acceder a Folder
permissionTypePermissionLos permisos que se deben otorgar a los usuarios que pueden acceder a Folder

Volver

Folder: Este Folder, para encadenar

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 Folder se destaca en la unidad del usuario. El valor predeterminado para los Folder nuevos es false.

Parámetros

NombreTipoDescripción
starredBooleantrue si el Folder debe destacarse en la unidad de Drive del usuario; false si no

Volver

Folder: Este Folder, para encadenar

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 elemento Folder está en la papelera de la unidad del usuario. Solo el propietario puede enviar el Folder a la papelera. El valor predeterminado para los Folder nuevos es false.

Parámetros

NombreTipoDescripción
trashedBooleantrue si el Folder se debe mover a la papelera de la unidad de Drive del usuario; false si no

Volver

Folder: Este Folder, para encadenar

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

Métodos obsoletos