Scaricare ed esportare file

L'API Google Drive supporta diversi tipi di azioni di download ed esportazione, come elencato nella tabella seguente:

Azioni di download

Contenuti dei file blob utilizzando il metodo files.get con il parametro URL alt=media. Contenuti dei file blob in una versione precedente utilizzando il metodo revisions.get con il parametro URL alt=media. Contenuti dei file blob in un browser utilizzando il campo webContentLink. Contenuti dei file blob utilizzando il metodo files.download durante le operazioni a lunga esecuzione. Questo è l'unico modo per scaricare i file di Google Vids.

Azioni di esportazione

Contenuti dei documenti di Google Workspace in un formato che la tua app può gestire, utilizzando il metodo files.export. Contenuti dei documenti di Google Workspace in un browser utilizzando il campo exportLinks. Contenuti dei documenti di Google Workspace in una versione precedente in un browser utilizzando il campo exportLinks. Contenuti dei documenti di Google Workspace utilizzando il metodo files.download durante le operazioni a lunga esecuzione.

Prima di scaricare o esportare i contenuti dei file, verifica che gli utenti possano scaricare il file utilizzando il capabilities.canDownload campo nella files risorsa.

Per le descrizioni dei tipi di file menzionati qui, inclusi i file blob e di Google Workspace, vedi Tipi di file.

Il resto di questa guida fornisce istruzioni dettagliate per eseguire questi tipi di azioni di download ed esportazione.

Scaricare i contenuti dei file blob

Per scaricare un file blob archiviato su Drive, utilizza il files.get metodo con l'ID del file da scaricare e il alt=media parametro URL. Il parametro URL alt=media indica al server che viene richiesto il download dei contenuti come formato di risposta alternativo.

Il parametro URL alt=media è un parametro di sistema disponibile in tutte le API REST di Google. Se utilizzi una libreria client per l'API Drive, non devi impostare esplicitamente questo parametro.

Il seguente esempio di codice mostra come utilizzare il metodo files.get per scaricare un file con le librerie client dell'API Drive.

Nota: se utilizzi la versione precedente dell'API Drive v2, puoi trovare esempi di codice su GitHub. Scopri come eseguire la migrazione all'API Drive v3.

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

Visualizza su 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

Visualizza su 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

Visualizza su GitHub

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

Visualizza su GitHub

<?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

Visualizza su 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;
        }
    }
}

Questo esempio di codice utilizza un metodo della libreria che aggiunge il parametro URL alt=media alla richiesta HTTP sottostante.

I download di file avviati dalla tua app devono essere autorizzati con un ambito che consenta l'accesso in lettura ai contenuti dei file. Ad esempio, un'app che utilizza l'ambito drive.readonly.metadata non è autorizzata a scaricare i contenuti dei file. Questo esempio di codice utilizza l'ambito file "drive" limitato che consente agli utenti di visualizzare e gestire tutti i file di Drive. Per saperne di più sugli ambiti di Drive, consulta Scegliere gli ambiti di API Google Drive scopes.

Gli utenti con autorizzazioni owner (per i file di Il mio Drive) o organizer (per i file dei Drive condivisi) possono limitare il download tramite l' DownloadRestrictionsMetadata oggetto. Per saperne di più, consulta Impedire agli utenti di scaricare, stampare o copiare il file.

I file identificati come illeciti (ad esempio software dannoso) possono essere scaricati solo dal proprietario del file. Inoltre, deve essere incluso il parametro di query get acknowledgeAbuse=true per indicare che l'utente ha riconosciuto il rischio di scaricare software potenzialmente indesiderato o altri file illeciti. La tua applicazione deve avvisare l'utente in modo interattivo prima di utilizzare questo parametro di query.

Download parziale

Il download parziale prevede il download solo di una parte specificata di un file. Puoi specificare la parte del file che vuoi scaricare utilizzando un intervallo di byte con l' Range intestazione. Ad esempio:

Range: bytes=500-999

Nota: i download parziali non sono supportati durante l'esportazione dei documenti di Google Workspace.

Scaricare i contenuti dei file blob in una versione precedente

Puoi scaricare solo le revisioni dei contenuti dei file blob contrassegnate come "Conserva per sempre". Se vuoi scaricare una revisione, impostala prima su "Conserva per sempre". Per saperne di più, consulta Specificare le revisioni da salvare dall'eliminazione automatica.

Per scaricare i contenuti dei file blob in una versione precedente, utilizza il revisions.get metodo con l'ID del file da scaricare, l'ID della revisione e il alt=media parametro URL. Il parametro URL alt=media indica al server che viene richiesto il download dei contenuti come formato di risposta alternativo. Analogamente a files.get, il metodo revisions.get accetta anche il parametro di query facoltativo acknowledgeAbuse e l'intestazione Range. Per saperne di più, consulta Gestire le operazioni a lunga esecuzione.

Il protocollo di richiesta è mostrato qui.

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

Scaricare i contenuti dei file blob in un browser

Per scaricare i contenuti dei file blob archiviati su Drive in un browser, anziché tramite l'API, utilizza il webContentLink campo della risorsa files. Se l'utente ha accesso al download del file, viene restituito un link per scaricare il file e i relativi contenuti. Puoi reindirizzare un utente a questo URL o offrirlo come link cliccabile.

Scaricare i contenuti dei file blob durante le operazioni a lunga esecuzione

Per scaricare i contenuti dei file blob durante le operazioni a lunga esecuzione, utilizza il files.download metodo con l'ID del file da scaricare. Facoltativamente, puoi impostare l'ID della revisione.

Questo è l'unico modo per scaricare i file di Google Vids. Se tenti di esportare i file di Google Vids, ricevi un fileNotExportable errore. Per saperne di più, consulta Gestire le operazioni a lunga esecuzione.

Esportare i contenuti dei documenti di Google Workspace

Per esportare i contenuti dei byte dei documenti di Google Workspace, utilizza il metodo files.export con l'ID del file da esportare e il tipo MIME corretto. I contenuti esportati sono limitati a 10 MB.

Il seguente esempio di codice mostra come utilizzare il metodo files.export per esportare un documento di Google Workspace in formato PDF utilizzando le librerie client dell'API Drive:

Nota: se utilizzi la versione precedente dell'API Drive v2, puoi trovare esempi di codice su GitHub. Scopri come eseguire la migrazione all'API Drive v3.

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

Visualizza su 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

Visualizza su 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

Visualizza su GitHub

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

Visualizza su GitHub

<?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

Visualizza su 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;
        }
    }
}

Questo esempio di codice utilizza l'ambito drive limitato che consente agli utenti di visualizzare e gestire tutti i file di Drive. Per saperne di più sugli ambiti di Drive, consulta Scegliere gli ambiti di API Google Drive scopes.

L'esempio di codice dichiara anche il tipo MIME di esportazione come application/pdf. Per un elenco completo di tutti i tipi MIME di esportazione supportati per ogni documento di Google Workspace, consulta Tipi MIME di esportazione per i documenti di Google Workspace.

Esportare i contenuti dei documenti di Google Workspace in un browser

Per esportare i contenuti dei documenti di Google Workspace in un browser, utilizza il exportLinks campo della files risorsa. A seconda del tipo di documento, viene restituito un link per scaricare il file e i relativi contenuti per ogni tipo MIME disponibile. Puoi reindirizzare un utente a un URL o offrirlo come link cliccabile.

Esportare i contenuti dei documenti di Google Workspace in una versione precedente in un browser

Per esportare i contenuti dei documenti di Google Workspace in una versione precedente in un browser, utilizza il metodo revisions.get con l'ID del file da scaricare e l'ID della revisione per generare un link di esportazione da cui puoi eseguire il download. Se l'utente ha accesso al download del file, viene restituito un link per scaricare il file e i relativi contenuti. Puoi reindirizzare un utente a questo URL o offrirlo come link cliccabile.

Esportare i contenuti dei documenti di Google Workspace durante le operazioni a lunga esecuzione

Per esportare i contenuti dei documenti di Google Workspace durante le operazioni a lunga esecuzione, utilizza il metodo files.download con l'ID del file da scaricare e l'ID della revisione. Per saperne di più, consulta Gestire le operazioni a lunga esecuzione.

Limitare la condivisione dei file

• Proteggere i contenuti dei file
• Tipi MIME di esportazione per i documenti di Google Workspace