Drive Service

Drive

Este servicio permite que las secuencias de comandos creen, encuentren y modifiquen archivos y carpetas en Google Drive.

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

Clases

NombreDescripción breve
AccessUna enumeración que representa clases de usuarios que pueden acceder a un archivo o una carpeta, además de cualquier usuario individual al que se le haya otorgado 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 en una colección de archivos potencialmente grande.
FolderUna carpeta en Google Drive.
FolderIteratorObjeto que permite a las secuencias de comandos iterar en una gran colección de carpetas.
PermissionUna 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.
UserUn usuario asociado con un archivo en Google Drive.

Access

Propiedades

PropiedadTipoDescripción
ANYONEEnumCualquier persona en Internet puede encontrar el elemento y acceder a él.
ANYONE_WITH_LINKEnumCualquier persona que tenga el vínculo puede acceder a él.
DOMAINEnumLos miembros de su dominio pueden encontrar el elemento y acceder a él.
DOMAIN_WITH_LINKEnumPueden acceder las personas de su 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
AccessAccessUna enumeración que representa clases de usuarios que pueden acceder a un archivo o una carpeta, además de cualquier usuario individual al que se le haya otorgado acceso de forma explícita.
PermissionPermissionUna 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étodoTipo de datos que se muestraDescripción breve
continueFileIterator(continuationToken)FileIteratorReanuda una iteración de archivo con un token de continuación de un iterador anterior.
continueFolderIterator(continuationToken)FolderIteratorReanuda la iteración de una carpeta con un token de continuación de un iterador anterior.
createFile(blob)FileCrea 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)FileCrea un archivo de texto en la raíz de la unidad de Drive del usuario con el nombre y el contenido proporcionados.
createFile(name, content, mimeType)FileCrea 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)FolderCrea una carpeta en la raíz de la unidad de Drive del usuario con el nombre determinado.
createShortcut(targetId)FileCrea un acceso directo al ID de elemento de Drive proporcionado y lo muestra.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrea un acceso directo al ID de elemento de Drive y a la clave de recurso proporcionados, y los muestra.
enforceSingleParent(value)voidHabilita o inhabilita el comportamiento de aplicación única para todas las llamadas que afecten 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 proporcionados.
getFiles()FileIteratorObtiene una colección de todos los archivos en la unidad de Drive del usuario.
getFilesByName(name)FileIteratorObtiene una colección de todos los archivos en la unidad de Drive del usuario que tienen el nombre.
getFilesByType(mimeType)FileIteratorObtiene una colección de todos los archivos en la unidad de Drive del usuario que tienen el tipo de MIME dado.
getFolderById(id)FolderObtiene la carpeta con el ID determinado.
getFolderByIdAndResourceKey(id, resourceKey)FolderObtiene la carpeta con el ID y la clave de recurso proporcionados.
getFolders()FolderIteratorObtiene una colección de todas las carpetas en la unidad de Drive del usuario.
getFoldersByName(name)FolderIteratorObtiene una colección de todas las carpetas de Drive del usuario que tienen el nombre especificado.
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 la unidad de Drive del usuario.
getTrashedFolders()FolderIteratorObtiene una colección de todas las carpetas de la papelera de la unidad de Drive del usuario.
searchFiles(params)FileIteratorObtiene una colección de todos los archivos en 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 en la unidad de Drive 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 el usuario determinado a la lista de comentaristas de File.
addCommenter(user)FileAgrega el usuario determinado a la lista de comentaristas de File.
addCommenters(emailAddresses)FileAgrega el array de usuarios determinado a la lista de comentaristas para File.
addEditor(emailAddress)FileAgrega el usuario determinado a la lista de editores de File.
addEditor(user)FileAgrega el usuario determinado 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 el usuario determinado a la lista de lectores de File.
addViewer(user)FileAgrega el usuario determinado a la lista de lectores de File.
addViewers(emailAddresses)FileAgrega el array de usuarios determinado a la lista de lectores de File.
getAccess(email)PermissionObtiene el permiso otorgado al usuario determinado.
getAccess(user)PermissionObtiene el permiso otorgado al usuario determinado.
getAs(contentType)BlobMuestra los datos de este objeto como un BLOB convertido al tipo de contenido especificado.
getBlob()BlobMuestra 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 de File.
getLastUpdated()DateObtiene la fecha de la última actualización de File.
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 inmediatamente de File.
getResourceKey()StringObtiene la clave de recurso del File que se requiere para acceder a los elementos que se compartieron mediante un vínculo.
getSecurityUpdateEligible()BooleanObtiene si 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()BooleanObtiene si File requiere una clave de recurso para acceder cuando se comparte mediante un vínculo.
getSharingAccess()AccessObtiene la clase de usuarios que puede acceder al File, además de cualquier usuario individual al que se le haya otorgado acceso de forma explícita.
getSharingPermission()PermissionObtiene el permiso que se otorga a los usuarios que pueden acceder a File, además de cualquier usuario individual al que se le haya otorgado acceso de forma explícita.
getSize()IntegerObtiene la cantidad de bytes que se usan para almacenar File en Drive.
getTargetId()StringSi se trata de un acceso directo, muestra el ID del elemento al que apunta.
getTargetMimeType()StringSi se trata de un acceso directo, muestra el tipo MIME del elemento al que apunta.
getTargetResourceKey()StringSi el archivo es un acceso directo, muestra la clave del recurso del elemento al que apunta.
getThumbnail()BlobObtiene una imagen en miniatura para el archivo o null si no existe.
getUrl()StringObtiene 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()BooleanDetermina si los usuarios con permisos de edición en File pueden compartir con otros usuarios o cambiar los permisos.
isStarred()BooleanDetermina si File se destacó en la unidad de Drive del usuario.
isTrashed()BooleanDetermina si el File está en la papelera de la unidad 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 la nombra con el nombre proporcionado.
makeCopy(name, destination)FileCrea una copia del archivo en el directorio de destino y le asigna un nombre con el nombre proporcionado.
moveTo(destination)FileMueve este elemento a la carpeta de destino proporcionada.
removeCommenter(emailAddress)FileQuita el usuario determinado de la lista de comentaristas para File.
removeCommenter(user)FileQuita el usuario determinado de la lista de comentaristas para File.
removeEditor(emailAddress)FileQuita el usuario determinado de la lista de editores de File.
removeEditor(user)FileQuita el usuario determinado de la lista de editores de File.
removeViewer(emailAddress)FileQuita el usuario determinado de la lista de lectores y comentaristas del File.
removeViewer(user)FileQuita el usuario determinado de la lista de lectores y comentaristas del File.
revokePermissions(emailAddress)FileRevoca el acceso a la File otorgada al usuario determinado.
revokePermissions(user)FileRevoca el acceso a la File otorgada al usuario determinado.
setContent(content)FileReemplaza el contenido del archivo por un reemplazo determinado.
setDescription(description)FileEstablece la descripción para File.
setName(name)FileEstablece el nombre de File.
setOwner(emailAddress)FileCambia el propietario de File.
setOwner(user)FileCambia el propietario de File.
setSecurityUpdateEnabled(enabled)FileConfigura si File requiere una clave de recurso para acceder cuando se comparte mediante un vínculo.
setShareableByEditors(shareable)FileConfigura si los usuarios con permisos de edición para File pueden compartir contenido con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FileEstablece qué clase de usuarios pueden acceder a File y qué permisos se les otorgan, además de los usuarios individuales a los que se les otorgó acceso explícito.
setStarred(starred)FileEstablece si File se destaca en la unidad de Drive del usuario.
setTrashed(trashed)FileEstablece si el File está en la papelera de la unidad 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 se llama a next() para mostrar un elemento.
next()FileObtiene el siguiente elemento en la colección de archivos o carpetas.

Folder

Métodos

MétodoTipo de datos que se muestraDescripción breve
addEditor(emailAddress)FolderAgrega el usuario determinado a la lista de editores de Folder.
addEditor(user)FolderAgrega el usuario determinado a la lista de editores de Folder.
addEditors(emailAddresses)FolderAgrega el array de usuarios determinado a la lista de editores de Folder.
addViewer(emailAddress)FolderAgrega el usuario determinado a la lista de lectores de Folder.
addViewer(user)FolderAgrega el usuario determinado a la lista de lectores de Folder.
addViewers(emailAddresses)FolderAgrega el array de usuarios determinado a la lista de lectores 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 de MIME especificados.
createFolder(name)FolderCrea una carpeta en la carpeta actual con el nombre determinado.
createShortcut(targetId)FileCrea un acceso directo al ID de elemento de Drive proporcionado y lo muestra.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrea un acceso directo al ID de elemento de Drive y a la clave de recurso proporcionados, y los muestra.
getAccess(email)PermissionObtiene el permiso otorgado al usuario determinado.
getAccess(user)PermissionObtiene el permiso otorgado al usuario determinado.
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 de MIME determinado.
getFolders()FolderIteratorObtiene una colección de todas las carpetas que son secundarias de la carpeta actual.
getFoldersByName(name)FolderIteratorObtiene una colección de todas las carpetas que son secundarias de la carpeta actual y tienen el nombre determinado.
getId()StringObtiene el ID de Folder.
getLastUpdated()DateObtiene la fecha de la última actualización de Folder.
getName()StringObtiene el nombre de Folder.
getOwner()UserObtiene el propietario de Folder.
getParents()FolderIteratorObtiene una colección de carpetas que son superiores inmediatamente de Folder.
getResourceKey()StringObtiene la clave de recurso del Folder que se requiere para acceder a los elementos que se compartieron mediante un vínculo.
getSecurityUpdateEligible()BooleanObtiene si Folder es apto para aplicar la actualización de seguridad que requiere una clave de recurso para acceder cuando se comparte mediante un vínculo.
getSecurityUpdateEnabled()BooleanObtiene si Folder requiere una clave de recurso para acceder cuando se comparte mediante un vínculo.
getSharingAccess()AccessObtiene la clase de usuarios que puede acceder al Folder, además de cualquier usuario individual al que se le haya otorgado acceso de forma explícita.
getSharingPermission()PermissionObtiene el permiso que se otorga a los usuarios que pueden acceder a Folder, además de cualquier usuario individual al que se le haya otorgado acceso de forma explícita.
getSize()IntegerObtiene la cantidad de bytes que se usan para almacenar Folder en Drive.
getUrl()StringObtiene la URL que se puede usar para abrir Folder en una app de Google, como Drive o Documentos.
getViewers()User[]Obtiene la lista de lectores y comentaristas de este Folder.
isShareableByEditors()BooleanDetermina si los usuarios con permisos de edición en Folder pueden compartir con otros usuarios o cambiar los permisos.
isStarred()BooleanDetermina si Folder se destacó en la unidad de Drive del usuario.
isTrashed()BooleanDetermina si el Folder está en la papelera de la unidad de Drive del usuario.
moveTo(destination)FolderMueve este elemento a la carpeta de destino proporcionada.
removeEditor(emailAddress)FolderQuita el usuario determinado de la lista de editores de Folder.
removeEditor(user)FolderQuita el usuario determinado de la lista de editores de Folder.
removeViewer(emailAddress)FolderQuita el usuario determinado de la lista de lectores y comentaristas del Folder.
removeViewer(user)FolderQuita el usuario determinado de la lista de lectores y comentaristas del Folder.
revokePermissions(emailAddress)FolderRevoca el acceso a la Folder otorgada al usuario determinado.
revokePermissions(user)FolderRevoca el acceso a la Folder otorgada al usuario determinado.
searchFiles(params)FileIteratorObtiene una colección de todos los archivos que son secundarios de la carpeta actual y coinciden con los criterios de búsqueda dados.
searchFolders(params)FolderIteratorObtiene una colección de todas las carpetas que son secundarias de la carpeta actual y coinciden con los criterios de búsqueda dados.
setDescription(description)FolderEstablece la descripción para Folder.
setName(name)FolderEstablece el nombre de Folder.
setOwner(emailAddress)FolderCambia el propietario de Folder.
setOwner(user)FolderCambia el propietario de Folder.
setSecurityUpdateEnabled(enabled)FolderConfigura si Folder requiere una clave de recurso para acceder cuando se comparte mediante un vínculo.
setShareableByEditors(shareable)FolderConfigura si los usuarios con permisos de edición para Folder pueden compartir contenido con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FolderEstablece 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 explícito.
setStarred(starred)FolderEstablece si Folder se destaca en la unidad de Drive del usuario.
setTrashed(trashed)FolderEstablece si el Folder está en la papelera de la unidad 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 se llama a next() para mostrar un elemento.
next()FolderObtiene el siguiente elemento en la colección de archivos o carpetas.

Permission

Propiedades

PropiedadTipoDescripción
VIEWEnumLos usuarios que tengan acceso al archivo o a la carpeta solo podrán verlo o copiarlo.
EDITEnumLos usuarios que pueden acceder al archivo o a la carpeta pueden editarlo.
COMMENTEnumLos usuarios que pueden acceder al archivo o a la carpeta solo pueden verlo, copiarlo o comentarlo.
OWNEREnumEl usuario es propietario del archivo o la carpeta.
ORGANIZEREnumUsuarios que pueden organizar archivos y carpetas en una unidad compartida.
FILE_ORGANIZEREnumUsuarios que pueden editar, enviar a la papelera y mover el contenido a 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 a 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 para la foto del usuario.