Pobieranie i eksportowanie plików

Interfejs Google Drive API obsługuje kilka rodzajów działań związanych z pobieraniem i eksportowaniem: podane w tej tabeli:

Pobieranie
Zawartość pliku blob za pomocą metody files.get z parametrem adresu URL alt=media.
Zawartość pliku blob we wcześniejszej wersji przy użyciu metody revisions.get z parametrem adresu URL alt=media.
Zawartość pliku blob w przeglądarce przy użyciu pola webContentLink.
Eksporty
Dokument Google Workspace w formacie obsługiwanym przez Twoją aplikację przy użyciu files.export.
Zawartość dokumentu Google Workspace w przeglądarce przy użyciu pola exportLinks.
Zawartość dokumentu Google Workspace we wcześniejszej wersji w przeglądarce przy użyciu pola exportLinks.

Zanim pobierzesz lub wyeksportujesz zawartość pliku, sprawdź, czy użytkownicy mogą pobrać za pomocą pola capabilities.canDownload na stronie files.

W dalszej części tego przewodnika znajdziesz szczegółowe instrukcje wykonywania tych czynności pobierania i eksportowania danych.

Pobierz zawartość pliku blob

Aby pobrać plik blob zapisany na Dysku, użyj metody files.get z identyfikatorem pobieranego pliku i parametru adresu URL alt=media. Parametr adresu URL alt=media informuje żądania pobrania treści jako odpowiedzi alternatywnej. .

Parametr adresu URL alt=media to system we wszystkich interfejsach API typu REST Google. Jeśli używasz biblioteki klienta do Drive API, nie musisz ustawiać tego parametru bezpośrednio.

Poniższy przykładowy kod pokazuje, jak za pomocą metody files.get pobrać za pomocą bibliotek klienta interfejsu Drive API.

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

Ten przykładowy kod korzysta z metody biblioteki, która dodaje parametr adresu URL alt=media do bazowego żądania HTTP.

Pobieranie plików rozpoczęte z Twojej aplikacji musi być autoryzowane za pomocą zakresu, który zezwala uprawnienia do odczytu treści pliku. Na przykład aplikacja, która używa Zakres drive.readonly.metadata nie ma uprawnień do pobrania zawartości pliku. Ten przykładowy kod korzysta z ograniczonego zakresu plików „drive”, który umożliwia użytkownikom wyświetlać wszystkie pliki na Dysku i nimi zarządzać. Aby dowiedzieć się więcej o: Zakresy Dysku – zapoznaj się z artykułem Choose Google Drive API (Wybierz interfejs Google Drive API) .

Użytkownicy z uprawnieniami do edycji mogą ograniczyć pobieranie przez użytkowników z uprawnieniami tylko do odczytu przez Ustawianie copyRequiresWriterPermission do false.

Pliki zidentyfikowane jako nieodpowiednie (takich jak szkodliwe oprogramowanie) może pobrać tylko właściciel pliku. Należy też uwzględnić parametr zapytania acknowledgeAbuse=true typu get aby wskazać, że użytkownik wyraził zgodę na ryzyko pobierania niechciane oprogramowanie i inne pliki naruszające zasady. Aplikacja powinna interaktywnie ostrzegać użytkownika przed użyciem tego parametru zapytania.

Pobieranie częściowe

Częściowe pobieranie obejmuje pobranie tylko określonego fragmentu pliku. Ty możesz określić fragment pliku do pobrania, używając w formacie bajtowym zakres z nagłówkiem Range. Na przykład:

Range: bytes=500-999

Pobierz zawartość pliku blob we wcześniejszej wersji

Aby pobrać zawartość plików blob we wcześniejszej wersji, użyj revisions.get o identyfikatorze wybrać plik do pobrania, identyfikator wersji oraz parametr alt=media adresu URL. Parametr adresu URL alt=media informuje serwer, że pobieranie treści jest jako alternatywny format odpowiedzi. Podobnie jak w przypadku files.get, atrybut Metoda revisions.get akceptuje również opcjonalny parametr zapytania acknowledgeAbuse i nagłówek Range. Więcej informacji na temat pobierania Więcej informacji można znaleźć w sekcji Pobieranie i publikowanie pliku wersji.

Pobierz zawartość pliku blob w przeglądarce

Aby pobrać zawartość plików blob przechowywanych na Dysku w w przeglądarce, zamiast przez interfejs API użyj webContentLink parametru files zasób. Jeśli użytkownik pobrał aplikację dostęp do pliku, link do pobrania pliku i jego zawartości . Można przekierować użytkownika do tego adresu URL lub zaoferować go jako klikalny .

Eksportowanie treści dokumentów Google Workspace

Aby wyeksportować zawartość bajtów dokumentu z Google Workspace, użyj metody files.export z identyfikatorem pliku do wyeksportowania i poprawny typ MIME. Wyeksportowano jego rozmiar jest ograniczony do 10 MB.

Poniższy przykładowy kod pokazuje, jak za pomocą metody files.export wyeksportować dokument Google Workspace w formacie PDF za pomocą klienta Drive API, biblioteki:

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

Ten przykładowy kod korzysta z ograniczonego zakresu drive, który umożliwia użytkownikom wyświetlanie zarządzać wszystkimi plikami na Dysku. Aby dowiedzieć się więcej o: Zakresy Dysku – zapoznaj się z artykułem Choose Google Drive API (Wybierz interfejs Google Drive API) .

W przykładowym kodzie deklarowano także typ eksportu MIME jako application/pdf. Dla pełna lista wszystkich eksportowanych typów MIME obsługiwanych w poszczególnych wersjach Google Workspace. więcej informacji znajdziesz w artykule Eksportowanie typów MIME w Google Workspace dokumenty.

Eksportowanie treści dokumentów Google Workspace w przeglądarce

Aby wyeksportować treść dokumentu Google Workspace w przeglądarce, skorzystaj z exportLinks parametru files zasób. W zależności od dokumentu dla każdego formatu MIME zwracany jest link do pobrania pliku, a jego zawartość jest zwracana typ dostępny. Można przekierować użytkownika do adresu URL lub zaoferować go jako klikalny link.

Eksportowanie treści dokumentów Google Workspace we wcześniejszej wersji w przeglądarce

Aby wyeksportować treść dokumentu Google Workspace we wcześniejszej wersji w przeglądarki, użyj metody revisions.get identyfikator pliku do pobrania i identyfikator wersji. Jeśli użytkownik ma dostęp do pliku, link do pobrania pliku i jego zawartości . Można przekierować użytkownika do tego adresu URL lub zaoferować go jako klikalny .