Este servicio permite que las secuencias de comandos creen, encuentren y modifiquen archivos y carpetas en Google Drive.
Si tu secuencia de comandos usa un proyecto de Cloud estándar en lugar de un proyecto de Cloud predeterminado, debes activar la API de Drive de forma manual. En tu proyecto estándar de Cloud, activa la API de Drive:
En la siguiente muestra de código, se muestra cómo registrar los nombres de cada archivo en la carpeta de Mi unidad del usuario:// 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 | Es una enumeración que representa clases de usuarios que pueden acceder a un archivo o una carpeta, además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
DriveApp | Permite que las secuencias de comandos creen, encuentren y modifiquen archivos y carpetas en Google Drive. |
File | Un archivo en Google Drive. |
FileIterator | Un iterador que permite que las secuencias de comandos iteren sobre una colección potencialmente grande de archivos. |
Folder | Una carpeta de Google Drive |
FolderIterator | Es un objeto que permite que las secuencias de comandos iteren sobre una colección potencialmente grande de carpetas. |
Permission | Es una enumeración que representa los permisos otorgados a los usuarios que pueden acceder a un archivo o una carpeta, además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
User | Un usuario asociado con un archivo en Google Drive. |
Access
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
ANYONE | Enum | Cualquier persona en Internet puede encontrarlo y acceder a él. |
ANYONE_WITH_LINK | Enum | Cualquier persona que tenga el vínculo puede acceder a él. |
DOMAIN | Enum | Las personas de tu dominio pueden encontrarlo 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 | Es una enumeración que representa clases de usuarios que pueden acceder a un archivo o una carpeta, además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
Permission | Permission | Es una enumeración que representa los permisos otorgados a los usuarios que pueden acceder a un archivo o una carpeta, además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
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 Continuation de un iterador anterior. |
continueFolderIterator(continuationToken) | FolderIterator | Reanuda una iteración de carpetas con un token de Continuation de un iterador anterior. |
createFile(blob) | File | Crea un archivo en la raíz 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 Drive del usuario con el nombre y el contenido especificados. |
createFile(name, content, mimeType) | File | Crea un archivo en la raíz 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 indicado. |
createShortcut(targetId) | File | Crea un acceso directo al ID de elemento de Drive proporcionado y lo muestra. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Crea un atajo al ID de elemento y la clave de recurso de Drive proporcionados, y lo muestra. |
enforceSingleParent(value) | void | Habilita o inhabilita el comportamiento de enforceSingleParent para todas las llamadas que afectan 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 determinados. |
getFiles() | FileIterator | Obtiene una colección de todos los archivos de Drive del usuario. |
getFilesByName(name) | FileIterator | Obtiene una colección de todos los archivos de la unidad de Drive del usuario que tengan el nombre determinado. |
getFilesByType(mimeType) | FileIterator | Obtiene una colección de todos los archivos de la unidad del usuario que tienen el tipo 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 recursos determinados. |
getFolders() | FolderIterator | Obtiene una colección de todas las carpetas de la unidad del usuario. |
getFoldersByName(name) | FolderIterator | Obtiene una colección de todas las carpetas 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 almacena actualmente en Drive. |
getTrashedFiles() | FileIterator | Obtiene una colección de todos los archivos de la papelera 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 los criterios de búsqueda determinados. |
searchFolders(params) | FolderIterator | Obtiene una colección de todas las carpetas de la unidad del usuario que coinciden con los criterios de búsqueda determinados. |
File
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addCommenter(emailAddress) | File | Agrega al usuario determinado a la lista de comentaristas de File . |
addCommenter(user) | File | Agrega al usuario determinado 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 especificado a la lista de editores de File . |
addEditor(user) | File | Agrega el usuario especificado a la lista de editores de File . |
addEditors(emailAddresses) | File | Agrega el array de usuarios determinado a la lista de editores de File . |
addViewer(emailAddress) | File | Agrega al usuario determinado a la lista de usuarios de File . |
addViewer(user) | File | Agrega al usuario determinado a la lista de usuarios de File . |
addViewers(emailAddresses) | File | Agrega el array de usuarios determinado a la lista de usuarios de File . |
getAccess(email) | Permission | Obtiene el permiso otorgado a un usuario específico. |
getAccess(user) | Permission | Obtiene el permiso otorgado a un usuario específico. |
getAs(contentType) | Blob | Muestra los datos dentro de este objeto como un blob convertido al tipo de contenido especificado. |
getBlob() | Blob | Devuelve los datos dentro de este objeto como un blob. |
getDateCreated() | Date | Obtiene la fecha en la que se creó el File . |
getDescription() | String | Obtiene la descripción de 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 en que se actualizó File por última vez. |
getMimeType() | String | Obtiene el tipo MIME del archivo. |
getName() | String | Obtiene el nombre de File . |
getOwner() | User | Obtiene el propietario del archivo. |
getParents() | FolderIterator | Obtiene una colección de carpetas que son superiores inmediatas de File . |
getResourceKey() | String | Obtiene la clave de recurso del File que se requiere para acceder a los elementos que se compartieron con un vínculo. |
getSecurityUpdateEligible() | Boolean | Obtiene si este File es apto para aplicar la actualización de seguridad que requiere una clave de recurso para el acceso cuando se comparte con un vínculo. |
getSecurityUpdateEnabled() | Boolean | Obtiene si este File requiere una clave de recurso para el acceso cuando se comparte con un vínculo. |
getSharingAccess() | Access | Obtiene qué clase de usuarios puede acceder a File , además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
getSharingPermission() | Permission | Obtiene el permiso otorgado a los usuarios que pueden acceder a File , además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
getSize() | Integer | Obtiene la cantidad de bytes que se usan para almacenar el File en Drive. |
getTargetId() | String | Si se trata de un atajo, muestra el ID del elemento al que apunta. |
getTargetMimeType() | String | Si se trata de un atajo, muestra el tipo mime del elemento al que apunta. |
getTargetResourceKey() | String | Si el archivo es un atajo, muestra la clave de recurso del elemento al que apunta. |
getThumbnail() | Blob | Obtiene una imagen en miniatura del archivo o null si no existe una miniatura. |
getUrl() | String | Obtiene la URL que se puede usar para abrir el File en una app de Google, como Drive o Documentos. |
getViewers() | User[] | Obtiene la lista de usuarios y comentaristas de este File . |
isShareableByEditors() | Boolean | Determina si los usuarios con permisos de edición en File pueden compartir con otros usuarios o cambiar los permisos. |
isStarred() | Boolean | Determina si el File se marcó como favorito en Drive del usuario. |
isTrashed() | Boolean | Determina si el 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 asígnale 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 determinado de la lista de usuarios y comentaristas de File . |
removeViewer(user) | File | Quita al usuario determinado de la lista de usuarios y comentaristas de File . |
revokePermissions(emailAddress) | File | Revoca el acceso a File otorgado al usuario determinado. |
revokePermissions(user) | File | Revoca el acceso a File otorgado al usuario determinado. |
setContent(content) | File | Reemplaza el contenido del archivo por un reemplazo determinado. |
setDescription(description) | File | Establece la descripción de File . |
setName(name) | File | Establece el nombre del 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 el acceso cuando se comparte con un vínculo. |
setShareableByEditors(shareable) | File | Establece si los usuarios con permisos de edición en File pueden compartir con otros usuarios o cambiar los permisos. |
setSharing(accessType, permissionType) | File | Establece qué clase de usuarios puede acceder a File y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
setStarred(starred) | File | Establece si la File se marcará como favorita en Drive del usuario. |
setTrashed(trashed) | File | Establece si el 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 llamar 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 especificado a la lista de editores de Folder . |
addEditor(user) | Folder | Agrega el usuario especificado a la lista de editores de Folder . |
addEditors(emailAddresses) | Folder | Agrega el array de usuarios determinado a la lista de editores de Folder . |
addViewer(emailAddress) | Folder | Agrega al usuario determinado a la lista de usuarios de Folder . |
addViewer(user) | Folder | Agrega al usuario determinado a la lista de usuarios de Folder . |
addViewers(emailAddresses) | Folder | Agrega el array de usuarios determinado a la lista de usuarios 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 especificados. |
createFile(name, content, mimeType) | File | Crea un archivo en la carpeta actual con el nombre, el contenido y el tipo MIME especificados. |
createFolder(name) | Folder | Crea una carpeta en la carpeta actual con el nombre indicado. |
createShortcut(targetId) | File | Crea un acceso directo al ID de elemento de Drive proporcionado y lo muestra. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Crea un atajo al ID de elemento y la clave de recurso de Drive proporcionados, y lo muestra. |
getAccess(email) | Permission | Obtiene el permiso otorgado a un usuario específico. |
getAccess(user) | Permission | Obtiene el permiso otorgado a un usuario específico. |
getDateCreated() | Date | Obtiene la fecha en la que se creó el Folder . |
getDescription() | String | Obtiene la descripción de 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 que tienen el tipo 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 el nombre determinado. |
getId() | String | Obtiene el ID del Folder . |
getLastUpdated() | Date | Obtiene la fecha en que se actualizó 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 inmediatas de Folder . |
getResourceKey() | String | Obtiene la clave de recurso del Folder que se requiere para acceder a los elementos que se compartieron con 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 el acceso cuando se comparte con un vínculo. |
getSecurityUpdateEnabled() | Boolean | Obtiene si este Folder requiere una clave de recurso para el acceso cuando se comparte con 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 los usuarios que pueden acceder a Folder , además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
getSize() | 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 Folder en una app de Google, como Drive o Documentos. |
getViewers() | User[] | Obtiene la lista de usuarios y comentaristas de este Folder . |
isShareableByEditors() | Boolean | Determina si los usuarios con permisos de edición en Folder pueden compartir con otros usuarios o cambiar los permisos. |
isStarred() | Boolean | Determina si el Folder se marcó como favorito en Drive del usuario. |
isTrashed() | Boolean | Determina si el 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 determinado de la lista de usuarios y comentaristas de Folder . |
removeViewer(user) | Folder | Quita al usuario determinado de la lista de usuarios y comentaristas de Folder . |
revokePermissions(emailAddress) | Folder | Revoca el acceso a Folder otorgado al usuario determinado. |
revokePermissions(user) | Folder | Revoca el acceso a 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 los criterios de búsqueda determinados. |
searchFolders(params) | FolderIterator | Obtiene una colección de todas las carpetas que son secundarias de la carpeta actual y que coinciden con los criterios de búsqueda determinados. |
setDescription(description) | Folder | Establece la descripción de Folder . |
setName(name) | Folder | Establece el nombre del 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 el acceso cuando se comparte con un vínculo. |
setShareableByEditors(shareable) | Folder | Establece si los usuarios con permisos de edición en Folder pueden compartir con otros usuarios o cambiar los permisos. |
setSharing(accessType, permissionType) | Folder | Establece qué clase de usuarios puede acceder a Folder y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso de forma explícita. |
setStarred(starred) | Folder | Establece si la Folder se marcará como favorita en Drive del usuario. |
setTrashed(trashed) | Folder | Establece si el 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 llamar 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 pueden acceder al archivo o la carpeta solo pueden verlos o copiarlos. |
EDIT | Enum | Los usuarios que pueden acceder al archivo o la carpeta pueden editarlo. |
COMMENT | Enum | Los usuarios que pueden acceder al archivo o la carpeta solo pueden verlos, copiarlos o comentarlos. |
OWNER | Enum | El usuario es el propietario del archivo o la carpeta. |
ORGANIZER | Enum | Son usuarios que pueden organizar archivos y carpetas dentro de una unidad compartida. |
FILE_ORGANIZER | Enum | Son los usuarios que pueden editar, mover a la papelera y mover contenido dentro 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. |