Se usó la API de Cloud Translation para traducir esta página.

Drive Service

Este servicio permite que las secuencias de comandos creen, busquen 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 manualmente la API de Drive. En tu proyecto de Cloud estándar, 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 carpeta 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());
}

Nota: Los administradores de Google Workspace pueden desactivar el SDK de Drive para su dominio, lo que evita que los usuarios instalen y usen las apps de Google Drive. Este parámetro de configuración también impide que los usuarios usen secuencias de comandos de Apps Script, apps web y complementos que usan el servicio de Drive o el servicio avanzado de Drive (incluso si el complemento o la aplicación web se instalaron antes de que el administrador desactivara el SDK de Drive).

Sin embargo, si un complemento que usa el servicio de Drive se publica para su instalación en todo el dominio y el administrador lo instala para algunos o todos los usuarios del dominio, o cualquier secuencia de comandos que tenga el cliente OAuth en la lista de entidades permitidas por el administrador del dominio, las funciones del complemento para esos usuarios, incluso si el SDK de Drive está desactivado en el dominio.

Clases

Nombre	Descripción breve
`Access`	Una enumeración que representa a las 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, busquen 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 en una colección de archivos potencialmente grande.
`Folder`	Una carpeta en Google Drive
`FolderIterator`	Un objeto que permite que las secuencias de comandos iteren en una colección de carpetas potencialmente grande.
`Permission`	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 a un archivo en Google Drive.

`Access`

Propiedades

Propiedad	Tipo	Descripción
`ANYONE`	`Enum`	Cualquier persona en 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 a las 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`	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 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 elemento `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 dados.
`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 del 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 applySingleParent 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 especificados.
`getFiles()`	`FileIterator`	Obtiene una colección de todos los archivos en la unidad de Drive del usuario.
`getFilesByName(name)`	`FileIterator`	Obtiene una colección de todos los archivos en la unidad de Drive del usuario que tienen un nombre determinado.
`getFilesByType(mimeType)`	`FileIterator`	Obtiene una colección de todos los archivos en la unidad de Drive del usuario que tienen un 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 del recurso determinados.
`getFolders()`	`FolderIterator`	Obtiene una colección de todas las carpetas en 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 almacena 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 la unidad de Drive del usuario.
`searchFiles(params)`	`FileIterator`	Obtiene 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)`	`FolderIterator`	Obtiene una colección de todas las carpetas de la unidad de Drive 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 el usuario determinado a la lista de comentaristas de `File`.
`addCommenter(user)`	`File`	Agrega el 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 determinado a la lista de editores del `File`.
`addEditor(user)`	`File`	Agrega el usuario determinado a la lista de editores del `File`.
`addEditors(emailAddresses)`	`File`	Agrega el array de usuarios determinado a la lista de editores del `File`.
`addViewer(emailAddress)`	`File`	Agrega el usuario determinado a la lista de visualizadores de `File`.
`addViewer(user)`	`File`	Agrega el usuario determinado a la lista de visualizadores de `File`.
`addViewers(emailAddresses)`	`File`	Agrega el array de usuarios determinado 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 de `File`.
`getDownloadUrl()`	`String`	Obtiene la URL que se puede usar para descargar el archivo.
`getEditors()`	`User[]`	Obtiene la lista de editores para este `File`.
`getId()`	`String`	Obtiene el ID de `File`.
`getLastUpdated()`	`Date`	Obtiene la fecha en que se actualizó el `File` por última vez.
`getMimeType()`	`String`	Obtiene el tipo de 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 inmediatos de `File`.
`getResourceKey()`	`String`	Obtiene la clave de recurso del `File` que se requiere para acceder a los elementos que se compartieron a través de 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 acceder cuando se comparte mediante un vínculo.
`getSecurityUpdateEnabled()`	`Boolean`	Obtiene si este `File` requiere una clave de recurso para acceder cuando se comparte mediante 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 aquellos usuarios que pueden acceder a `File`, además de los usuarios individuales a los que se les otorgó acceso de manera explícita.
`getSize()`	`Integer`	Obtiene la cantidad de bytes que se usan para almacenar el `File` en Drive.
`getTargetId()`	`String`	Si se trata de una combinación de teclas, muestra el ID del elemento al que apunta.
`getTargetMimeType()`	`String`	Si se trata de un atajo, muestra el tipo de MIME del elemento al que apunta.
`getTargetResourceKey()`	`String`	Si el archivo es un acceso directo, muestra la clave de 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 el archivo `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 compartir contenido con otros usuarios o cambiar los permisos.
`isStarred()`	`Boolean`	Determina si el elemento `File` se destacó en la unidad de Drive del usuario.
`isTrashed()`	`Boolean`	Determina si el elemento `File` está en la papelera de la unidad 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 del `File`.
`removeCommenter(user)`	`File`	Quita al usuario determinado de la lista de comentaristas del `File`.
`removeEditor(emailAddress)`	`File`	Quita al usuario determinado de la lista de editores del `File`.
`removeEditor(user)`	`File`	Quita al usuario determinado de la lista de editores del `File`.
`removeViewer(emailAddress)`	`File`	Quita al usuario determinado de la lista de lectores y comentaristas del `File`.
`removeViewer(user)`	`File`	Quita al usuario determinado de la lista de lectores y comentaristas del `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 por un reemplazo determinado.
`setDescription(description)`	`File`	Establece la descripción de `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 se comparte mediante un vínculo.
`setShareableByEditors(shareable)`	`File`	Establece si los usuarios con permisos de edición para `File` pueden compartir contenido con otros usuarios o cambiar los permisos.
`setSharing(accessType, permissionType)`	`File`	Configura 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 de manera explícita.
`setStarred(starred)`	`File`	Establece si el elemento `File` se destacará en la unidad de Drive del usuario.
`setTrashed(trashed)`	`File`	Establece si el `File` está en la papelera de la unidad 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 del `Folder`.
`addEditor(user)`	`Folder`	Agrega el usuario determinado a la lista de editores del `Folder`.
`addEditors(emailAddresses)`	`Folder`	Agrega el array de usuarios determinado a la lista de editores del `Folder`.
`addViewer(emailAddress)`	`Folder`	Agrega el usuario determinado a la lista de visualizadores de `Folder`.
`addViewer(user)`	`Folder`	Agrega el usuario determinado a la lista de visualizadores de `Folder`.
`addViewers(emailAddresses)`	`Folder`	Agrega el array de usuarios determinado 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 dado y el contenido.
`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 dado.
`createShortcut(targetId)`	`File`	Crea un acceso directo al ID del 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 de `Folder`.
`getEditors()`	`User[]`	Obtiene la lista de editores para este `Folder`.
`getFiles()`	`FileIterator`	Obtiene una colección de todos los archivos 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 un nombre determinado.
`getFilesByType(mimeType)`	`FileIterator`	Obtiene una colección de todos los archivos que son secundarios de la carpeta actual y tienen un 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 de `Folder`.
`getLastUpdated()`	`Date`	Obtiene la fecha en que se actualizó el `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 inmediatos de `Folder`.
`getResourceKey()`	`String`	Obtiene la clave de recurso del `Folder` que se requiere para acceder a los elementos que se compartieron a través de 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 acceder cuando se comparte mediante un vínculo.
`getSecurityUpdateEnabled()`	`Boolean`	Obtiene si este `Folder` requiere una clave de recurso para acceder cuando se comparte mediante 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 aquellos usuarios que pueden acceder a `Folder`, además de los usuarios individuales a los que se les otorgó acceso de manera 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 archivo `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 compartir contenido con otros usuarios o cambiar los permisos.
`isStarred()`	`Boolean`	Determina si el elemento `Folder` se destacó en la unidad de Drive del usuario.
`isTrashed()`	`Boolean`	Determina si el elemento `Folder` está en la papelera de la unidad 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 del `Folder`.
`removeEditor(user)`	`Folder`	Quita al usuario determinado de la lista de editores del `Folder`.
`removeViewer(emailAddress)`	`Folder`	Quita al usuario determinado de la lista de lectores y comentaristas del `Folder`.
`removeViewer(user)`	`Folder`	Quita al usuario determinado de la lista de lectores y comentaristas del `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 secundarios de la carpeta actual y que coinciden con los criterios de búsqueda dados.
`searchFolders(params)`	`FolderIterator`	Obtiene una colección de todas las carpetas que son elementos secundarios de la carpeta actual y coinciden con los criterios de búsqueda dados.
`setDescription(description)`	`Folder`	Establece la descripción de `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 se comparte mediante un vínculo.
`setShareableByEditors(shareable)`	`Folder`	Establece si los usuarios con permisos de edición para `Folder` pueden compartir contenido con otros usuarios o cambiar los permisos.
`setSharing(accessType, permissionType)`	`Folder`	Configura 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 de manera explícita.
`setStarred(starred)`	`Folder`	Establece si el elemento `Folder` se destacará en la unidad de Drive del usuario.
`setTrashed(trashed)`	`Folder`	Establece si el `Folder` está en la papelera de la unidad 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 pueden acceder al archivo o a la carpeta solo pueden verlos o copiarlos.
`EDIT`	`Enum`	Los usuarios que puedan acceder al archivo o a la carpeta podrán editarlo.
`COMMENT`	`Enum`	Los usuarios que puedan acceder 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, mover a la papelera y mover contenido de una unidad compartida
`NONE`	`Enum`	El usuario no tiene permisos 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.