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 archivos blob en una versión anterior con el método revisions.get y el parámetro de URL alt=media
Contenido de archivos blob en un navegador con el campo webContentLink
Contenido de archivos 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 contenido de archivos, verifica que los usuarios puedan descargar el archivo con el capabilities.canDownload campo en el files recurso.

Para obtener descripciones de los tipos de archivos que se mencionan aquí, incluidos los archivos blob y de 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 contenido de archivos blob

Para descargar un archivo blob almacenado en Drive, usa el método files.get con el ID del archivo que deseas descargar 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.

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 el siguiente ejemplo 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.

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

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
import {GoogleAuth} from 'google-auth-library';
import {google} from 'googleapis';

/**
 * Downloads a file from Google Drive.
 * @param {string} fileId The ID of the file to download.
 * @return {Promise<number>} The status of the download.
 */
async function downloadFile(fileId) {
  // Authenticate with Google and get an authorized client.
  // TODO (developer): Use an appropriate auth mechanism for your app.
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });

  // Create a new Drive API client (v3).
  const service = google.drive({version: 'v3', auth});

  // Download the file.
  const file = await service.files.get({
    fileId,
    alt: 'media',
  });

  // Print the status of the download.
  console.log(file.status);
  return file.status;
}

PHP

drive/snippets/drive_v3/src/DriveDownloadFile.php
<?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 este ejemplo 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 autorizarse con un alcance que permita el acceso de lectura al contenido del archivo. Por ejemplo, una app que usa el alcance drive.readonly.metadata no está autorizada para descargar el contenido del archivo. En este ejemplo de código, se usa el alcance de archivo restringido “drive” que permite a los usuarios ver y administrar todos tus archivos de Drive. Para obtener más información sobre los alcances de Drive, consulta Elige los alcances de la API de Google Drive 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 descargarlos el propietario del archivo. 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 usando un rango de bytes con el Range encabezado. Por ejemplo:

Range: bytes=500-999

Descarga contenido de archivos blob en una versión anterior

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 descargar el contenido de archivos blob en una versión anterior, usa el revisions.get método con el ID del archivo que deseas descargar, el ID de la revisión y el alt=media parámetro de URL. 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, consulta Administra operaciones de larga duración.

Aquí se muestra el protocolo de solicitud.

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

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 webContentLink campo 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.

Descarga contenido de archivos blob durante operaciones de larga duración

Para descargar el contenido de archivos blob durante operaciones de larga duración, usa el files.download método con el ID del archivo que deseas descargar. De manera opcional, puedes configurar 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.

Exporta contenido de documentos de Google Workspace

Para exportar contenido de bytes de documentos de Google Workspace, usa el files.export método con el ID del archivo que deseas exportar y el tipo de MIME correcto. El contenido exportado está limitado a 10 MB.

En el siguiente ejemplo 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:

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

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
import {GoogleAuth} from 'google-auth-library';
import {google} from 'googleapis';

/**
 * Exports a Google Doc as a PDF.
 * @param {string} fileId The ID of the file to export.
 * @return {Promise<number>} The status of the export request.
 */
async function exportPdf(fileId) {
  // Authenticate with Google and get an authorized client.
  // TODO (developer): Use an appropriate auth mechanism for your app.
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });

  // Create a new Drive API client (v3).
  const service = google.drive({version: 'v3', auth});

  // Export the file as a PDF.
  const result = await service.files.export({
    fileId,
    mimeType: 'application/pdf',
  });

  // Print the status of the export.
  console.log(result.status);
  return result.status;
}

PHP

drive/snippets/drive_v3/src/DriveExportPdf.php
<?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 este ejemplo de código, se usa el alcance restringido drive que permite a los usuarios ver y administrar todos tus archivos de Drive. Para obtener más información sobre los alcances de Drive, consulta Elige los alcances de la API de Google Drive Drive.

En el ejemplo de código, también se 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 admitidos para 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.

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

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

Para exportar contenido de documentos de Google Workspace durante operaciones de larga duración, usa el método files.download con el ID del archivo que deseas descargar y el ID de la revisión. Para obtener más información, consulta Administra operaciones de larga duración.

Limita cómo se comparten los archivos