La API de Google Drive admite varios tipos de acciones de descarga y exportación, como se indica en la siguiente tabla:
| Acciones de descarga |
|
||||
| Acciones de exportación |
|
En la API de Drive, un archivo BLOB hace referencia a cualquier archivo binario sin procesar almacenado en Google Drive (como imágenes, videos y PDFs), a diferencia de un documento de Google Workspace. No hace referencia al objeto
Blob de JavaScript. Para
obtener descripciones detalladas de los tipos de archivos que se mencionan aquí, incluidos los archivos BLOB y de
Google Workspace, consulta Tipos de
archivos.
Antes de descargar o exportar contenido de archivos, verifica que los usuarios puedan descargar el
archivo con el
capabilities.canDownload
campo en el files recurso.
En el resto de este documento, se proporcionan instrucciones detalladas para realizar estos tipos de acciones de descarga y exportación.
Descarga contenido de archivos BLOB
Para descargar un archivo BLOB almacenado en Drive, usa el método files.get con el ID del archivo que se descargará y el parámetro del sistema
alt system
parameter.
El parámetro alt=media le indica al servidor que se solicita una descarga de contenido como formato de respuesta alternativo.
El parámetro del sistema alt está disponible en todas las APIs de REST de Google. Si usas una biblioteca cliente de la API de Drive, no necesitas configurar este parámetro de forma explícita, ya que el método de la biblioteca cliente agrega el parámetro alt=media a la solicitud HTTP subyacente.
En los siguientes ejemplos de código, se muestra cómo usar el método files.get para descargar un archivo:
Apps Script
/**
* Downloads a file from Drive.
* @param {string} fileId The ID of the file to download.
* @return {Blob} The file content as a Blob.
*/
function downloadFile(fileId) {
var url = 'https://www.googleapis.com/drive/v3/files/' + fileId + '?alt=media';
var response = UrlFetchApp.fetch(url, {
headers: {
'Authorization': 'Bearer ' + ScriptApp.getOAuthToken()
}
});
return response.getBlob();
}
Java
Python
Node.js
PHP
.NET
curl
curl -L "https://www.googleapis.com/drive/v3/files/FILE_ID?alt=media" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--output "FILE_NAME"
Reemplaza lo siguiente:
- FILE_ID: El ID del archivo que se descargará
- ACCESS_TOKEN: El token de acceso que otorga acceso a la API
- FILE_NAME: El nombre del archivo de salida
Las descargas de archivos que se inician desde tu app deben autorizarse con un permiso que permita el acceso de lectura al contenido del archivo. Por ejemplo, una app que usa el permiso drive.readonly.metadata no está autorizada para descargar el contenido del archivo.
Los ejemplos de código de la biblioteca cliente usan el permiso de archivo drive restringido que permite a los usuarios ver y administrar todos tus archivos de Drive. Para obtener más información
sobre los permisos de Drive, consulta Elige permisos para la API de Google Drive.
Los usuarios con permisos owner (para mis archivos de Drive) o
organizer (para archivos de unidades compartidas) pueden restringir la descarga
a través del
DownloadRestrictionsMetadata
objeto. Para obtener más información, consulta Impide que los usuarios descarguen, impriman o
copien tu archivo.
Los archivos identificados como abusivos
(como software dañino) solo pueden descargarse por el propietario del archivo.
Además, el parámetro de consulta acknowledgeAbuse debe establecerse en true para indicar que el usuario reconoció el riesgo de descargar software potencialmente no deseado o cualquier otro archivo abusivo. Tu aplicación debe advertir al usuario de forma interactiva antes de usar este parámetro de consulta.
Accede a los datos de archivos en la memoria
Si tu aplicación debe acceder a los datos del archivo directamente en la memoria (por ejemplo, como un búfer de bytes) en lugar de guardarlos en un disco local, puedes ajustar la solicitud de la biblioteca cliente o procesar la transmisión que se muestra:
Node.js: De forma predeterminada, la biblioteca cliente de Node.js muestra el contenido del archivo como una transmisión
Readable. Para guardar el archivo en el disco local, haz lo siguiente:const fs = require('fs'); const dest = fs.createWriteStream('/path/to/dest/file.ext'); const response = await service.files.get( { fileId, alt: 'media' }, { responseType: 'stream' } ); response.data .on('end', () => { console.log('Download complete.'); }) .on('error', (err) => { console.error('Error downloading file.', err); }) .pipe(dest);Como alternativa, para mostrar los datos directamente en la memoria como un
ArrayBufferen lugar de una transmisión, establece el parámetroresponseTypeen las opciones de solicitud:const file = await service.files.get({ fileId, alt: 'media', }, { responseType: 'arraybuffer' }); // Convert the ArrayBuffer to a Node.js Buffer object. const buffer = Buffer.from(file.data);Python: La muestra de código de Python para descargar un archivo BLOB ya escribe los fragmentos de descarga en un objeto en la memoria
io.BytesIO(). Para acceder a los bytes sin procesar, llama afile.getvalue().Java: La muestra de código de Java para descargar un archivo BLOB usa un
java.io.ByteArrayOutputStreampara capturar los bytes descargados en la memoria. UsaoutputStream.toByteArray()para acceder al array de bytes sin procesar..NET: El ejemplo de código de C# para descargar un archivo BLOB usa un
System.IO.MemoryStream. Usastream.ToArray()para acceder al array de bytes subyacente.Apps Script: La muestra de código de Apps Script para descargar un archivo BLOB usa un
response.getBlob()método para mostrar unBlobobjeto. Convierte esto en un array de bytes con el métodogetBytes().
Descarga parcial
La descarga parcial implica descargar solo una parte especificada de un archivo. Puedes
especificar la parte del archivo que deseas descargar con un rango
de bytes con el
Range encabezado. Por ejemplo:
Range: bytes=500-999
Descarga contenido de archivos BLOB en una versión anterior
Para descargar el contenido de archivos BLOB en una versión anterior, usa el
revisions.get método con el ID del
archivo que se descargará, el ID de la revisión y el alt parámetro
del sistema.
El parámetro alt=media le indica al servidor que se solicita una descarga de contenido como formato de respuesta alternativo. Al igual que files.get, el método revisions.get también acepta el parámetro de consulta acknowledgeAbuse y el encabezado Range.
Solo puedes descargar revisiones de contenido de archivos BLOB que estén marcadas como "Conservar para siempre". Si quieres descargar una revisión, primero configúrala como "Conservar para siempre". Para obtener más información, consulta Especifica las revisiones que se guardarán de la eliminación automática.
Para obtener información adicional sobre la descarga de una revisión, consulta Administra operaciones de larga duración.
curl
curl -L "https://www.googleapis.com/drive/v3/files/FILE_ID/revisions/REVISION_ID?alt=media" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--output "FILE_NAME"
Reemplaza lo siguiente:
- FILE_ID: El ID del archivo que se descargará
- REVISION_ID: El ID de la revisión que se descargará
- ACCESS_TOKEN: El token de acceso que otorga acceso a la API
- FILE_NAME: El nombre del archivo de salida
Descarga contenido de archivos BLOB en un navegador
Para descargar el contenido de archivos BLOB almacenados en Drive dentro de un
navegador, en lugar de hacerlo a través de la API, usa el campo webContentLink del recurso files. Si el usuario tiene acceso de descarga al archivo, se muestra un vínculo para descargar el archivo y su contenido. Puedes redireccionar a un usuario a esta URL o ofrecerla como un vínculo en el que se puede hacer clic.
curl
curl "https://www.googleapis.com/drive/v3/files/FILE_ID?fields=webContentLink" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Accept: application/json"
Reemplaza lo siguiente:
- FILE_ID: El ID del archivo para obtener el vínculo de descarga
- ACCESS_TOKEN: El token de acceso que otorga acceso a la API
Descarga contenido de archivos BLOB con operaciones de larga duración
Para descargar el contenido de archivos BLOB con operaciones de larga duración (LRO), usa
el files.download método con el ID del
archivo que se descargará. De manera opcional, puedes establecer el ID de la revisión.
Esta es la única forma de descargar archivos de Google Vids. Si intentas exportar
archivos de Google Vids, recibes un
fileNotExportable error.
Para obtener más información, consulta Administra operaciones de larga duración.
curl
El siguiente comando curl inicia una LRO y muestra una respuesta JSON. Para descargar el archivo o sondear esta LRO, debes realizar otra solicitud con el ID que se muestra para obtener la URL del contenido. Luego, puedes realizar una solicitud curl final a esa URL para descargar el archivo. Para obtener más información, consulta Administra operaciones de larga duración.
curl --request POST "https://www.googleapis.com/drive/v3/files/FILE_ID/download?mimeType=video/mp4" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Length: 0" \
--header "Accept: application/json"
Reemplaza lo siguiente:
- FILE_ID: El ID del archivo que se descargará
- ACCESS_TOKEN: El token de acceso que otorga acceso a la API
Exporta contenido de documentos de Google Workspace
Para exportar contenido de bytes de documentos de Google Workspace, usa el método files.export con el ID del archivo que se exportará y
el tipo de MIME correcto. El contenido exportado está limitado a 10 MB.
En los siguientes ejemplos de código, se muestra cómo usar el método files.export para exportar un documento de Google Workspace en formato PDF:
Apps Script
/**
* Exports a Google Workspace document.
* @param {string} fileId The ID of the file to export.
* @param {string} mimeType The MIME type to export to.
* @return {Blob} The exported content as a Blob.
*/
function exportPdf(fileId, mimeType) {
var url = 'https://www.googleapis.com/drive/v3/files/' + fileId + '/export?mimeType=' + encodeURIComponent(mimeType);
var response = UrlFetchApp.fetch(url, {
headers: {
'Authorization': 'Bearer ' + ScriptApp.getOAuthToken()
}
});
return response.getBlob();
}
Java
Python
Node.js
PHP
.NET
curl
curl -L "https://www.googleapis.com/drive/v3/files/FILE_ID/export?mimeType=application/pdf" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--output "FILE_NAME.pdf"
Reemplaza lo siguiente:
- FILE_ID: El ID del archivo que se descargará
- ACCESS_TOKEN: El token de acceso que otorga acceso a la API
- FILE_NAME: El nombre del archivo de salida
Los ejemplos de código de la biblioteca cliente usan el permiso drive restringido que permite a los usuarios ver y administrar todos tus archivos de Drive. Para obtener más información
sobre los permisos de Drive, consulta Elige permisos para la API de Google Drive.
Los ejemplos de código también declaran el tipo de MIME de exportación como application/pdf. Para obtener una
lista completa de todos los tipos de MIME de exportación compatibles con cada documento de Google Workspace, consulta Tipos de MIME de exportación para documentos de Google Workspace.
Exporta contenido de documentos de Google Workspace en un navegador
Para exportar contenido de documentos de Google Workspace dentro de un navegador, usa el
exportLinks campo del
files recurso. Según el tipo de documento, se muestra un vínculo para descargar el archivo y su contenido para cada tipo de MIME disponible. Puedes redireccionar a un usuario a una URL o ofrecerla como un vínculo en el que se puede hacer clic.
curl
curl "https://www.googleapis.com/drive/v3/files/FILE_ID?fields=id,name,exportLinks" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Accept: application/json"
Reemplaza lo siguiente:
- FILE_ID: El ID del archivo para obtener el vínculo de descarga
- ACCESS_TOKEN: El token de acceso que otorga acceso a la API
Exporta contenido de documentos de Google Workspace en una versión anterior en un navegador
Para exportar contenido de documentos de Google Workspace en una versión anterior dentro de un
navegador, usa el revisions.get método con
el ID del archivo que se descargará y el ID de la revisión para generar un vínculo de exportación
desde el que puedes realizar la descarga. Si el usuario tiene acceso de descarga al archivo, se muestra un vínculo para descargar el archivo y su contenido. Puedes redireccionar a un usuario a esta URL o ofrecerla como un vínculo en el que se puede hacer clic.
curl
curl "https://www.googleapis.com/drive/v3/files/FILE_ID/revisions/REVISION_ID?fields=id,name,exportLinks" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Accept: application/json"
Reemplaza lo siguiente:
- FILE_ID: El ID del archivo que se descargará
- REVISION_ID: El ID de la revisión que se descargará
- ACCESS_TOKEN: El token de acceso que otorga acceso a la API
Exporta contenido de documentos de Google Workspace con operaciones de larga duración
Para exportar contenido de documentos de Google Workspace con operaciones de larga duración
(LRO), usa el files.download método con
el ID del archivo que se descargará y el ID de la revisión. Para obtener más información,
consulta Administra operaciones de larga duración.
curl
El siguiente comando curl inicia una LRO y muestra una respuesta JSON. Para descargar el archivo o sondear esta LRO, debes realizar otra solicitud con el ID que se muestra para obtener la URL del contenido. Luego, puedes realizar una solicitud curl final a esa URL para descargar el archivo. Para obtener más información, consulta Administra operaciones de larga duración.
curl --request POST "https://www.googleapis.com/drive/v3/files/FILE_ID/download?mimeType=MIME_TYPE&revisionId=REVISION_ID" \
--header "Authorization: Bearer ACCESS_TOKEN" \
--header "Content-Length: 0" \
--header "Accept: application/json"
Reemplaza lo siguiente:
- FILE_ID: El ID del archivo que se descargará
- MIME_TYPE: El tipo de MIME al que se exportará
- REVISION_ID: El ID de la revisión que se descargará
- ACCESS_TOKEN: El token de acceso que otorga acceso a la API
Temas relacionados
- Protege el contenido de los archivos
- Tipos de MIME de exportación para documentos de Google Workspace