Descarga y exporta archivos

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
Contenido de archivos BLOB con el método files.get y el parámetro de URL alt=media
Contenido de un archivo de blob en una versión anterior con el método revisions.get y el parámetro de URL alt=media
Contenido del archivo de blob en un navegador con el campo webContentLink
Contenido de archivos de blob con el método files.download durante operaciones de larga duración Esta es la única forma de descargar archivos de Google Vids.
Acciones de exportación
Contenido de documentos de Google Workspace en un formato que tu app pueda controlar, con el método files.export
Contenido de documentos de Google Workspace en un navegador con el campo exportLinks
Contenido de documentos de Google Workspace en una versión anterior en un navegador con el campo exportLinks
Contenido de documentos de Google Workspace con el método files.download durante operaciones de larga duración

Antes de descargar o exportar el contenido de un archivo, verifica que los usuarios puedan descargarlo con el campo capabilities.canDownload en el recurso files.

Para obtener descripciones de los tipos de archivos que se mencionan aquí, incluidos los archivos de blob y Google Workspace, consulta Tipos de archivos.

En el resto de esta guía, se proporcionan instrucciones detalladas para realizar estos tipos de acciones de descarga y exportación.

Descarga el contenido del archivo BLOB

Para descargar un archivo blob almacenado en Drive, usa el método files.get con el ID del archivo que quieres descargar y el parámetro de URL alt=media. El parámetro de URL alt=media le indica al servidor que se está solicitando una descarga de contenido como formato de respuesta alternativo.

El parámetro de URL alt=media es un parámetro del sistema disponible en todas las APIs de REST de Google. Si usas una biblioteca cliente para la API de Drive, no necesitas configurar este parámetro de forma explícita.

En la siguiente muestra de código, se muestra cómo usar el método files.get para descargar un archivo con las bibliotecas cliente de la API de Drive.

Java

drive/snippets/drive_v3/src/main/java/DownloadFile.java
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.drive.Drive;
import com.google.api.services.drive.DriveScopes;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Arrays;

/* Class to demonstrate use-case of drive's download file. */
public class DownloadFile {

  /**
   * Download a Document file in PDF format.
   *
   * @param realFileId file ID of any workspace document format file.
   * @return byte array stream if successful, {@code null} otherwise.
   * @throws IOException if service account credentials file not found.
   */
  public static ByteArrayOutputStream downloadFile(String realFileId) throws IOException {
        /* Load pre-authorized user credentials from the environment.
           TODO(developer) - See https://developers.google.com/identity for
          guides on implementing OAuth2 for your application.*/
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Arrays.asList(DriveScopes.DRIVE_FILE));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Build a new authorized API client service.
    Drive service = new Drive.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Drive samples")
        .build();

    try {
      OutputStream outputStream = new ByteArrayOutputStream();

      service.files().get(realFileId)
          .executeMediaAndDownloadTo(outputStream);

      return (ByteArrayOutputStream) outputStream;
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      System.err.println("Unable to move file: " + e.getDetails());
      throw e;
    }
  }
}

Python

drive/snippets/drive-v3/file_snippet/download_file.py
import io

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaIoBaseDownload


def download_file(real_file_id):
  """Downloads a file
  Args:
      real_file_id: ID of the file to download
  Returns : IO object with location.

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create drive api client
    service = build("drive", "v3", credentials=creds)

    file_id = real_file_id

    # pylint: disable=maybe-no-member
    request = service.files().get_media(fileId=file_id)
    file = io.BytesIO()
    downloader = MediaIoBaseDownload(file, request)
    done = False
    while done is False:
      status, done = downloader.next_chunk()
      print(f"Download {int(status.progress() * 100)}.")

  except HttpError as error:
    print(f"An error occurred: {error}")
    file = None

  return file.getvalue()


if __name__ == "__main__":
  download_file(real_file_id="1KuPmvGq8yoYgbfW74OENMCB5H0n_2Jm9")

Node.js

drive/snippets/drive_v3/file_snippets/download_file.js
/**
 * Downloads a file
 * @param{string} realFileId file ID
 * @return{obj} file status
 * */
async function downloadFile(realFileId) {
  // Get credentials and build service
  // TODO (developer) - Use appropriate auth mechanism for your app

  const {GoogleAuth} = require('google-auth-library');
  const {google} = require('googleapis');

  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });
  const service = google.drive({version: 'v3', auth});

  fileId = realFileId;
  try {
    const file = await service.files.get({
      fileId: fileId,
      alt: 'media',
    });
    console.log(file.status);
    return file.status;
  } catch (err) {
    // TODO(developer) - Handle error
    throw err;
  }
}

PHP

drive/snippets/drive_v3/src/DriveDownloadFile.php
use Google\Client;
use Google\Service\Drive;
function downloadFile()
 {
    try {

      $client = new Client();
      $client->useApplicationDefaultCredentials();
      $client->addScope(Drive::DRIVE);
      $driveService = new Drive($client);
      $realFileId = readline("Enter File Id: ");
      $fileId = '0BwwA4oUTeiV1UVNwOHItT0xfa2M';
      $fileId = $realFileId;
      $response = $driveService->files->get($fileId, array(
          'alt' => 'media'));
      $content = $response->getBody()->getContents();
      return $content;

    } catch(Exception $e) {
      echo "Error Message: ".$e;
    }

}

.NET

drive/snippets/drive_v3/DriveV3Snippets/DownloadFile.cs
using Google.Apis.Auth.OAuth2;
using Google.Apis.Download;
using Google.Apis.Drive.v3;
using Google.Apis.Services;

namespace DriveV3Snippets
{
    // Class to demonstrate use-case of drive's download file.
    public class DownloadFile
    {
        /// <summary>
        /// Download a Document file in PDF format.
        /// </summary>
        /// <param name="fileId">file ID of any workspace document format file.</param>
        /// <returns>byte array stream if successful, null otherwise.</returns>
        public static MemoryStream DriveDownloadFile(string fileId)
        {
            try
            {
                /* Load pre-authorized user credentials from the environment.
                 TODO(developer) - See https://developers.google.com/identity for 
                 guides on implementing OAuth2 for your application. */
                GoogleCredential credential = GoogleCredential
                    .GetApplicationDefault()
                    .CreateScoped(DriveService.Scope.Drive);

                // Create Drive API service.
                var service = new DriveService(new BaseClientService.Initializer
                {
                    HttpClientInitializer = credential,
                    ApplicationName = "Drive API Snippets"
                });

                var request = service.Files.Get(fileId);
                var stream = new MemoryStream();

                // Add a handler which will be notified on progress changes.
                // It will notify on each chunk download and when the
                // download is completed or failed.
                request.MediaDownloader.ProgressChanged +=
                    progress =>
                    {
                        switch (progress.Status)
                        {
                            case DownloadStatus.Downloading:
                            {
                                Console.WriteLine(progress.BytesDownloaded);
                                break;
                            }
                            case DownloadStatus.Completed:
                            {
                                Console.WriteLine("Download complete.");
                                break;
                            }
                            case DownloadStatus.Failed:
                            {
                                Console.WriteLine("Download failed.");
                                break;
                            }
                        }
                    };
                request.Download(stream);

                return stream;
            }
            catch (Exception e)
            {
                // TODO(developer) - handle error appropriately
                if (e is AggregateException)
                {
                    Console.WriteLine("Credential Not found");
                }
                else
                {
                    throw;
                }
            }
            return null;
        }
    }
}

En esta muestra de código, se usa un método de biblioteca que agrega el parámetro de URL alt=media a la solicitud HTTP subyacente.

Las descargas de archivos que se inician desde tu app deben estar autorizadas 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. En esta muestra de código, se usa el ámbito 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 de edición pueden restringir la descarga de los usuarios de solo lectura configurando el campo copyRequiresWriterPermission en false.

Solo el propietario puede descargar los archivos identificados como abusivos (como software dañino). Además, se debe incluir el parámetro de consulta get acknowledgeAbuse=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.

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 encabezado Range. Por ejemplo:

Range: bytes=500-999

Cómo descargar el contenido de un archivo blob en una versión anterior

Para descargar el contenido de los archivos blob en una versión anterior, usa el método revisions.get con el ID del archivo que se descargará, el ID de la revisión y el parámetro de URL alt=media. El parámetro de URL 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 opcional acknowledgeAbuse y el encabezado Range. Para obtener más información sobre cómo descargar revisiones, consulta Administra las revisiones de archivos.

Aquí se muestra el protocolo de solicitud.

GET https://www.googleapis.com/drive/v3/files/{FILE_ID}/revisions/{REVISION_ID}?alt=media

Cómo descargar el contenido de un archivo blob en un navegador

Para descargar el contenido de los archivos BLOB almacenados en Drive desde 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 descargarlo y su contenido. Puedes redireccionar a un usuario a esta URL o ofrecerla como un vínculo en el que se puede hacer clic.

Descarga el contenido de los archivos BLOB durante las operaciones de larga duración

Para descargar el contenido de los archivos de blob durante las operaciones de larga duración, usa el método files.download con el ID del archivo que deseas descargar. De forma opcional, puedes establecer el ID de la revisión. Esta es la única manera de descargar archivos de Google Vids. Para obtener más información, consulta Administra operaciones de larga duración.

Cómo exportar el contenido de documentos de Google Workspace

Para exportar el contenido de bytes de un documento de Google Workspace, usa el método files.export con el ID del archivo que deseas exportar y el tipo de MIME correcto. El contenido exportado se limita a 10 MB.

En la siguiente muestra de código, se muestra cómo usar el método files.export para exportar un documento de Google Workspace en formato PDF con las bibliotecas cliente de la API de Drive:

Java

drive/snippets/drive_v3/src/main/java/ExportPdf.java
import com.google.api.client.googleapis.json.GoogleJsonResponseException;
import com.google.api.client.http.HttpRequestInitializer;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.json.gson.GsonFactory;
import com.google.api.services.drive.Drive;
import com.google.api.services.drive.DriveScopes;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Arrays;

/* Class to demonstrate use-case of drive's export pdf. */
public class ExportPdf {

  /**
   * Download a Document file in PDF format.
   *
   * @param realFileId file ID of any workspace document format file.
   * @return byte array stream if successful, {@code null} otherwise.
   * @throws IOException if service account credentials file not found.
   */
  public static ByteArrayOutputStream exportPdf(String realFileId) throws IOException {
    // Load pre-authorized user credentials from the environment.
    // TODO(developer) - See https://developers.google.com/identity for
    // guides on implementing OAuth2 for your application.
    GoogleCredentials credentials = GoogleCredentials.getApplicationDefault()
        .createScoped(Arrays.asList(DriveScopes.DRIVE_FILE));
    HttpRequestInitializer requestInitializer = new HttpCredentialsAdapter(
        credentials);

    // Build a new authorized API client service.
    Drive service = new Drive.Builder(new NetHttpTransport(),
        GsonFactory.getDefaultInstance(),
        requestInitializer)
        .setApplicationName("Drive samples")
        .build();

    OutputStream outputStream = new ByteArrayOutputStream();
    try {
      service.files().export(realFileId, "application/pdf")
          .executeMediaAndDownloadTo(outputStream);

      return (ByteArrayOutputStream) outputStream;
    } catch (GoogleJsonResponseException e) {
      // TODO(developer) - handle error appropriately
      System.err.println("Unable to export file: " + e.getDetails());
      throw e;
    }
  }
}

Python

drive/snippets/drive-v3/file_snippet/export_pdf.py
import io

import google.auth
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError
from googleapiclient.http import MediaIoBaseDownload


def export_pdf(real_file_id):
  """Download a Document file in PDF format.
  Args:
      real_file_id : file ID of any workspace document format file
  Returns : IO object with location

  Load pre-authorized user credentials from the environment.
  TODO(developer) - See https://developers.google.com/identity
  for guides on implementing OAuth2 for the application.
  """
  creds, _ = google.auth.default()

  try:
    # create drive api client
    service = build("drive", "v3", credentials=creds)

    file_id = real_file_id

    # pylint: disable=maybe-no-member
    request = service.files().export_media(
        fileId=file_id, mimeType="application/pdf"
    )
    file = io.BytesIO()
    downloader = MediaIoBaseDownload(file, request)
    done = False
    while done is False:
      status, done = downloader.next_chunk()
      print(f"Download {int(status.progress() * 100)}.")

  except HttpError as error:
    print(f"An error occurred: {error}")
    file = None

  return file.getvalue()


if __name__ == "__main__":
  export_pdf(real_file_id="1zbp8wAyuImX91Jt9mI-CAX_1TqkBLDEDcr2WeXBbKUY")

Node.js

drive/snippets/drive_v3/file_snippets/export_pdf.js
/**
 * Download a Document file in PDF format
 * @param{string} fileId file ID
 * @return{obj} file status
 * */
async function exportPdf(fileId) {
  const {GoogleAuth} = require('google-auth-library');
  const {google} = require('googleapis');

  // Get credentials and build service
  // TODO (developer) - Use appropriate auth mechanism for your app
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });
  const service = google.drive({version: 'v3', auth});

  try {
    const result = await service.files.export({
      fileId: fileId,
      mimeType: 'application/pdf',
    });
    console.log(result.status);
    return result;
  } catch (err) {
    // TODO(developer) - Handle error
    throw err;
  }
}

PHP

drive/snippets/drive_v3/src/DriveExportPdf.php
use Google\Client;
use Google\Service\Drive;
function exportPdf()
{
    try {
        $client = new Client();
        $client->useApplicationDefaultCredentials();
        $client->addScope(Drive::DRIVE);
        $driveService = new Drive($client);
        $realFileId = readline("Enter File Id: ");
        $fileId = '1ZdR3L3qP4Bkq8noWLJHSr_iBau0DNT4Kli4SxNc2YEo';
        $fileId = $realFileId;
        $response = $driveService->files->export($fileId, 'application/pdf', array(
            'alt' => 'media'));
        $content = $response->getBody()->getContents();
        return $content;

    }  catch(Exception $e) {
         echo "Error Message: ".$e;
    }

}

.NET

drive/snippets/drive_v3/DriveV3Snippets/ExportPdf.cs
using Google.Apis.Auth.OAuth2;
using Google.Apis.Download;
using Google.Apis.Drive.v3;
using Google.Apis.Services;

namespace DriveV3Snippets
{
    // Class to demonstrate use of Drive export pdf
    public class ExportPdf
    {
        /// <summary>
        /// Download a Document file in PDF format.
        /// </summary>
        /// <param name="fileId">Id of the file.</param>
        /// <returns>Byte array stream if successful, null otherwise</returns>
        public static MemoryStream DriveExportPdf(string fileId)
        {
            try
            {
                /* Load pre-authorized user credentials from the environment.
                 TODO(developer) - See https://developers.google.com/identity for 
                 guides on implementing OAuth2 for your application. */
                GoogleCredential credential = GoogleCredential.GetApplicationDefault()
                    .CreateScoped(DriveService.Scope.Drive);

                // Create Drive API service.
                var service = new DriveService(new BaseClientService.Initializer
                {
                    HttpClientInitializer = credential,
                    ApplicationName = "Drive API Snippets"
                });

                var request = service.Files.Export(fileId, "application/pdf");
                var stream = new MemoryStream();
                // Add a handler which will be notified on progress changes.
                // It will notify on each chunk download and when the
                // download is completed or failed.
                request.MediaDownloader.ProgressChanged +=
                    progress =>
                    {
                        switch (progress.Status)
                        {
                            case DownloadStatus.Downloading:
                            {
                                Console.WriteLine(progress.BytesDownloaded);
                                break;
                            }
                            case DownloadStatus.Completed:
                            {
                                Console.WriteLine("Download complete.");
                                break;
                            }
                            case DownloadStatus.Failed:
                            {
                                Console.WriteLine("Download failed.");
                                break;
                            }
                        }
                    };
                request.Download(stream);
                return stream;
            }
            catch (Exception e)
            {
                // TODO(developer) - handle error appropriately
                if (e is AggregateException)
                {
                    Console.WriteLine("Credential Not found");
                }
                else
                {
                    throw;
                }
            }
            return null;
        }
    }
}

En esta muestra de código, se usa el alcance 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.

La muestra de código también declara 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.

Cómo exportar el contenido de un documento de Google Workspace en un navegador

Para exportar el contenido de un documento de Google Workspace en un navegador, usa el campo exportLinks del recurso files. 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 ofrecérsela como un vínculo en el que se puede hacer clic.

Cómo exportar el contenido de un documento de Google Workspace a una versión anterior en un navegador

Para exportar el contenido de un documento de Google Workspace a una versión anterior en un navegador, usa el método revisions.get con el ID del archivo que quieres 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 descargarlo y su contenido. Puedes redireccionar a un usuario a esta URL o ofrecerla como un vínculo en el que se puede hacer clic.

Exporta el contenido de documentos de Google Workspace durante operaciones de larga duración

Para exportar el contenido de documentos de Google Workspace durante operaciones de larga duración, usa el método files.download 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.