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. var folders = DriveApp.getFolders(); while (folders.hasNext()) { var folder = folders.next(); Logger.log(folder.getName()); }
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addEditor(emailAddress) | Folder | Agrega el usuario determinado a la lista de editores del Folder . |
addEditor(user) | Folder | Agrega el usuario determinado a la lista de editores del Folder . |
addEditors(emailAddresses) | Folder | Agrega el array de usuarios determinado a la lista de editores del Folder . |
addViewer(emailAddress) | Folder | Agrega el usuario determinado a la lista de visualizadores de Folder . |
addViewer(user) | Folder | Agrega el usuario determinado a la lista de visualizadores de Folder . |
addViewers(emailAddresses) | Folder | Agrega el array de usuarios determinado a la lista de visualizadores de Folder . |
createFile(blob) | File | Crea un archivo en la carpeta actual a partir de un Blob determinado de datos arbitrarios. |
createFile(name, content) | File | Crea un archivo de texto en la carpeta actual con el nombre dado y el contenido. |
createFile(name, content, mimeType) | File | Crea un archivo en la carpeta actual con el nombre, el contenido y el tipo de MIME especificados. |
createFolder(name) | Folder | Crea una carpeta en la carpeta actual con el nombre dado. |
createShortcut(targetId) | File | Crea un acceso directo al ID del elemento de Drive proporcionado y lo muestra. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Crea un acceso directo al ID del elemento de Drive y la clave de recurso proporcionados, y lo muestra. |
getAccess(email) | Permission | Obtiene el permiso otorgado al usuario determinado. |
getAccess(user) | Permission | Obtiene el permiso otorgado al usuario determinado. |
getDateCreated() | Date | Obtiene la fecha en que se creó el Folder . |
getDescription() | String | Obtiene la descripción de Folder . |
getEditors() | User[] | Obtiene la lista de editores para este Folder . |
getFiles() | FileIterator | Obtiene una colección de todos los archivos secundarios de la carpeta actual. |
getFilesByName(name) | FileIterator | Obtiene una colección de todos los archivos que son secundarios de la carpeta actual y tienen un nombre determinado. |
getFilesByType(mimeType) | FileIterator | Obtiene una colección de todos los archivos que son secundarios de la carpeta actual y tienen un tipo de MIME determinado. |
getFolders() | FolderIterator | Obtiene una colección de todas las carpetas que son secundarias de la carpeta actual. |
getFoldersByName(name) | FolderIterator | Obtiene una colección de todas las carpetas que son secundarias de la carpeta actual y tienen un nombre determinado. |
getId() | String | Obtiene el ID de Folder . |
getLastUpdated() | Date | Obtiene la fecha en que se actualizó el Folder por última vez. |
getName() | String | Obtiene el nombre de Folder . |
getOwner() | User | Obtiene el propietario de este Folder . |
getParents() | FolderIterator | Obtiene una colección de carpetas que son superiores inmediatos de Folder . |
getResourceKey() | String | Obtiene la clave de recurso del Folder que se requiere para acceder a los elementos que se compartieron a través de un vínculo. |
getSecurityUpdateEligible() | Boolean | Obtiene 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() | Boolean | Obtiene si este Folder requiere una clave de recurso para acceder cuando se comparte mediante un vínculo. |
getSharingAccess() | Access | Obtiene qué clase de usuarios puede acceder a Folder , además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
getSharingPermission() | Permission | Obtiene el permiso otorgado a aquellos usuarios que pueden acceder a Folder , además de los usuarios individuales a los que se les otorgó acceso de manera explícita. |
getSize() | Integer | Obtiene la cantidad de bytes que se usan para almacenar el Folder en Drive. |
getUrl() | String | Obtiene la URL que se puede usar para abrir el archivo Folder en una app de Google, como
Drive o Documentos. |
getViewers() | User[] | Obtiene la lista de lectores y comentaristas de este Folder . |
isShareableByEditors() | Boolean | Determina si los usuarios con permisos de edición para Folder pueden compartir contenido con otros usuarios o cambiar los permisos. |
isStarred() | Boolean | Determina si el elemento Folder se destacó en la unidad de Drive del usuario. |
isTrashed() | Boolean | Determina si el elemento Folder está en la papelera de la unidad de Drive del usuario. |
moveTo(destination) | Folder | Mueve este elemento a la carpeta de destino proporcionada. |
removeEditor(emailAddress) | Folder | Quita al usuario determinado de la lista de editores del Folder . |
removeEditor(user) | Folder | Quita al usuario determinado de la lista de editores del Folder . |
removeViewer(emailAddress) | Folder | Quita al usuario determinado de la lista de lectores y comentaristas del Folder . |
removeViewer(user) | Folder | Quita al usuario determinado de la lista de lectores y comentaristas del Folder . |
revokePermissions(emailAddress) | Folder | Revoca el acceso al Folder otorgado al usuario determinado. |
revokePermissions(user) | Folder | Revoca el acceso al Folder otorgado al usuario determinado. |
searchFiles(params) | FileIterator | Obtiene una colección de todos los archivos secundarios de la carpeta actual y que coinciden con los criterios de búsqueda dados. |
searchFolders(params) | FolderIterator | Obtiene una colección de todas las carpetas que son elementos secundarios de la carpeta actual y coinciden con los criterios de búsqueda dados. |
setDescription(description) | Folder | Establece la descripción de Folder . |
setName(name) | Folder | Establece el nombre de Folder . |
setOwner(emailAddress) | Folder | Cambia el propietario de Folder . |
setOwner(user) | Folder | Cambia el propietario de Folder . |
setSecurityUpdateEnabled(enabled) | Folder | Establece si Folder requiere una clave de recurso para acceder cuando se comparte mediante un vínculo. |
setShareableByEditors(shareable) | Folder | Establece si los usuarios con permisos de edición para Folder pueden compartir contenido con otros usuarios o cambiar los permisos. |
setSharing(accessType, permissionType) | Folder | Configura qué clase de usuarios pueden acceder a Folder y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso de manera explícita. |
setStarred(starred) | Folder | Establece si el elemento Folder se destacará en la unidad de Drive del usuario. |
setTrashed(trashed) | Folder | Establece si el Folder está en la papelera de la unidad de Drive del usuario. |
Documentación detallada
addEditor(emailAddress)
Agrega el usuario determinado a la lista de editores del Folder
. Si el usuario ya estaba en la lista de usuarios, este método quita al usuario de la lista.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddress | String | Es la dirección de correo electrónico del usuario que se agregará. |
Devolvedor
Folder
: Es 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
addEditor(user)
Agrega el usuario determinado a la lista de editores del Folder
. Si el usuario ya estaba en la lista de usuarios, este método quita al usuario de la lista.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
user | User | Es una representación del usuario que se agregará. |
Devolvedor
Folder
: Es 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
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, este método lo quita de la lista de usuarios.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddresses | String[] | Un array de direcciones de correo electrónico de los usuarios que se agregarán. |
Devolvedor
Folder
: Es 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
addViewer(emailAddress)
Agrega el usuario determinado a la lista de visualizadores de Folder
. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddress | String | Es la dirección de correo electrónico del usuario que se agregará. |
Devolvedor
Folder
: Es 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
addViewer(user)
Agrega el usuario determinado a la lista de visualizadores de Folder
. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
user | User | Es una representación del usuario que se agregará. |
Devolvedor
Folder
: Es 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
addViewers(emailAddresses)
Agrega el array de usuarios determinado a la lista de visualizadores de Folder
. Si alguno de los usuarios ya estaba en la lista de editores, este método no tiene efecto.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddresses | String[] | Un array de direcciones de correo electrónico de los usuarios que se agregarán. |
Devolvedor
Folder
: Es 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
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
Nombre | Tipo | Descripción |
---|---|---|
blob | BlobSource | Los datos del archivo nuevo. |
Devolvedor
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 dado y el contenido. Arroja una 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
Nombre | Tipo | Descripción |
---|---|---|
name | String | El nombre del archivo nuevo. |
content | String | El contenido del archivo nuevo. |
Devolvedor
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. Arroja 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
Nombre | Tipo | Descripción |
---|---|---|
name | String | El nombre del archivo nuevo. |
content | String | El contenido del archivo nuevo. |
mimeType | String | Es el tipo de MIME del archivo nuevo. |
Devolvedor
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 dado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
name | String | El nombre de la carpeta nueva. |
Devolvedor
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 muestra.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
targetId | String | El ID de archivo del archivo o la carpeta de destino. |
Devolvedor
File
: Es el nuevo atajo.
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. 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ó 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
Nombre | Tipo | Descripción |
---|---|---|
targetId | String | El ID del archivo o la carpeta de destino. |
targetResourceKey | String | La clave de recurso del archivo o la carpeta de destino. |
Devolvedor
File
: Es el nuevo atajo.
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
Nombre | Tipo | Descripción |
---|---|---|
email | String | la dirección de correo electrónico del usuario cuyos permisos deben verificarse |
Devolvedor
Permission
: Son los permisos otorgados al usuario.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAccess(user)
Obtiene el permiso otorgado al usuario determinado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
user | User | una representación del usuario cuyos permisos deben verificarse |
Devolvedor
Permission
: Son los permisos otorgados al usuario.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getDateCreated()
Obtiene la fecha en que se creó el Folder
.
Devolvedor
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()
getEditors()
Obtiene la lista de editores para 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()); }
Devolvedor
User[]
: Es la lista de editores de este Folder
si el usuario tiene acceso de edición o, de lo contrario, un array vacío.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getFiles()
Obtiene una colección de todos los archivos secundarios de la carpeta actual.
Devolvedor
FileIterator
: Es una colección de todos los archivos 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 un nombre determinado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
name | String | El nombre de los archivos a buscar. |
Devolvedor
FileIterator
: Es una colección de todos los archivos 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 un tipo de MIME determinado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
mimeType | String | El tipo de MIME de los archivos que se buscarán. |
Devolvedor
FileIterator
: Es una colección de todos los archivos secundarios de la carpeta actual y que tienen un 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 que son secundarias de la carpeta actual.
Devolvedor
FolderIterator
: Es una colección de todas las carpetas que son elementos 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
getFoldersByName(name)
Obtiene una colección de todas las carpetas que son secundarias de la carpeta actual y tienen un nombre determinado.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
name | String | El nombre de las carpetas que se buscarán. |
Devolvedor
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()
getLastUpdated()
Obtiene la fecha en que se actualizó el Folder
por última vez.
Devolvedor
Date
: Es la fecha en 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()
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());
Devolvedor
User
: Es el propietario de este dispositivo 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 de Folder
.
Devolvedor
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 a través de un vínculo.
Devolvedor
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 mediante un vínculo.
Drive necesita una clave de recurso para acceder a algunos archivos o carpetas que se compartieron a través de un vínculo. Este cambio forma parte de una actualización de seguridad. La actualización está activada de forma predeterminada para los archivos y las carpetas aptos. Si quieres activar o desactivar el requisito de clave de recurso para los archivos aptos, usa setSecurityUpdateEnabled
.
Obtén más información sobre la Actualización de seguridad de Google Drive.
Devolvedor
Boolean
: Indica si el requisito de clave de recurso se puede aplicar a 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 se comparte mediante un vínculo. Este requisito está activado de forma predeterminada para los archivos y las carpetas aptos.
Para activar o desactivar el requisito de clave de recurso en los archivos aptos, usa
setSecurityUpdateEnabled
.
Obtén más información sobre la Actualización de seguridad de Google Drive.
Devolvedor
Boolean
: Indica si el requisito de clave de recurso está habilitado para este 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 los usuarios individuales a los que se les otorgó acceso de forma explícita.
Devolvedor
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 otorgado a aquellos usuarios que pueden acceder a Folder
, además de los usuarios individuales a los que se les otorgó acceso de manera explícita.
Devolvedor
Permission
: Son los permisos otorgados a los usuarios que pueden acceder a 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 Folder
en Drive. Ten en cuenta que los archivos de la aplicación de Google Workspace no se consideran en los límites de almacenamiento en Drive y, por lo tanto, muestran 0
bytes.
Devolvedor
Integer
: Es la cantidad de bytes que se usan para almacenar el 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 archivo Folder
en una app de Google, como
Drive o Documentos.
Devolvedor
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 muestra un arreglo 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()); }
Devolvedor
User[]
: Es la lista de lectores y comentaristas 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
isStarred()
Determina si el elemento Folder
se destacó en la unidad de Drive del usuario.
Devolvedor
Boolean
: true
si Folder
está destacado en la unidad de Drive del usuario; false
si no es así
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isTrashed()
Determina si el elemento Folder
está en la papelera de la unidad de Drive del usuario.
Devolvedor
Boolean
: true
si Folder
está en la papelera de la unidad de Drive del usuario; false
si no es así
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
moveTo(destination)
Mueve este elemento a la carpeta de destino proporcionada.
El usuario actual debe ser el propietario del archivo o tener, al menos, acceso de edición a la carpeta superior actual del elemento para poder moverlo a la carpeta de destino.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
destination | Folder | La carpeta que se convierte en el nuevo superior. |
Devolvedor
Folder
: Es 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
removeEditor(emailAddress)
Quita al usuario determinado de la lista de editores del Folder
. 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 Folder
se comparte con todo el dominio del usuario o si 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 lectores.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddress | String | Es la dirección de correo electrónico del usuario que se quitará. |
Devolvedor
Folder
: Es 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
removeEditor(user)
Quita al usuario determinado de la lista de editores del Folder
. 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 Folder
se comparte con todo el dominio del usuario o si 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 lectores.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
user | User | Es una representación del usuario que se quitará. |
Devolvedor
Folder
: Es 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
removeViewer(emailAddress)
Quita al usuario determinado de la lista de lectores y comentaristas del Folder
. Este método no tiene efecto si el usuario es editor, no lector ni comentarista. Este método tampoco impide que los usuarios accedan a Folder
si pertenecen a una clase de usuarios que tienen acceso general (por ejemplo, si Folder
se comparte con todo el dominio del usuario o si 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 editores.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddress | String | Es la dirección de correo electrónico del usuario que se quitará. |
Devolvedor
Folder
: Es 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
removeViewer(user)
Quita al usuario determinado de la lista de lectores y comentaristas del Folder
. Este método no tiene efecto si el usuario es editor, no lector. Este método tampoco impide que los usuarios accedan a Folder
si pertenecen a una clase de usuarios que tienen acceso general (por ejemplo, si 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 editores.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
user | User | Es una representación del usuario que se quitará. |
Devolvedor
Folder
: Es 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
revokePermissions(emailAddress)
Revoca el acceso al Folder
otorgado al usuario determinado. 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 Folder
se comparte con todo el dominio del usuario).
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddress | String | La dirección de correo electrónico del usuario cuyo acceso se debe revocar. |
Devolvedor
Folder
: Es 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
revokePermissions(user)
Revoca el acceso al Folder
otorgado al usuario determinado. 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 Folder
se comparte con todo el dominio del usuario).
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
user | User | Representación del usuario cuyo acceso se debe revocar. |
Devolvedor
Folder
: Es 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
searchFiles(params)
Obtiene una colección de todos los archivos secundarios de la carpeta actual y que coinciden con los criterios de búsqueda dados. 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 que algunos campos de consulta difieren de la versión 3. Revisa las diferencias de campo entre la versión 2 y la v3.
El argumento params
es una cadena de consulta que puede contener valores de cadena, por lo que debes asegurarte de 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
Nombre | Tipo | Descripción |
---|---|---|
params | String | Los criterios de búsqueda, como se detallan en la documentación del SDK de Google Drive |
Devolvedor
FileIterator
: Es una colección de todos los archivos 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 que son elementos secundarios de la carpeta actual y coinciden con los criterios de búsqueda dados. 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 que algunos campos de consulta difieren de la versión 3. Revisa las diferencias de campo entre la versión 2 y la v3.
El argumento params
es una cadena de consulta que puede contener valores de cadena, por lo que debes asegurarte de 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
Nombre | Tipo | Descripción |
---|---|---|
params | String | Los criterios de búsqueda, como se detallan en la documentación del SDK de Google Drive |
Devolvedor
FolderIterator
: Es un conjunto de todas las carpetas que son elementos secundarios de la carpeta actual y 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 de Folder
.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
description | String | la nueva descripción de Folder |
Devolvedor
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
Nombre | Tipo | Descripción |
---|---|---|
name | String | el nombre nuevo de Folder |
Devolvedor
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
Nombre | Tipo | Descripción |
---|---|---|
emailAddress | String | la dirección de correo electrónico del usuario que debe convertirse en el nuevo propietario |
Devolvedor
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
Nombre | Tipo | Descripción |
---|---|---|
user | User | una representación del usuario que debe convertirse en el nuevo propietario |
Devolvedor
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 se comparte mediante un vínculo. Los archivos y las carpetas aptos están habilitados de forma predeterminada.
Obtén más información sobre la Actualización de seguridad de Google Drive.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
enabled | Boolean | Si se habilita el requisito de clave de recurso para Folder . |
Devolvedor
Folder
: Es 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)
Configura qué clase de usuarios pueden acceder a Folder
y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso de manera explícita.
// Creates a folder that anyone on the Internet can read from and write to. (Domain // administrators can prohibit this setting for users of a Google Workspace domain.) var folder = DriveApp.createFolder('Shared Folder'); folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
accessType | Access | qué clase de usuarios debería poder acceder al Folder |
permissionType | Permission | los permisos que se deben otorgar a los usuarios que puedan acceder a Folder |
Devolvedor
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 el elemento Folder
se destacará en la unidad de Drive del usuario. El valor predeterminado para los objetos Folder
nuevos es false
.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
starred | Boolean | true si se debe destacar Folder en la unidad de Drive del usuario; false si no es así |
Devolvedor
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 Folder
está en la papelera de la unidad de Drive del usuario. Solo el propietario puede enviar el Folder
a la papelera. El valor predeterminado de los elementos Folder
nuevos es false
.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
trashed | Boolean | true si el Folder debe moverse a la papelera de la unidad de Drive del usuario; false si no es así |
Devolvedor
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