Descarga y exporta archivos

La API de Google Drive admite varios tipos de acciones de descarga y exportación, como en la siguiente tabla:

Descargas	El contenido del archivo BLOB mediante el método files.get con el parámetro de URL alt=media Crea un BLOB con el contenido de una versión anterior mediante el método revisions.get con el parámetro de URL alt=media. Contenido del archivo BLOB en un navegador con el campo webContentLink.
Exportaciones	Contenido de documentos de Google Workspace en un formato que tu app pueda controlar con files.export Contenido de los documentos de Google Workspace en un navegador con el campo exportLinks. Contenido del documento de Google Workspace en una versión anterior en un navegador con el campo exportLinks.

Antes de descargar o exportar el contenido del archivo, verifica que los usuarios puedan descargar la con el campo capabilities.canDownload de la files.

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

Descargar contenido del archivo 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 indica que se solicita una descarga de contenido como respuesta alternativa de un conjunto de datos tengan un formato común.

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

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

Nota: Si usas la versión 2 de la API de Drive anterior, puedes encontrar muestras de código en GitHub: Aprendizaje Descubre cómo migrar a la versión 3 de la API de Drive.

Java

drive/snippets/drive_v3/src/main/java/DownloadFile.java

Ver en GitHub

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

Ver en GitHub

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

Ver en GitHub

/**
 * 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

Ver en GitHub

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

Ver en GitHub

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 autorizarse con un permiso que permita acceso de lectura al contenido del archivo. Por ejemplo, una aplicación que utiliza el El permiso drive.readonly.metadata no está autorizado para descargar el contenido del archivo. Esta muestra de código usa 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 Para los permisos de Drive, consulta Elige la API de Google Drive permisos.

Los usuarios con permisos de edición pueden restringir las descargas para los usuarios con acceso de lectura mediante Configura copyRequiresWriterPermission en false.

Los archivos se identifican como abusivo (como software dañino) solo el propietario del archivo puede descargarlos. Además, se debe incluir el parámetro de consulta acknowledgeAbuse=true de get. para indicar que el usuario reconoce el riesgo de descargar archivos software no deseado u otros archivos abusivos. Tu aplicación debe interactuar advertir al usuario antes de usar este parámetro de consulta.

Descarga parcial

La descarga parcial implica descargar solo una parte específica de un archivo. Tú puedes especificar la parte del archivo que deseas descargar mediante un byte rango con el encabezado Range. Por ejemplo:

Range: bytes=500-999

Nota: No se admiten descargas parciales durante la exportación de Google Workspace. documentos.

Descarga el contenido del archivo BLOB en una versión anterior

Para descargar el contenido de un archivo BLOB en una versión anterior, usa la revisions.get con el ID de el 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 indica al servidor que se realiza una descarga de contenido que se solicitan como un formato de respuesta alternativo. Al igual que con files.get, la 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 las descargas revisiones, consulta Descarga y publica archivos revisiones.

Descarga el contenido del archivo BLOB en un navegador

Para descargar el contenido de los archivos BLOB almacenados en Drive en una navegador, en lugar de hacerlo a través de la API, usa el Campo webContentLink del files recurso. Si el usuario tiene descargas acceso al archivo, se crea un vínculo para descargar el archivo y su contenido que se devuelven. Puedes redireccionar a un usuario a esta URL, o bien ofrecerla como un elemento en el que se puede hacer clic enlace.

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. Exportado el contenido está limitado a 10 MB.

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

Nota: Si usas la versión 2 de la API de Drive anterior, puedes encontrar muestras de código en GitHub: Aprendizaje Descubre cómo migrar a la versión 3 de la API de Drive.

Java

drive/snippets/drive_v3/src/main/java/ExportPdf.java

Ver en GitHub

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

Ver en GitHub

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

Ver en GitHub

/**
 * 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

Ver en GitHub

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

Ver en GitHub

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 permiso drive restringido que permite a los usuarios ver y administrar todos tus archivos de Drive. Para obtener más información Para los permisos de Drive, consulta Elige la API de Google Drive permisos.

La muestra de código también declara el tipo de MIME de exportación como application/pdf. Para un lista completa de todos los tipos de MIME de exportación admitidos para cada servicio de Google Workspace consulta Cómo exportar tipos de MIME para Google Workspace documentos.

Exporta contenido de documentos de Google Workspace a un navegador

Para exportar contenido de documentos de Google Workspace a un navegador, usa el Campo exportLinks del files recurso. Según el documento de ese tipo, se devuelve un vínculo para descargar el archivo y su contenido para cada MIME tipo disponible. Puedes redireccionar a un usuario a una URL, o bien ofrecerla como en el que se puede hacer clic.

Exporta el contenido de los documentos de Google Workspace a una versión anterior en un navegador

Para exportar el contenido de un documento de Google Workspace en una versión anterior en un navegador, usa el método revisions.get con el ID del archivo que se descargará y el ID de la revisión. Si el usuario tiene acceso de descarga al archivo, se crea un vínculo para descargar el archivo y su contenido que se devuelven. Puedes redireccionar a un usuario a esta URL, o bien ofrecerla como un elemento en el que se puede hacer clic enlace.

Temas relacionados

• Cómo proteger el contenido de los archivos

• Descarga y publica revisiones de archivos

• Cómo exportar tipos de MIME en documentos de Google Workspace