Drive Service

Drive

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:

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

NombreDescripción breve
AccessEs 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.
DriveAppPermite que las secuencias de comandos creen, encuentren y modifiquen archivos y carpetas en Google Drive.
FileUn archivo en Google Drive.
FileIteratorUn iterador que permite que las secuencias de comandos iteren sobre una colección potencialmente grande de archivos.
FolderUna carpeta de Google Drive
FolderIteratorEs un objeto que permite que las secuencias de comandos iteren sobre una colección potencialmente grande de carpetas.
PermissionEs 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.
UserUn usuario asociado con un archivo en Google Drive.

Access

Propiedades

PropiedadTipoDescripción
ANYONEEnumCualquier persona en Internet puede encontrarlo y acceder a él.
ANYONE_WITH_LINKEnumCualquier persona que tenga el vínculo puede acceder a él.
DOMAINEnumLas personas de tu dominio pueden encontrarlo y acceder a él.
DOMAIN_WITH_LINKEnumPueden acceder las personas de tu dominio que tengan el vínculo.
PRIVATEEnumSolo pueden acceder las personas a las que se les otorgó el permiso explícito.

DriveApp

Propiedades

PropiedadTipoDescripción
AccessAccessEs 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.
PermissionPermissionEs 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étodoTipo de datos que se muestraDescripción breve
continueFileIterator(continuationToken)FileIteratorReanuda una iteración de archivo con un token de Continuation de un iterador anterior.
continueFolderIterator(continuationToken)FolderIteratorReanuda una iteración de carpetas con un token de Continuation de un iterador anterior.
createFile(blob)FileCrea un archivo en la raíz de Drive del usuario a partir de un Blob determinado de datos arbitrarios.
createFile(name, content)FileCrea un archivo de texto en la raíz de Drive del usuario con el nombre y el contenido especificados.
createFile(name, content, mimeType)FileCrea un archivo en la raíz de Drive del usuario con el nombre, el contenido y el tipo de MIME especificados.
createFolder(name)FolderCrea una carpeta en la raíz de la unidad de Drive del usuario con el nombre indicado.
createShortcut(targetId)FileCrea un acceso directo al ID de elemento de Drive proporcionado y lo muestra.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrea un atajo al ID de elemento y la clave de recurso de Drive proporcionados, y lo muestra.
enforceSingleParent(value)voidHabilita o inhabilita el comportamiento de enforceSingleParent para todas las llamadas que afectan a los elementos superiores.
getFileById(id)FileObtiene el archivo con el ID determinado.
getFileByIdAndResourceKey(id, resourceKey)FileObtiene el archivo con el ID y la clave de recurso determinados.
getFiles()FileIteratorObtiene una colección de todos los archivos de Drive del usuario.
getFilesByName(name)FileIteratorObtiene una colección de todos los archivos de la unidad de Drive del usuario que tengan el nombre determinado.
getFilesByType(mimeType)FileIteratorObtiene una colección de todos los archivos de la unidad del usuario que tienen el tipo MIME determinado.
getFolderById(id)FolderObtiene la carpeta con el ID determinado.
getFolderByIdAndResourceKey(id, resourceKey)FolderObtiene la carpeta con el ID y la clave de recursos determinados.
getFolders()FolderIteratorObtiene una colección de todas las carpetas de la unidad del usuario.
getFoldersByName(name)FolderIteratorObtiene una colección de todas las carpetas de Drive del usuario que tienen el nombre determinado.
getRootFolder()FolderObtiene la carpeta en la raíz de la unidad de Drive del usuario.
getStorageLimit()IntegerObtiene la cantidad de bytes que el usuario puede almacenar en Drive.
getStorageUsed()IntegerObtiene la cantidad de bytes que el usuario almacena actualmente en Drive.
getTrashedFiles()FileIteratorObtiene una colección de todos los archivos de la papelera de Drive del usuario.
getTrashedFolders()FolderIteratorObtiene una colección de todas las carpetas de la papelera de Drive del usuario.
searchFiles(params)FileIteratorObtiene 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)FolderIteratorObtiene 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étodoTipo de datos que se muestraDescripción breve
addCommenter(emailAddress)FileAgrega al usuario determinado a la lista de comentaristas de File.
addCommenter(user)FileAgrega al usuario determinado a la lista de comentaristas de File.
addCommenters(emailAddresses)FileAgrega el array de usuarios determinado a la lista de comentaristas de File.
addEditor(emailAddress)FileAgrega el usuario especificado a la lista de editores de File.
addEditor(user)FileAgrega el usuario especificado a la lista de editores de File.
addEditors(emailAddresses)FileAgrega el array de usuarios determinado a la lista de editores de File.
addViewer(emailAddress)FileAgrega al usuario determinado a la lista de usuarios de File.
addViewer(user)FileAgrega al usuario determinado a la lista de usuarios de File.
addViewers(emailAddresses)FileAgrega el array de usuarios determinado a la lista de usuarios de File.
getAccess(email)PermissionObtiene el permiso otorgado a un usuario específico.
getAccess(user)PermissionObtiene el permiso otorgado a un usuario específico.
getAs(contentType)BlobMuestra los datos dentro de este objeto como un blob convertido al tipo de contenido especificado.
getBlob()BlobDevuelve los datos dentro de este objeto como un blob.
getDateCreated()DateObtiene la fecha en la que se creó el File.
getDescription()StringObtiene la descripción de File.
getDownloadUrl()StringObtiene la URL que se puede usar para descargar el archivo.
getEditors()User[]Obtiene la lista de editores de este File.
getId()StringObtiene el ID del File.
getLastUpdated()DateObtiene la fecha en que se actualizó File por última vez.
getMimeType()StringObtiene el tipo MIME del archivo.
getName()StringObtiene el nombre de File.
getOwner()UserObtiene el propietario del archivo.
getParents()FolderIteratorObtiene una colección de carpetas que son superiores inmediatas de File.
getResourceKey()StringObtiene la clave de recurso del File que se requiere para acceder a los elementos que se compartieron con un vínculo.
getSecurityUpdateEligible()BooleanObtiene 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()BooleanObtiene si este File requiere una clave de recurso para el acceso cuando se comparte con un vínculo.
getSharingAccess()AccessObtiene 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()PermissionObtiene 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()IntegerObtiene la cantidad de bytes que se usan para almacenar el File en Drive.
getTargetId()StringSi se trata de un atajo, muestra el ID del elemento al que apunta.
getTargetMimeType()StringSi se trata de un atajo, muestra el tipo mime del elemento al que apunta.
getTargetResourceKey()StringSi el archivo es un atajo, muestra la clave de recurso del elemento al que apunta.
getThumbnail()BlobObtiene una imagen en miniatura del archivo o null si no existe una miniatura.
getUrl()StringObtiene 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()BooleanDetermina si los usuarios con permisos de edición en File pueden compartir con otros usuarios o cambiar los permisos.
isStarred()BooleanDetermina si el File se marcó como favorito en Drive del usuario.
isTrashed()BooleanDetermina si el File está en la papelera de Drive del usuario.
makeCopy()FileCrea una copia del archivo.
makeCopy(destination)FileCrea una copia del archivo en el directorio de destino.
makeCopy(name)FileCrea una copia del archivo y asígnale el nombre proporcionado.
makeCopy(name, destination)FileCrea una copia del archivo en el directorio de destino y le asigna el nombre proporcionado.
moveTo(destination)FileMueve este elemento a la carpeta de destino proporcionada.
removeCommenter(emailAddress)FileQuita al usuario determinado de la lista de comentaristas de File.
removeCommenter(user)FileQuita al usuario determinado de la lista de comentaristas de File.
removeEditor(emailAddress)FileQuita al usuario determinado de la lista de editores de File.
removeEditor(user)FileQuita al usuario determinado de la lista de editores de File.
removeViewer(emailAddress)FileQuita al usuario determinado de la lista de usuarios y comentaristas de File.
removeViewer(user)FileQuita al usuario determinado de la lista de usuarios y comentaristas de File.
revokePermissions(emailAddress)FileRevoca el acceso a File otorgado al usuario determinado.
revokePermissions(user)FileRevoca el acceso a File otorgado al usuario determinado.
setContent(content)FileReemplaza el contenido del archivo por un reemplazo determinado.
setDescription(description)FileEstablece la descripción de File.
setName(name)FileEstablece el nombre del File.
setOwner(emailAddress)FileCambia el propietario de File.
setOwner(user)FileCambia el propietario de File.
setSecurityUpdateEnabled(enabled)FileEstablece si File requiere una clave de recurso para el acceso cuando se comparte con un vínculo.
setShareableByEditors(shareable)FileEstablece si los usuarios con permisos de edición en File pueden compartir con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FileEstablece 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)FileEstablece si la File se marcará como favorita en Drive del usuario.
setTrashed(trashed)FileEstablece si el File está en la papelera de Drive del usuario.

FileIterator

Métodos

MétodoTipo de datos que se muestraDescripción breve
getContinuationToken()StringObtiene un token que se puede usar para reanudar esta iteración más adelante.
hasNext()BooleanDetermina si llamar a next() mostrará un elemento.
next()FileObtiene el siguiente elemento de la colección de archivos o carpetas.

Folder

Métodos

MétodoTipo de datos que se muestraDescripción breve
addEditor(emailAddress)FolderAgrega el usuario especificado a la lista de editores de Folder.
addEditor(user)FolderAgrega el usuario especificado a la lista de editores de Folder.
addEditors(emailAddresses)FolderAgrega el array de usuarios determinado a la lista de editores de Folder.
addViewer(emailAddress)FolderAgrega al usuario determinado a la lista de usuarios de Folder.
addViewer(user)FolderAgrega al usuario determinado a la lista de usuarios de Folder.
addViewers(emailAddresses)FolderAgrega el array de usuarios determinado a la lista de usuarios 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 especificados.
createFile(name, content, mimeType)FileCrea un archivo en la carpeta actual con el nombre, el contenido y el tipo MIME especificados.
createFolder(name)FolderCrea una carpeta en la carpeta actual con el nombre indicado.
createShortcut(targetId)FileCrea un acceso directo al ID de elemento de Drive proporcionado y lo muestra.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrea un atajo al ID de elemento y la clave de recurso de Drive proporcionados, y lo muestra.
getAccess(email)PermissionObtiene el permiso otorgado a un usuario específico.
getAccess(user)PermissionObtiene el permiso otorgado a un usuario específico.
getDateCreated()DateObtiene la fecha en la que se creó el Folder.
getDescription()StringObtiene la descripción de 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 que tienen el tipo 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 el nombre determinado.
getId()StringObtiene el ID del Folder.
getLastUpdated()DateObtiene la fecha en que se actualizó Folder por última vez.
getName()StringObtiene el nombre de Folder.
getOwner()UserObtiene el propietario de este Folder.
getParents()FolderIteratorObtiene una colección de carpetas que son superiores inmediatas de Folder.
getResourceKey()StringObtiene la clave de recurso del Folder que se requiere para acceder a los elementos que se compartieron con un vínculo.
getSecurityUpdateEligible()BooleanObtiene si este Folder es apto para aplicar la actualización de seguridad que requiere una clave de recurso para el acceso cuando se comparte con un vínculo.
getSecurityUpdateEnabled()BooleanObtiene si este Folder requiere una clave de recurso para el acceso cuando se comparte con un vínculo.
getSharingAccess()AccessObtiene 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()PermissionObtiene el permiso otorgado a los usuarios que pueden acceder a Folder, además de los usuarios individuales a los que se les otorgó acceso de forma explícita.
getSize()IntegerObtiene la cantidad de bytes que se usan para almacenar el Folder en Drive.
getUrl()StringObtiene 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()BooleanDetermina si los usuarios con permisos de edición en Folder pueden compartir con otros usuarios o cambiar los permisos.
isStarred()BooleanDetermina si el Folder se marcó como favorito en Drive del usuario.
isTrashed()BooleanDetermina si el 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 determinado de la lista de usuarios y comentaristas de Folder.
removeViewer(user)FolderQuita al usuario determinado de la lista de usuarios y comentaristas de Folder.
revokePermissions(emailAddress)FolderRevoca el acceso a Folder otorgado al usuario determinado.
revokePermissions(user)FolderRevoca el acceso a 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 los criterios de búsqueda determinados.
searchFolders(params)FolderIteratorObtiene 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)FolderEstablece la descripción de Folder.
setName(name)FolderEstablece el nombre del Folder.
setOwner(emailAddress)FolderCambia el propietario de Folder.
setOwner(user)FolderCambia el propietario de Folder.
setSecurityUpdateEnabled(enabled)FolderEstablece si Folder requiere una clave de recurso para el acceso cuando se comparte con un vínculo.
setShareableByEditors(shareable)FolderEstablece si los usuarios con permisos de edición en Folder pueden compartir con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FolderEstablece qué clase de usuarios puede acceder a Folder y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso de forma explícita.
setStarred(starred)FolderEstablece si la Folder se marcará como favorita en Drive del usuario.
setTrashed(trashed)FolderEstablece si el Folder está en la papelera de Drive del usuario.

FolderIterator

Métodos

MétodoTipo de datos que se muestraDescripción breve
getContinuationToken()StringObtiene un token que se puede usar para reanudar esta iteración más adelante.
hasNext()BooleanDetermina si llamar a next() mostrará un elemento.
next()FolderObtiene el siguiente elemento de la colección de archivos o carpetas.

Permission

Propiedades

PropiedadTipoDescripción
VIEWEnumLos usuarios que pueden acceder al archivo o la carpeta solo pueden verlos o copiarlos.
EDITEnumLos usuarios que pueden acceder al archivo o la carpeta pueden editarlo.
COMMENTEnumLos usuarios que pueden acceder al archivo o la carpeta solo pueden verlos, copiarlos o comentarlos.
OWNEREnumEl usuario es el propietario del archivo o la carpeta.
ORGANIZEREnumSon usuarios que pueden organizar archivos y carpetas dentro de una unidad compartida.
FILE_ORGANIZEREnumSon los usuarios que pueden editar, mover a la papelera y mover contenido dentro de una unidad compartida.
NONEEnumEl usuario no tiene ningún permiso para el archivo o la carpeta.

User

Métodos

MétodoTipo de datos que se muestraDescripción breve
getDomain()StringObtiene el nombre de dominio asociado con la cuenta del usuario.
getEmail()StringObtiene la dirección de correo electrónico del usuario.
getName()StringObtiene el nombre del usuario.
getPhotoUrl()StringObtiene la URL de la foto del usuario.