Class File

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
Archivo

Un archivo en Google Drive. Puedes acceder a los archivos o crearlos desde DriveApp.

// Trash every untitled spreadsheet that hasn't been updated in a week.
var files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  var file = files.next();
  if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) {
    file.setTrashed(true);
  }
}

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 de File.
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.

Documentación detallada

addCommenter(emailAddress)

Agrega el usuario determinado a la lista de comentaristas de File. Si el usuario ya estaba en la lista de usuarios, este método lo promociona fuera de la lista de usuarios.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se agregará.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

addCommenter(user)

Agrega el usuario determinado a la lista de comentaristas de File. Si el usuario ya estaba en la lista de usuarios, este método lo promociona fuera de la lista de usuarios.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se agregará.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

addCommenters(emailAddresses)

Agrega el array de usuarios determinado a la lista de comentaristas para File. Si alguno de los usuarios ya estaba en la lista de usuarios, este método los promociona fuera de la lista de usuarios.

Parámetros

NombreTipoDescripción
emailAddressesString[]Un arreglo de direcciones de correo electrónico de los usuarios para agregar.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

addEditor(emailAddress)

Agrega el usuario determinado a la lista de editores de File. Si el usuario ya estaba en la lista de usuarios, este método lo promociona fuera de la lista de usuarios.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se agregará.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

addEditor(user)

Agrega el usuario determinado a la lista de editores de File. Si el usuario ya estaba en la lista de usuarios, este método lo promociona fuera de la lista de usuarios.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se agregará.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

addEditors(emailAddresses)

Agrega el array de usuarios determinado a la lista de editores de File. Si alguno de los usuarios ya estaba en la lista de usuarios, este método los promociona fuera de la lista de usuarios.

Parámetros

NombreTipoDescripción
emailAddressesString[]Un arreglo de direcciones de correo electrónico de los usuarios para agregar.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

addViewer(emailAddress)

Agrega el usuario determinado a la lista de lectores de File. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se agregará.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

addViewer(user)

Agrega el usuario determinado a la lista de lectores de File. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se agregará.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

addViewers(emailAddresses)

Agrega el array de usuarios determinado a la lista de lectores de File. Si alguno de los usuarios ya estaba en la lista de editores, este método no tiene efecto en ellos.

Parámetros

NombreTipoDescripción
emailAddressesString[]Un arreglo de direcciones de correo electrónico de los usuarios para agregar.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

getAccess(email)

Obtiene el permiso otorgado al usuario determinado.

Parámetros

NombreTipoDescripción
emailStringla dirección de correo electrónico del usuario cuyos permisos se deben verificar

Volver

Permission: Los permisos otorgados al usuario

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAccess(user)

Obtiene el permiso otorgado al usuario determinado.

Parámetros

NombreTipoDescripción
userUseruna representación del usuario cuyos permisos se deben verificar

Volver

Permission: Los permisos otorgados al usuario

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAs(contentType)

Muestra los datos de este objeto como un BLOB convertido al tipo de contenido especificado. Este método agrega la extensión adecuada al nombre del archivo, por ejemplo, "myfile.pdf". Sin embargo, se supone que la parte del nombre de archivo que sigue al último punto (si existe) es una extensión existente que debe reemplazarse. En consecuencia, “ShoppingList.12.25.2014” se convierte en “ShoppingList.12.25.pdf”.

Si deseas ver las cuotas diarias de conversiones, consulta Cuotas para servicios de Google. Los dominios de Google Workspace creados recientemente pueden estar sujetos a cuotas más estrictas de forma temporal.

Parámetros

NombreTipoDescripción
contentTypeStringEl tipo de MIME al que deseas convertir. Para la mayoría de los BLOB, 'application/pdf' es la única opción válida. Para las imágenes en formato BMP, GIF, JPEG o PNG, también son válidas cualquiera de las siguientes opciones: 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'.

Volver

Blob: los datos como un BLOB


getBlob()

Muestra los datos dentro de este objeto como un BLOB.

Volver

Blob: los datos como un BLOB


getDateCreated()

Obtiene la fecha en la que se creó el File.

Volver

Date: Es la fecha en la que se creó File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDescription()

Obtiene la descripción de File.

Volver

String: Es la descripción de File

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDownloadUrl()

Obtiene la URL que se puede usar para descargar el archivo. Solo los usuarios con permiso para abrir el archivo en Google Drive pueden acceder a la URL. Puedes usar esta URL en un navegador para descargar el archivo, pero no puedes usarlo a fin de recuperar el archivo con UrlFetchApp. Si deseas ver el contenido del archivo en la secuencia de comandos, usa getBlob().

Volver

String: Es la URL que se puede usar para descargar el archivo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getEditors()

Obtiene la lista de editores de este File. Si el usuario que ejecuta la secuencia de comandos no tiene acceso de edición a File, este método muestra un arreglo vacío.

Volver

User[]: Es un array de usuarios con permiso de edición.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getId()

Obtiene el ID de File.

Volver

String: Es el ID de File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getLastUpdated()

Obtiene la fecha de la última actualización de File.

Volver

Date: Fecha en la que se actualizó por última vez el File

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getMimeType()

Obtiene el tipo MIME del archivo.

Volver

String: Es el tipo de MIME del archivo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getName()

Obtiene el nombre de File.

Volver

String: Es el nombre de File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getOwner()

Obtiene el propietario de File.

Volver

User: Es un objeto User que representa al propietario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getParents()

Obtiene una colección de carpetas que son superiores inmediatamente de File.

Volver

FolderIterator: Una colección de carpetas que son elementos superiores inmediatos de File

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getResourceKey()

Obtiene la clave de recurso del File que se requiere para acceder a los elementos que se compartieron mediante un vínculo.

Volver

String: la clave del recurso de File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEligible()

Obtiene 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.

Drive requiere una clave de recurso para acceder a algunos archivos o carpetas que se compartieron con un vínculo. Este cambio forma parte de una actualización de seguridad. La actualización está activada de forma predeterminada para las carpetas y los archivos aptos. A fin de activar o desactivar el requisito de la clave del recurso para los archivos aptos, usa setSecurityUpdateEnabled.

Obtén más información sobre la actualización de seguridad de Google Drive.

Volver

Boolean: Indica si el requisito de la clave del recurso se puede aplicar para File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEnabled()

Obtiene si File requiere una clave de recurso para acceder cuando se comparte mediante un vínculo. Este requisito está activado de forma predeterminada para las carpetas y los archivos aptos. Para activar o desactivar el requisito de clave de recursos en los archivos aptos, usa setSecurityUpdateEnabled.

Obtén más información sobre la actualización de seguridad de Google Drive.

Volver

Boolean: Indica si el requisito de la clave del recurso está habilitado para este File.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingAccess()

Obtiene 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.

Volver

Access: qué clase de usuarios puede acceder a File

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingPermission()

Obtiene 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.

Volver

Permission: Los permisos otorgados a los usuarios que pueden acceder a File

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSize()

Obtiene la cantidad de bytes que se usan para almacenar File en Drive. Ten en cuenta que los archivos de aplicaciones de Google Workspace no cuentan para los límites de almacenamiento en Drive y, por lo tanto, muestran 0 bytes.

Volver

Integer: Es la cantidad de bytes que se usan para almacenar File en Drive.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getTargetId()

Si se trata de un acceso directo, muestra el ID del elemento al que apunta.

De lo contrario, muestra null.

Volver

String: Es el ID del elemento de destino.


getTargetMimeType()

Si se trata de un acceso directo, muestra el tipo MIME del elemento al que apunta.

De lo contrario, muestra null.

Volver

String: Es el tipo de MIME del elemento de destino.


getTargetResourceKey()

Si el archivo es un acceso directo, muestra la clave del recurso del elemento al que apunta. Las claves de recursos son un parámetro adicional que se debe pasar a fin de acceder a los archivos que se compartieron mediante un vínculo.

Si el archivo no es un acceso directo, muestra null.

Volver

String: Es la clave de recurso del elemento de destino o null si el archivo no es un acceso directo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getThumbnail()

Obtiene una imagen en miniatura para el archivo o null si no existe.

Volver

Blob: Es la imagen en miniatura del archivo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getUrl()

Obtiene la URL que se puede usar para abrir File en una app de Google, como Drive o Documentos.

Volver

String: Es la URL que se puede usar para ver este File en una app de Google, como Drive o Documentos.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getViewers()

Obtiene la lista de lectores y comentaristas de este File. Si el usuario que ejecuta la secuencia de comandos no tiene acceso de edición a File, este método muestra un arreglo vacío.

Volver

User[]: Es un array de usuarios con permiso para ver o comentar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isShareableByEditors()

Determina si los usuarios con permisos de edición en File pueden compartir con otros usuarios o cambiar los permisos.

Volver

Boolean: true si los usuarios con permisos de edición pueden compartir contenido con otros usuarios o cambiar los permisos; false si no es así

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isStarred()

Determina si File se destacó en la unidad de Drive del usuario.

Volver

Boolean: Es true si el File está destacado en la unidad de Drive del usuario; si no se destaca, false

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isTrashed()

Determina si el File está en la papelera de la unidad de Drive del usuario.

Volver

Boolean: true si el File está en la papelera de la unidad de Drive del usuario; si no está false

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

makeCopy()

Crea una copia del archivo.

Volver

File: La copia nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

makeCopy(destination)

Crea una copia del archivo en el directorio de destino.

Parámetros

NombreTipoDescripción
destinationFolderEl directorio en el que se copiará el archivo.

Volver

File: La copia nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

makeCopy(name)

Crea una copia del archivo y la nombra con el nombre proporcionado.

Parámetros

NombreTipoDescripción
nameStringEl nombre de archivo que se debe aplicar a la copia nueva.

Volver

File: La copia nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

makeCopy(name, destination)

Crea una copia del archivo en el directorio de destino y le asigna un nombre con el nombre proporcionado.

Parámetros

NombreTipoDescripción
nameStringEl nombre de archivo que se debe aplicar a la copia nueva.
destinationFolderEl directorio en el que se copiará el archivo.

Volver

File: La copia nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

moveTo(destination)

Mueve este elemento a la carpeta de destino proporcionada.

El usuario actual debe ser el propietario del archivo o tener, como mínimo, acceso de edición a la carpeta superior actual del elemento para poder moverlo a la carpeta de destino.

Parámetros

NombreTipoDescripción
destinationFolderLa carpeta que se convierte en el nuevo superior.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

removeCommenter(emailAddress)

Quita el usuario determinado de la lista de comentaristas para File. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si File se comparte con todo el dominio del usuario.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se quitará.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

removeCommenter(user)

Quita el usuario determinado de la lista de comentaristas para File. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si File se comparte con todo el dominio del usuario.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se desea quitar.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

removeEditor(emailAddress)

Quita el usuario determinado de la lista de editores de File. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tiene acceso general, por ejemplo, si File se comparte con todo el dominio del usuario o si File está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de lectores.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se quitará.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

removeEditor(user)

Quita el usuario determinado de la lista de editores de File. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tiene acceso general, por ejemplo, si File se comparte con todo el dominio del usuario o si File está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de lectores.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se desea quitar.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

removeViewer(emailAddress)

Quita el usuario determinado de la lista de lectores y comentaristas del File. Este método no tiene efecto si el usuario es editor, no lector ni comentarista. Este método tampoco impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si File se comparte con todo el dominio del usuario o si el File está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario que se quitará.

Volver

File: Es el File para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

removeViewer(user)

Quita el usuario determinado de la lista de lectores y comentaristas del File. Este método no tiene efecto si el usuario es editor, no lector. Este método tampoco impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si File se comparte con todo el dominio del usuario o si File está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario que se desea quitar.

Volver

File: Es el File para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

revokePermissions(emailAddress)

Revoca el acceso a la File otorgada al usuario determinado. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si File se comparte con todo el dominio del usuario.

Parámetros

NombreTipoDescripción
emailAddressStringLa dirección de correo electrónico del usuario cuyo acceso se debe revocar.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

revokePermissions(user)

Revoca el acceso a la File otorgada al usuario determinado. Este método no impide que los usuarios accedan a File si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si File se comparte con todo el dominio del usuario.

Parámetros

NombreTipoDescripción
userUserUna representación del usuario cuyo acceso se debe revocar.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setContent(content)

Reemplaza el contenido del archivo por un reemplazo determinado. Muestra una excepción si content supera los 10 MB.

Parámetros

NombreTipoDescripción
contentStringEl contenido nuevo del archivo.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setDescription(description)

Establece la descripción para File.

Parámetros

NombreTipoDescripción
descriptionStringla nueva descripción para File

Volver

File: Este File, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setName(name)

Establece el nombre de File.

Parámetros

NombreTipoDescripción
nameStringel nuevo nombre de File

Volver

File: Este File, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setOwner(emailAddress)

Cambia el propietario de File. Este método también le otorga al propietario anterior acceso de edición explícito al File.

Parámetros

NombreTipoDescripción
emailAddressStringla dirección de correo electrónico del usuario que debería convertirse en el nuevo propietario

Volver

File: Este File, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setOwner(user)

Cambia el propietario de File. Este método también le otorga al propietario anterior acceso de edición explícito al File.

Parámetros

NombreTipoDescripción
userUseruna representación del usuario que debería convertirse en el nuevo propietario

Volver

File: Este File, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setSecurityUpdateEnabled(enabled)

Configura si File requiere una clave de recurso para acceder cuando se comparte mediante un vínculo. Las carpetas y los archivos aptos están habilitados de forma predeterminada.

Obtén más información sobre la actualización de seguridad de Google Drive.

Parámetros

NombreTipoDescripción
enabledBooleanSi se habilita el requisito de clave de recursos para File.

Volver

File: Este File, para el encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setShareableByEditors(shareable)

Configura si los usuarios con permisos de edición para File pueden compartir contenido con otros usuarios o cambiar los permisos. El valor predeterminado para una File nueva es true.

Parámetros

NombreTipoDescripción
shareableBooleantrue si los usuarios con permisos de edición deben poder compartir contenido con otros usuarios o cambiar sus permisos; false si no es así

Volver

File: Este File, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setSharing(accessType, permissionType)

Establece 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.

// Creates a folder that anyone on the Internet can read from and write to. (Domain
// administrators can prohibit this setting for users of a Google Workspace domain.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parámetros

NombreTipoDescripción
accessTypeAccessqué clase de usuarios debería poder acceder a File
permissionTypePermissionlos permisos que se deben otorgar a los usuarios que pueden acceder a File

Volver

File: Este File, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setStarred(starred)

Establece si File se destaca en la unidad de Drive del usuario. El valor predeterminado para los File nuevos es false.

Parámetros

NombreTipoDescripción
starredBooleantrue si se debe destacar File en la unidad de Drive del usuario; false si no

Volver

File: Este File, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive

setTrashed(trashed)

Establece si el File está en la papelera de la unidad de Drive del usuario. Solo el propietario puede enviar la papelera a la File. El valor predeterminado para los nuevos File es false.

Parámetros

NombreTipoDescripción
trashedBooleantrue si se debe mover File a la papelera de la unidad de Drive del usuario; si no se puede mover false

Volver

File: Este File, para encadenar

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/drive