Este servicio permite que las secuencias de comandos creen, busquen y modifiquen archivos y carpetas en Google Drive
Si la secuencia de comandos utiliza un proyecto estándar de Cloud en lugar de un proyecto de Cloud predeterminado, debes activar manualmente la API de Drive. En tu proyecto estándar de Cloud, activa la API de Drive:
En la siguiente muestra de código, se indica cómo registrar los nombres de cada archivo en la biblioteca Carpeta Mi unidad:// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
var file = files.next();
console.log(file.getName());
}
Clases
Nombre | Descripción breve |
---|---|
Access | Una enumeración que representa las clases de usuarios que pueden acceder a un archivo o una carpeta, además de cualquier usuarios a los que se les otorgó acceso explícitamente. |
DriveApp | Permite que las secuencias de comandos creen, busquen y modifiquen archivos y carpetas en Google Drive. |
File | Un archivo en Google Drive |
FileIterator | Es un iterador que permite que las secuencias de comandos iteren en una colección de archivos potencialmente grande. |
Folder | Una carpeta en Google Drive |
FolderIterator | Es un objeto que permite que las secuencias de comandos iteren en una gran colección de carpetas. |
Permission | Una enumeración que representa los permisos otorgados a los usuarios que pueden acceder a un archivo o una carpeta, además de todos los usuarios individuales a los que se les otorgó acceso explícito. |
User | Un usuario asociado con un archivo en Google Drive. |
Access
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
ANYONE | Enum | Cualquier usuario de Internet puede encontrar el elemento y acceder a él. |
ANYONE_WITH_LINK | Enum | Cualquier persona que tenga el vínculo puede acceder al elemento. |
DOMAIN | Enum | Los miembros de tu dominio pueden encontrar el elemento y acceder a él. |
DOMAIN_WITH_LINK | Enum | Pueden acceder las personas de tu dominio que tengan el vínculo. |
PRIVATE | Enum | Solo pueden acceder las personas a las que se les otorgó el permiso explícito. |
DriveApp
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
Access | Access | Una enumeración que representa las clases de usuarios que pueden acceder a un archivo o una carpeta, además de cualquier usuarios a los que se les otorgó acceso explícitamente. |
Permission | Permission | Una enumeración que representa los permisos otorgados a los usuarios que pueden acceder a un archivo o una carpeta, además de todos los usuarios individuales a los que se les otorgó acceso explícito. |
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | Reanuda una iteración de archivo con un token de continuación de un iterador anterior. |
continueFolderIterator(continuationToken) | FolderIterator | Reanuda una iteración de carpeta con un token de continuación de un iterador anterior. |
createFile(blob) | File | Crea un archivo en la raíz de la unidad de Drive del usuario a partir de un Blob determinado de datos arbitrarios. |
createFile(name, content) | File | Crea un archivo de texto en la raíz de la unidad de Drive del usuario con el nombre y el contenido especificados. |
createFile(name, content, mimeType) | File | Crea un archivo en la raíz de la unidad de Drive del usuario con el nombre, el contenido y el tipo de MIME especificados. |
createFolder(name) | Folder | Crea una carpeta en la raíz de la unidad de Drive del usuario con el nombre determinado. |
createShortcut(targetId) | File | Crea un acceso directo al ID de 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. |
enforceSingleParent(value) | void | Habilita o inhabilita el comportamiento de aplicarSingleParent para todas las llamadas que afecten a los elementos superiores. |
getFileById(id) | File | Obtiene el archivo con el ID determinado. |
getFileByIdAndResourceKey(id, resourceKey) | File | Obtiene el archivo con el ID y la clave de recurso especificados. |
getFiles() | FileIterator | Obtiene una colección de todos los archivos de la unidad de Drive del usuario. |
getFilesByName(name) | FileIterator | Obtiene una colección de todos los archivos de la unidad de Drive del usuario que tienen el nombre determinado. |
getFilesByType(mimeType) | FileIterator | Obtiene una colección de todos los archivos de la unidad de Drive del usuario que tengan el tipo de MIME determinado. |
getFolderById(id) | Folder | Obtiene la carpeta con el ID determinado. |
getFolderByIdAndResourceKey(id, resourceKey) | Folder | Obtiene la carpeta con el ID y la clave de recurso especificados. |
getFolders() | FolderIterator | Obtiene una colección de todas las carpetas de la unidad de Drive del usuario. |
getFoldersByName(name) | FolderIterator | Obtiene una colección de todas las carpetas de la unidad de Drive del usuario que tienen el nombre determinado. |
getRootFolder() | Folder | Obtiene la carpeta en la raíz de la unidad de Drive del usuario. |
getStorageLimit() | Integer | Obtiene la cantidad de bytes que el usuario puede almacenar en Drive. |
getStorageUsed() | Integer | Obtiene la cantidad de bytes que el usuario está almacenando actualmente en Drive. |
getTrashedFiles() | FileIterator | Obtiene una colección de todos los archivos de la papelera de la unidad de Drive del usuario. |
getTrashedFolders() | FolderIterator | Obtiene una colección de todas las carpetas de la papelera de Drive del usuario. |
searchFiles(params) | FileIterator | Obtiene una colección de todos los archivos de la unidad de Drive del usuario que coinciden con la búsqueda determinada con tus criterios. |
searchFolders(params) | FolderIterator | Obtiene una colección de todas las carpetas de la unidad de Drive del usuario que coinciden con la búsqueda determinada con tus criterios. |
File
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addCommenter(emailAddress) | File | Agrega el usuario específico a la lista de comentaristas de File . |
addCommenter(user) | File | Agrega el usuario específico a la lista de comentaristas de File . |
addCommenters(emailAddresses) | File | Agrega el array de usuarios determinado a la lista de comentaristas de File . |
addEditor(emailAddress) | File | Agrega el usuario determinado a la lista de editores de File . |
addEditor(user) | File | Agrega el usuario determinado a la lista de editores de File . |
addEditors(emailAddresses) | File | Agrega el array determinado de usuarios a la lista de editores de File . |
addViewer(emailAddress) | File | Agrega el usuario específico a la lista de lectores de File . |
addViewer(user) | File | Agrega el usuario específico a la lista de lectores de File . |
addViewers(emailAddresses) | File | Agrega el array determinado de usuarios a la lista de visualizadores de File . |
getAccess(email) | Permission | Obtiene el permiso otorgado al usuario determinado. |
getAccess(user) | Permission | Obtiene el permiso otorgado al usuario determinado. |
getAs(contentType) | Blob | Muestra los datos dentro de este objeto como un BLOB convertido al tipo de contenido especificado. |
getBlob() | Blob | Muestra los datos dentro de este objeto como un BLOB. |
getDateCreated() | Date | Obtiene la fecha en que se creó el File . |
getDescription() | String | Obtiene la descripción del File . |
getDownloadUrl() | String | Obtiene la URL que se puede usar para descargar el archivo. |
getEditors() | User[] | Obtiene la lista de editores de este File . |
getId() | String | Obtiene el ID del File . |
getLastUpdated() | Date | Obtiene la fecha de la última actualización del File . |
getMimeType() | String | Obtiene el tipo de MIME del archivo. |
getName() | String | Obtiene el nombre del File . |
getOwner() | User | Obtiene el propietario del archivo. |
getParents() | FolderIterator | Obtiene una colección de carpetas que son elementos superiores inmediatos de File . |
getResourceKey() | String | Obtiene la clave de recurso del File que se requiere para acceder a los elementos que
se compartieron mediante un vínculo. |
getSecurityUpdateEligible() | Boolean | Determina si este File es apto para aplicar la actualización de seguridad que
requiere una clave de recurso para acceder cuando se comparte mediante un vínculo. |
getSecurityUpdateEnabled() | Boolean | Obtiene si este File requiere una clave de recurso para acceder cuando es
compartida mediante un vínculo. |
getSharingAccess() | Access | Obtiene qué clase de usuarios puede acceder a File , además de cualquier usuario individual
usuarios a los que se les otorgó acceso explícitamente. |
getSharingPermission() | Permission | Obtiene el permiso que se otorga a los usuarios que pueden acceder a File .
además de los usuarios individuales a los que se les otorgó acceso explícito. |
getSize() | Integer | Obtiene la cantidad de bytes usados para almacenar el File en Drive. |
getTargetId() | String | Si se trata de un acceso directo, muestra el ID del elemento al que apunta. |
getTargetMimeType() | String | Si se trata de un acceso directo, muestra el tipo de MIME del elemento al que apunta. |
getTargetResourceKey() | String | Si el archivo es una combinación de teclas, muestra la clave del recurso del elemento al que apunta. |
getThumbnail() | Blob | Obtiene una imagen en miniatura para el archivo o null si no existe una miniatura. |
getUrl() | String | Obtiene la URL que se puede usar para abrir File en una app de Google, como
Drive o Documentos. |
getViewers() | User[] | Obtiene la lista de lectores y comentaristas de este File . |
isShareableByEditors() | Boolean | Determina si los usuarios con permisos de edición para File pueden hacer lo siguiente:
compartir con otros usuarios ni cambiar los permisos. |
isStarred() | Boolean | Determina si se destacó File en la unidad de Drive del usuario. |
isTrashed() | Boolean | Determina si File está en la papelera de Drive del usuario. |
makeCopy() | File | Crea una copia del archivo. |
makeCopy(destination) | File | Crea una copia del archivo en el directorio de destino. |
makeCopy(name) | File | Crea una copia del archivo y le asigna el nombre proporcionado. |
makeCopy(name, destination) | File | Crea una copia del archivo en el directorio de destino y le asigna el nombre proporcionado. |
moveTo(destination) | File | Mueve este elemento a la carpeta de destino proporcionada. |
removeCommenter(emailAddress) | File | Quita al usuario determinado de la lista de comentaristas de File . |
removeCommenter(user) | File | Quita al usuario determinado de la lista de comentaristas de File . |
removeEditor(emailAddress) | File | Quita al usuario determinado de la lista de editores de File . |
removeEditor(user) | File | Quita al usuario determinado de la lista de editores de File . |
removeViewer(emailAddress) | File | Quita al usuario específico de la lista de lectores y comentaristas de File . |
removeViewer(user) | File | Quita al usuario específico de la lista de lectores y comentaristas de File . |
revokePermissions(emailAddress) | File | Revoca el acceso al File otorgado al usuario determinado. |
revokePermissions(user) | File | Revoca el acceso al File otorgado al usuario determinado. |
setContent(content) | File | Reemplaza el contenido del archivo con un reemplazo específico. |
setDescription(description) | File | Establece la descripción del File . |
setName(name) | File | Establece el nombre de File . |
setOwner(emailAddress) | File | Cambia el propietario de File . |
setOwner(user) | File | Cambia el propietario de File . |
setSecurityUpdateEnabled(enabled) | File | Establece si File requiere una clave de recurso para acceder cuando es
compartida mediante un vínculo. |
setShareableByEditors(shareable) | File | Establece si los usuarios con permisos de edición en File pueden compartir contenido
con otros usuarios o cambiar los permisos. |
setSharing(accessType, permissionType) | File | Establece qué clase de usuarios puede acceder a File y qué permisos
se otorgan esos usuarios, además de los usuarios individuales a los que se les otorgó acceso explícitamente. |
setStarred(starred) | File | Establece si se destaca File en la unidad de Drive del usuario. |
setTrashed(trashed) | File | Establece si el elemento File está en la papelera de Drive del usuario. |
FileIterator
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getContinuationToken() | String | Obtiene un token que se puede usar para reanudar esta iteración más adelante. |
hasNext() | Boolean | Determina si la llamada a next() mostrará un elemento. |
next() | File | Obtiene el siguiente elemento de la colección de archivos o carpetas. |
Folder
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 de Folder . |
addEditor(user) | Folder | Agrega el usuario determinado a la lista de editores de Folder . |
addEditors(emailAddresses) | Folder | Agrega el array determinado de usuarios a la lista de editores de Folder . |
addViewer(emailAddress) | Folder | Agrega el usuario específico a la lista de lectores de Folder . |
addViewer(user) | Folder | Agrega el usuario específico a la lista de lectores de Folder . |
addViewers(emailAddresses) | Folder | Agrega el array determinado de usuarios 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 y el contenido proporcionados. |
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 determinado. |
createShortcut(targetId) | File | Crea un acceso directo al ID de 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 del Folder . |
getEditors() | User[] | Obtiene la lista de editores de este Folder . |
getFiles() | FileIterator | Obtiene una colección de todos los archivos que son 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 el nombre determinado. |
getFilesByType(mimeType) | FileIterator | Obtiene una colección de todos los archivos que son secundarios de la carpeta actual y tienen el 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 del Folder . |
getLastUpdated() | Date | Obtiene la fecha de la última actualización del Folder . |
getName() | String | Obtiene el nombre del Folder . |
getOwner() | User | Obtiene el propietario de este Folder . |
getParents() | FolderIterator | Obtiene una colección de carpetas que son elementos superiores inmediatos de Folder . |
getResourceKey() | String | Obtiene la clave de recurso del Folder que se requiere para acceder a los elementos que
se compartieron mediante un vínculo. |
getSecurityUpdateEligible() | Boolean | 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. |
getSecurityUpdateEnabled() | Boolean | Obtiene si este Folder requiere una clave de recurso para acceder cuando es
compartida mediante un vínculo. |
getSharingAccess() | Access | 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. |
getSharingPermission() | Permission | 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. |
getSize() | Integer | Obtiene la cantidad de bytes usados para almacenar el Folder en Drive. |
getUrl() | String | Obtiene 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() | Boolean | Determina si los usuarios con permisos de edición para Folder pueden hacer lo siguiente:
compartir con otros usuarios ni cambiar los permisos. |
isStarred() | Boolean | Determina si se destacó Folder en la unidad de Drive del usuario. |
isTrashed() | Boolean | Determina si Folder está en la papelera 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 de Folder . |
removeEditor(user) | Folder | Quita al usuario determinado de la lista de editores de Folder . |
removeViewer(emailAddress) | Folder | Quita al usuario específico de la lista de lectores y comentaristas de Folder . |
removeViewer(user) | Folder | Quita al usuario específico de la lista de lectores y comentaristas de 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 que son secundarios de la carpeta actual y que coinciden con la búsqueda determinada. con tus criterios. |
searchFolders(params) | FolderIterator | 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. |
setDescription(description) | Folder | Establece la descripción del 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 es
compartida mediante un vínculo. |
setShareableByEditors(shareable) | Folder | Establece si los usuarios con permisos de edición en Folder pueden compartir contenido
con otros usuarios o cambiar los permisos. |
setSharing(accessType, permissionType) | Folder | 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. |
setStarred(starred) | Folder | Establece si se destaca Folder en la unidad de Drive del usuario. |
setTrashed(trashed) | Folder | Establece si el elemento Folder está en la papelera de Drive del usuario. |
FolderIterator
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getContinuationToken() | String | Obtiene un token que se puede usar para reanudar esta iteración más adelante. |
hasNext() | Boolean | Determina si la llamada a next() mostrará un elemento. |
next() | Folder | Obtiene el siguiente elemento de la colección de archivos o carpetas. |
Permission
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
VIEW | Enum | Los usuarios que tengan acceso al archivo o a la carpeta solo podrán verlo o copiarlo. |
EDIT | Enum | Los usuarios con acceso al archivo o a la carpeta pueden editarlo. |
COMMENT | Enum | Los usuarios que tengan acceso al archivo o a la carpeta solo podrán verlo, copiarlo o comentarlo. |
OWNER | Enum | El usuario es propietario del archivo o la carpeta. |
ORGANIZER | Enum | Usuarios que pueden organizar archivos y carpetas dentro de una unidad compartida. |
FILE_ORGANIZER | Enum | Usuarios que pueden editar, enviar a la papelera y mover contenido de una unidad compartida. |
NONE | Enum | El usuario no tiene ningún permiso para el archivo o la carpeta. |
User
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
getDomain() | String | Obtiene el nombre de dominio asociado con la cuenta del usuario. |
getEmail() | String | Obtiene la dirección de correo electrónico del usuario. |
getName() | String | Obtiene el nombre del usuario. |
getPhotoUrl() | String | Obtiene la URL de la foto del usuario. |