Class Folder

Carpeta

Una carpeta en Google Drive Puedes acceder a las carpetas o crearlas desde DriveApp.

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

Métodos

MétodoTipo de datos que se muestraDescripción breve
addEditor(emailAddress)FolderAgrega el usuario determinado a la lista de editores de Folder.
addEditor(user)FolderAgrega el usuario determinado a la lista de editores de Folder.
addEditors(emailAddresses)FolderAgrega el array determinado de usuarios a la lista de editores de Folder.
addViewer(emailAddress)FolderAgrega el usuario específico a la lista de lectores de Folder.
addViewer(user)FolderAgrega el usuario específico a la lista de lectores de Folder.
addViewers(emailAddresses)FolderAgrega el array determinado de usuarios a la lista de visualizadores de 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 proporcionados.
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 determinado.
createShortcut(targetId)FileCrea un acceso directo al ID de elemento de Drive proporcionado y lo muestra.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrea un acceso directo al ID del elemento de Drive y la clave de recurso proporcionados, y lo muestra.
getAccess(email)PermissionObtiene el permiso otorgado al usuario determinado.
getAccess(user)PermissionObtiene el permiso otorgado al usuario determinado.
getDateCreated()DateObtiene la fecha en que se creó el 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 secundarios de la carpeta actual y tienen el nombre determinado.
getFilesByType(mimeType)FileIteratorObtiene una colección de todos los archivos que son secundarios de la carpeta actual y tienen el tipo de MIME determinado.
getFolders()FolderIteratorObtiene una colección de todas las carpetas que son secundarias de la carpeta actual.
getFoldersByName(name)FolderIteratorObtiene una colección de todas las carpetas que son secundarias de la carpeta actual y tienen un nombre determinado.
getId()StringObtiene el ID del Folder.
getLastUpdated()DateObtiene la fecha de la última actualización del Folder.
getName()StringObtiene el nombre del Folder.
getOwner()UserObtiene el propietario de este Folder.
getParents()FolderIteratorObtiene una colección de carpetas que son elementos superiores inmediatos de Folder.
getResourceKey()StringObtiene la clave de recurso del Folder que se requiere para acceder a los elementos que se compartieron mediante un vínculo.
getSecurityUpdateEligible()BooleanDetermina si este Folder 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 Folder requiere una clave de recurso para acceder cuando es compartida mediante un vínculo.
getSharingAccess()AccessObtiene qué clase de usuarios puede acceder a Folder, además de cualquier usuario individual usuarios a los que se les otorgó acceso explícitamente.
getSharingPermission()PermissionObtiene el permiso que se otorga a los usuarios que pueden acceder a Folder. además de los usuarios individuales a los que se les otorgó acceso explícito.
getSize()IntegerObtiene la cantidad de bytes usados para almacenar el Folder en Drive.
getUrl()StringObtiene la URL que se puede usar para abrir 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 Folder pueden hacer lo siguiente: compartir con otros usuarios ni cambiar los permisos.
isStarred()BooleanDetermina si se destacó Folder en la unidad de Drive del usuario.
isTrashed()BooleanDetermina si Folder está en la papelera de Drive del usuario.
moveTo(destination)FolderMueve este elemento a la carpeta de destino proporcionada.
removeEditor(emailAddress)FolderQuita al usuario determinado de la lista de editores de Folder.
removeEditor(user)FolderQuita al usuario determinado de la lista de editores de Folder.
removeViewer(emailAddress)FolderQuita al usuario específico de la lista de lectores y comentaristas de Folder.
removeViewer(user)FolderQuita al usuario específico de la lista de lectores y comentaristas de Folder.
revokePermissions(emailAddress)FolderRevoca el acceso al Folder otorgado al usuario determinado.
revokePermissions(user)FolderRevoca el acceso al Folder otorgado al usuario determinado.
searchFiles(params)FileIteratorObtiene una colección de todos los archivos que son secundarios de la carpeta actual y que coinciden con la búsqueda determinada. con tus criterios.
searchFolders(params)FolderIteratorObtiene una colección de todas las carpetas que son secundarias de la carpeta actual y que coinciden con la búsqueda determinada con tus criterios.
setDescription(description)FolderEstablece la descripción del Folder.
setName(name)FolderEstablece el nombre de 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 es compartida mediante un vínculo.
setShareableByEditors(shareable)FolderEstablece si los usuarios con permisos de edición en Folder pueden compartir contenido con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FolderEstablece qué clase de usuarios puede acceder a Folder y qué permisos se otorgan esos usuarios, además de los usuarios individuales a los que se les otorgó acceso explícitamente.
setStarred(starred)FolderEstablece si se destaca Folder en la unidad de Drive del usuario.
setTrashed(trashed)FolderEstablece si el elemento Folder está en la papelera de Drive del usuario.

Documentación detallada

addEditor(emailAddress)

Agrega el usuario determinado a la lista de editores de Folder. Si el usuario ya estaba en la lista de usuarios, este método asciende al usuario fuera de la lista de usuarios.

Parámetros

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

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

addEditor(user)

Agrega el usuario determinado a la lista de editores de Folder. Si el usuario ya estaba en la lista de usuarios, este método asciende al usuario fuera de la lista de usuarios.

Parámetros

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

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

addEditors(emailAddresses)

Agrega el array determinado de usuarios a la lista de editores de Folder. Si alguno de los usuarios ya estaban en la lista de usuarios; este método los hace desaparecer 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.

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

addViewer(emailAddress)

Agrega el usuario específico a la lista de lectores de Folder. 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 se agregará.

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

addViewer(user)

Agrega el usuario específico a la lista de lectores de 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: 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 determinado de usuarios a la lista de visualizadores de Folder. Si alguno de los ya estaban en la lista de editores, este método no tiene efecto para ellos.

Parámetros

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

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

createFile(blob)

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

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.getRootFolder().createFile(blob);

Parámetros

NombreTipoDescripción
blobBlobSourceLos 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 proporcionados. Arroja un excepción si content supera los 50 MB.

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

Parámetros

NombreTipoDescripción
nameStringEs el nombre del archivo nuevo.
contentStringEl 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. Lanzamientos una excepción si content supera los 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
nameStringEs el nombre del archivo nuevo.
contentStringEl contenido del archivo nuevo.
mimeTypeStringEs el tipo de 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 determinado.

Parámetros

NombreTipoDescripción
nameStringEl 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 de elemento de Drive proporcionado y lo muestra.

Parámetros

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

Volver

File: Es la nueva combinación de teclas.

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 la clave de recurso proporcionados, y lo muestra. Un recurso es un parámetro adicional que se debe pasar para acceder al archivo o a la carpeta de destino se compartió mediante 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
targetIdStringEl ID del archivo o la carpeta de destino.
targetResourceKeyStringLa clave del recurso del archivo o la carpeta de destino.

Volver

File: Es la nueva combinación de teclas.

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

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

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

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

getDateCreated()

Obtiene la fecha en que se creó el Folder.

Volver

Date: Es la fecha en 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 muestra 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 (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 de lo contrario, está 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

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 secundarios de la carpeta actual y tienen el nombre determinado.

Parámetros

NombreTipoDescripción
nameStringEl nombre de los archivos que se buscarán.

Volver

FileIterator: Es una colección de todos los archivos que son secundarios de la carpeta actual y tienen un 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 secundarios de la carpeta actual y tienen el tipo de MIME determinado.

Parámetros

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

Volver

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

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 que son secundarias de la carpeta actual.

Volver

FolderIterator: Es una colección de todas las carpetas que son 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 que son secundarias de la carpeta actual y tienen un nombre determinado.

Parámetros

NombreTipoDescripción
nameStringEl nombre 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 un 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 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

getLastUpdated()

Obtiene la fecha de la última actualización del 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: Es el nombre 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

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: 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 elementos superiores inmediatos de Folder.

Volver

FolderIterator: Es una colección de carpetas que son elementos superiores inmediatos 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

getResourceKey()

Obtiene la clave de recurso del Folder que se requiere para acceder a los elementos que se compartieron mediante un vínculo.

Volver

String: Es la clave de 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()

Determina si este Folder 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 requiere una clave de recurso para acceder a algunos archivos o carpetas que se compartieron con una enlace. Este cambio forma parte de una actualización de seguridad. La actualización está activada de forma predeterminada para archivos y carpetas. 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 se puede aplicar 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()

Obtiene si este Folder requiere una clave de recurso para acceder cuando es compartida mediante un vínculo. Este requisito está activado de forma predeterminada para las carpetas y los archivos 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 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 qué clase de usuarios puede acceder a Folder, además de cualquier usuario individual usuarios a los que se les otorgó acceso explícitamente.

Volver

Access: Indica 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 que se otorga a los usuarios que pueden acceder a Folder. además de los usuarios individuales a los que se les otorgó acceso explícito.

Volver

Permission: Son los permisos otorgados 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 usados para almacenar el Folder en Drive. Ten en cuenta que Los archivos de las aplicaciones de Google Workspace no se consideran en los límites de almacenamiento de Drive y, por lo tanto, se devuelven 0 bytes.

Volver

Integer: Es la cantidad de bytes que se usan para almacenar 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 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 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 viewers and logs their names to the console.
const viewers = folder.getViewers();
for (viewer of viewers) {
  console.log(viewer.getName());
}

Volver

User[]: Es la lista de lectores y comentaristas de esta Folder si el usuario tiene edición. o un array vacío 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 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 Folder pueden hacer lo siguiente: compartir con otros usuarios ni cambiar los permisos.

Volver

Boolean: true si los usuarios con permisos de edición pueden compartir contenido con otros usuarios o cambiar los permisos 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

isStarred()

Determina si se destacó Folder en la unidad de Drive del usuario.

Volver

Boolean: Es true si la Folder está destacada 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 Folder está en la papelera de Drive del usuario.

Volver

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

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 al elemento carpeta superior actual para mover el elemento a la carpeta de destino.

Parámetros

NombreTipoDescripción
destinationFolderLa carpeta que se convierte en el nuevo elemento 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 determinado de la lista de editores de Folder. Este método no impedir 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, o si Folder 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 lectores.

Parámetros

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

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

Quita al usuario determinado de la lista de editores de Folder. Este método no impedir 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, o si Folder 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 lectores.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se quitará.

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

removeViewer(emailAddress)

Quita al usuario específico de la lista de lectores y comentaristas de Folder. Esta no tiene efecto si el usuario es editor, no visualizador ni comentarista. Este método también no impida que los usuarios accedan a Folder si pertenecen a una clase de usuarios que tener acceso general (por ejemplo, si el Folder se comparte con la cuenta de usuario todo el dominio o si Folder 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
emailAddressStringLa dirección de correo electrónico del usuario que se quitará.

Volver

Folder: Indica 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(user)

Quita al usuario específico de la lista de lectores y comentaristas de Folder. Esta no tiene efecto si el usuario es editor y no visualizador. Este método tampoco bloquea que los usuarios accedan a Folder si pertenecen a una clase de usuarios que tienen permisos generales (por ejemplo, si Folder se comparte con todo el dominio del usuario) Si Folder está en una unidad compartida a la que el usuario pueda acceder.

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

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se quitará.

Volver

Folder: Indica 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(emailAddress)

Revoca el acceso al Folder otorgado al usuario determinado. Este método no Impedir que los usuarios accedan a Folder si pertenecen a una clase de usuarios que tener acceso general (por ejemplo, si el Folder se comparte con el dominio completo.

Parámetros

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

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

revokePermissions(user)

Revoca el acceso al Folder otorgado al usuario determinado. Este método no Impedir que los usuarios accedan a Folder si pertenecen a una clase de usuarios que tener acceso general (por ejemplo, si el Folder se comparte con el dominio completo.

Parámetros

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

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

searchFiles(params)

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

El argumento params es una cadena de consulta que puede contener valores de cadena, así que ten cuidado para escapar las comillas de forma correcta (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.""
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

Parámetros

NombreTipoDescripción
paramsStringLos 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 la búsqueda. con tus criterios.

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 que son secundarias de la carpeta actual y que coinciden con la búsqueda determinada con tus criterios. Los criterios de búsqueda se detallan en la documentación del SDK de Google Drive. Ten en cuenta que la carpeta Drive usa la v2 de la API de Drive y algunos campos de consulta difieren de la v3. Revisa el campo diferencias entre v2 y v3.

El argumento params es una cadena de consulta que puede contener valores de cadena, así que ten cuidado para escapar las comillas de forma correcta (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.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  console.log(folder.getName());
}

Parámetros

NombreTipoDescripción
paramsStringLos 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 que son secundarias de la carpeta actual y que coinciden con la búsqueda. con tus criterios.

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

Parámetros

NombreTipoDescripción
nameStringel nombre nuevo de Folder

Volver

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

Parámetros

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

Volver

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

Parámetros

NombreTipoDescripción
userUseruna representación del usuario que debería convertirse en el nuevo propietario

Volver

Folder: este Folder, 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 Folder requiere una clave de recurso para acceder cuando es compartida 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 para Google Drive.

Parámetros

NombreTipoDescripción
enabledBooleanEstablece si se habilita el requisito de clave de recursos para Folder.

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

setShareableByEditors(shareable)

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

Parámetros

NombreTipoDescripción
shareableBooleantrue si los usuarios con permisos de edición deben poder compartir contenido con otros usuarios o cambiar los permisos false si no es así

Volver

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

Establece qué clase de usuarios puede acceder a Folder y qué permisos se otorgan esos usuarios, además de los usuarios individuales a los que se les otorgó acceso explícitamente.

// 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 a Folder
permissionTypePermissionlos permisos que se deben otorgar a los usuarios que pueden acceder a Folder

Volver

Folder: este Folder, 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 se destaca Folder en la unidad de Drive del usuario. La configuración predeterminada los nuevos Folder son false.

Parámetros

NombreTipoDescripción
starredBooleantrue si el Folder debe destacarse en el Drive; false si no es así

Volver

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

Parámetros

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

Volver

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

Métodos obsoletos