Drive Service

Drive

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:

Activar 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

NombreDescripción breve
AccessUna 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.
DriveAppPermite que las secuencias de comandos creen, busquen y modifiquen archivos y carpetas en Google Drive.
FileUn archivo en Google Drive
FileIteratorEs un iterador que permite que las secuencias de comandos iteren en una colección de archivos potencialmente grande.
FolderUna carpeta en Google Drive
FolderIteratorEs un objeto que permite que las secuencias de comandos iteren 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 usuario de Internet puede encontrar el elemento y acceder a él.
ANYONE_WITH_LINKEnumCualquier persona que tenga el vínculo puede acceder al elemento.
DOMAINEnumLos miembros de tu dominio pueden encontrar el elemento 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
AccessAccessUna 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.
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 una iteración de 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 especificados.
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 del elemento de Drive y la clave de recurso proporcionados, y lo muestra.
enforceSingleParent(value)voidHabilita o inhabilita el comportamiento de aplicarSingleParent 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 especificados.
getFiles()FileIteratorObtiene una colección de todos los archivos de la unidad de Drive del usuario.
getFilesByName(name)FileIteratorObtiene una colección de todos los archivos de la unidad de Drive del usuario que tienen el nombre determinado.
getFilesByType(mimeType)FileIteratorObtiene una colección de todos los archivos de la unidad de Drive del usuario que tengan el tipo de MIME determinado.
getFolderById(id)FolderObtiene la carpeta con el ID determinado.
getFolderByIdAndResourceKey(id, resourceKey)FolderObtiene la carpeta con el ID y la clave de recurso especificados.
getFolders()FolderIteratorObtiene una colección de todas las carpetas de la unidad de Drive del usuario.
getFoldersByName(name)FolderIteratorObtiene una colección de todas las carpetas de la unidad 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 está almacenando 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 Drive del usuario.
searchFiles(params)FileIteratorObtiene 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)FolderIteratorObtiene 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étodoTipo de datos que se muestraDescripción breve
addCommenter(emailAddress)FileAgrega el usuario específico a la lista de comentaristas de File.
addCommenter(user)FileAgrega el usuario específico 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 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 determinado de usuarios a la lista de editores de File.
addViewer(emailAddress)FileAgrega el usuario específico a la lista de lectores de File.
addViewer(user)FileAgrega el usuario específico a la lista de lectores de File.
addViewers(emailAddresses)FileAgrega el array determinado de usuarios a la lista de visualizadores 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 dentro 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 que se creó el File.
getDescription()StringObtiene la descripción del 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 de la última actualización del File.
getMimeType()StringObtiene el tipo de MIME del archivo.
getName()StringObtiene el nombre del File.
getOwner()UserObtiene el propietario del archivo.
getParents()FolderIteratorObtiene una colección de carpetas que son elementos superiores inmediatos 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()BooleanDetermina 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()BooleanObtiene si este File requiere una clave de recurso para acceder cuando es compartida mediante un vínculo.
getSharingAccess()AccessObtiene 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()PermissionObtiene 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()IntegerObtiene la cantidad de bytes usados para almacenar el 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 de MIME del elemento al que apunta.
getTargetResourceKey()StringSi el archivo es una combinación de teclas, muestra la clave del recurso del elemento al que apunta.
getThumbnail()BlobObtiene una imagen en miniatura para el archivo o null si no existe una miniatura.
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 para File pueden hacer lo siguiente: compartir con otros usuarios ni cambiar los permisos.
isStarred()BooleanDetermina si se destacó File en la unidad de Drive del usuario.
isTrashed()BooleanDetermina si 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 le asigna 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 específico de la lista de lectores y comentaristas de File.
removeViewer(user)FileQuita al usuario específico de la lista de lectores y comentaristas de File.
revokePermissions(emailAddress)FileRevoca el acceso al File otorgado al usuario determinado.
revokePermissions(user)FileRevoca el acceso al File otorgado al usuario determinado.
setContent(content)FileReemplaza el contenido del archivo con un reemplazo específico.
setDescription(description)FileEstablece la descripción del File.
setName(name)FileEstablece el nombre de 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 acceder cuando es compartida mediante un vínculo.
setShareableByEditors(shareable)FileEstablece si los usuarios con permisos de edición en File pueden compartir contenido con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FileEstablece 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)FileEstablece si se destaca File en la unidad de Drive del usuario.
setTrashed(trashed)FileEstablece si el elemento 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 la llamada 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 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 determinado de usuarios a la lista de editores de Folder.
addViewer(emailAddress)FolderAgrega el usuario específico a la lista de lectores de Folder.
addViewer(user)FolderAgrega el usuario específico a la lista de lectores de Folder.
addViewers(emailAddresses)FolderAgrega el array determinado de usuarios a la lista de visualizadores 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 proporcionados.
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 del elemento de Drive y la clave de recurso proporcionados, y lo muestra.
getAccess(email)PermissionObtiene el permiso otorgado al usuario determinado.
getAccess(user)PermissionObtiene el permiso otorgado al usuario determinado.
getDateCreated()DateObtiene la fecha en que se creó el Folder.
getDescription()StringObtiene la descripción del 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 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 un nombre determinado.
getId()StringObtiene el ID del Folder.
getLastUpdated()DateObtiene la fecha de la última actualización del Folder.
getName()StringObtiene el nombre del Folder.
getOwner()UserObtiene el propietario de este Folder.
getParents()FolderIteratorObtiene una colección de carpetas que son elementos superiores inmediatos 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()BooleanDetermina 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()BooleanObtiene si este Folder requiere una clave de recurso para acceder cuando es compartida mediante un vínculo.
getSharingAccess()AccessObtiene 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()PermissionObtiene 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()IntegerObtiene la cantidad de bytes usados para almacenar el 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 para Folder pueden hacer lo siguiente: compartir con otros usuarios ni cambiar los permisos.
isStarred()BooleanDetermina si se destacó Folder en la unidad de Drive del usuario.
isTrashed()BooleanDetermina si 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 específico de la lista de lectores y comentaristas de Folder.
removeViewer(user)FolderQuita al usuario específico de la lista de lectores y comentaristas de Folder.
revokePermissions(emailAddress)FolderRevoca el acceso al Folder otorgado al usuario determinado.
revokePermissions(user)FolderRevoca el acceso al 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 la búsqueda determinada. con tus criterios.
searchFolders(params)FolderIteratorObtiene 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)FolderEstablece la descripción del Folder.
setName(name)FolderEstablece el nombre de 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 acceder cuando es compartida mediante un vínculo.
setShareableByEditors(shareable)FolderEstablece si los usuarios con permisos de edición en Folder pueden compartir contenido con otros usuarios o cambiar los permisos.
setSharing(accessType, permissionType)FolderEstablece 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)FolderEstablece si se destaca Folder en la unidad de Drive del usuario.
setTrashed(trashed)FolderEstablece si el elemento 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 la llamada 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 tengan acceso al archivo o a la carpeta solo podrán verlo o copiarlo.
EDITEnumLos usuarios con acceso al archivo o a la carpeta pueden editarlo.
COMMENTEnumLos usuarios que tengan acceso al archivo o a la carpeta solo podrán verlo, copiarlo o comentarlo.
OWNEREnumEl usuario es propietario del archivo o la carpeta.
ORGANIZEREnumUsuarios que pueden organizar archivos y carpetas dentro de una unidad compartida.
FILE_ORGANIZEREnumUsuarios que pueden editar, enviar a la papelera y mover contenido 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.