Tải tệp xuống và xuất

Google Drive API hỗ trợ một số loại thao tác tải xuống và xuất, như được liệt kê trong bảng sau:

Thao tác tải xuống
Nội dung tệp Blob bằng phương thức files.get với tham số URL alt=media.
Nội dung tệp Blob ở phiên bản trước bằng phương thức revisions.get với tham số URL alt=media.
Nội dung tệp Blob trong trình duyệt bằng cách dùng trường webContentLink.
Nội dung tệp blob bằng phương thức files.download trong các thao tác diễn ra trong thời gian dài. Đây là cách duy nhất để tải tệp Google Vids xuống.
Thao tác xuất
Nội dung tài liệu trên Google Workspace ở định dạng mà ứng dụng của bạn có thể xử lý, bằng cách sử dụng phương thức files.export.
Nội dung tài liệu trên Google Workspace trong trình duyệt bằng cách sử dụng trường exportLinks.
Nội dung của tài liệu Google Workspace ở phiên bản trước đó trong trình duyệt bằng cách sử dụng trường exportLinks.
Nội dung tài liệu trên Google Workspace bằng phương thức files.download trong các thao tác kéo dài.

Trước khi tải xuống hoặc xuất nội dung tệp, hãy xác minh rằng người dùng có thể tải tệp xuống bằng cách sử dụng trường capabilities.canDownload trên tài nguyên files.

Để biết nội dung mô tả về các loại tệp được đề cập ở đây, bao gồm cả tệp blob và tệp Google Workspace, hãy xem phần Các loại tệp.

Phần còn lại của hướng dẫn này cung cấp hướng dẫn chi tiết về cách thực hiện các loại hành động tải xuống và xuất này.

Tải nội dung tệp blob xuống

Để tải một tệp blob được lưu trữ trên Drive xuống, hãy dùng phương thức files.get cùng với mã nhận dạng của tệp cần tải xuống và tham số URL alt=media. Tham số URL alt=media cho máy chủ biết rằng một yêu cầu tải nội dung xuống đang được gửi dưới dạng định dạng phản hồi thay thế.

Tham số URL alt=media là một tham số hệ thống có sẵn trên tất cả các API REST của Google. Nếu sử dụng một thư viện ứng dụng cho Drive API, bạn không cần phải đặt rõ ràng tham số này.

Đoạn mã mẫu sau đây cho biết cách sử dụng phương thức files.get để tải một tệp xuống bằng thư viện ứng dụng 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;
        }
    }
}

Mã mẫu này sử dụng một phương thức thư viện giúp thêm tham số URL alt=media vào yêu cầu HTTP cơ bản.

Bạn phải uỷ quyền cho các tệp tải xuống bắt đầu từ ứng dụng của mình bằng một phạm vi cho phép quyền đọc nội dung tệp. Ví dụ: một ứng dụng sử dụng phạm vi drive.readonly.metadata không được phép tải nội dung tệp xuống. Mẫu mã này sử dụng phạm vi tệp "drive" bị hạn chế, cho phép người dùng xem và quản lý tất cả tệp của bạn trên Drive. Để tìm hiểu thêm về các phạm vi của Drive, hãy tham khảo bài viết Chọn các phạm vi của API Google Drive.

Người dùng có quyền owner (đối với tệp trong Drive của tôi) hoặc quyền organizer (đối với tệp trong bộ nhớ dùng chung) có thể hạn chế việc tải xuống thông qua đối tượng DownloadRestrictionsMetadata. Để biết thêm thông tin, hãy xem phần Ngăn người dùng tải xuống, in hoặc sao chép tệp.

Chỉ chủ sở hữu tệp mới có thể tải những tệp bị xác định là có hành vi sai trái (chẳng hạn như phần mềm độc hại) xuống. Ngoài ra, bạn phải thêm tham số truy vấn get acknowledgeAbuse=true để cho biết rằng người dùng đã xác nhận rủi ro khi tải phần mềm có thể không mong muốn hoặc các tệp có hành vi sai trái khác xuống. Ứng dụng của bạn phải tương tác để cảnh báo người dùng trước khi sử dụng tham số truy vấn này.

Tải xuống một phần

Tải xuống một phần là chỉ tải xuống một phần cụ thể của tệp. Bạn có thể chỉ định phần tệp mà bạn muốn tải xuống bằng cách sử dụng phạm vi byte với tiêu đề Range. Ví dụ:

Range: bytes=500-999

Tải nội dung tệp blob xuống ở phiên bản cũ hơn

Bạn chỉ có thể tải các bản sửa đổi nội dung tệp blob được đánh dấu là "Giữ vĩnh viễn" xuống. Nếu bạn muốn tải một bản sửa đổi xuống, trước tiên hãy đặt bản sửa đổi đó thành "Giữ vĩnh viễn". Để biết thêm thông tin, hãy xem phần Chỉ định phiên bản cần lưu để không bị xoá tự động.

Để tải nội dung của tệp blob xuống ở phiên bản trước, hãy sử dụng phương thức revisions.get cùng với mã nhận dạng của tệp cần tải xuống, mã nhận dạng của bản sửa đổi và tham số URL alt=media. Tham số URL alt=media cho máy chủ biết rằng một yêu cầu tải nội dung xuống đang được gửi dưới dạng một định dạng phản hồi thay thế. Tương tự như files.get, phương thức revisions.get cũng chấp nhận tham số truy vấn không bắt buộc acknowledgeAbuse và tiêu đề Range. Để biết thêm thông tin, hãy xem bài viết Quản lý các thao tác diễn ra trong thời gian dài.

Giao thức yêu cầu được minh hoạ tại đây.

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

Tải nội dung tệp blob xuống trong trình duyệt

Để tải nội dung của các tệp blob được lưu trữ trên Drive xuống trong một trình duyệt thay vì thông qua API, hãy sử dụng trường webContentLink của tài nguyên files. Nếu người dùng có quyền tải tệp xuống, thì một đường liên kết để tải tệp và nội dung của tệp xuống sẽ được trả về. Bạn có thể chuyển hướng người dùng đến URL này hoặc cung cấp URL này dưới dạng một đường liên kết có thể nhấp vào.

Tải nội dung tệp blob xuống trong các thao tác diễn ra trong thời gian dài

Để tải nội dung của tệp blob xuống trong các thao tác diễn ra trong thời gian dài, hãy sử dụng phương thức files.download cùng với mã nhận dạng của tệp cần tải xuống. Bạn có thể tuỳ ý đặt mã nhận dạng của bản sửa đổi. Đây là cách duy nhất để tải tệp Google Vids xuống. Để biết thêm thông tin, hãy xem bài viết Quản lý các thao tác diễn ra trong thời gian dài.

Xuất nội dung tài liệu trên Google Workspace

Để xuất nội dung byte của tài liệu trên Google Workspace, hãy sử dụng phương thức files.export cùng với mã nhận dạng của tệp cần xuất và loại MIME chính xác. Nội dung xuất ra bị giới hạn ở mức 10 MB.

Đoạn mã mẫu sau đây cho biết cách sử dụng phương thức files.export để xuất một tài liệu trên Google Workspace ở định dạng PDF bằng cách sử dụng thư viện ứng dụng Drive API:

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

Mẫu mã này sử dụng phạm vi drive bị hạn chế, cho phép người dùng xem và quản lý tất cả tệp của bạn trên Drive. Để tìm hiểu thêm về các phạm vi của Drive, hãy tham khảo bài viết Chọn các phạm vi của API Google Drive.

Mã mẫu cũng khai báo loại MIME xuất là application/pdf. Để xem danh sách đầy đủ tất cả các loại MIME xuất được hỗ trợ cho từng tài liệu trên Google Workspace, hãy tham khảo bài viết Các loại MIME xuất cho tài liệu trên Google Workspace.

Xuất nội dung tài liệu trên Google Workspace trong trình duyệt

Để xuất nội dung tài liệu trên Google Workspace trong trình duyệt, hãy sử dụng trường exportLinks của tài nguyên files. Tuỳ thuộc vào loại tài liệu, một đường liên kết để tải tệp và nội dung của tệp xuống sẽ được trả về cho mọi loại MIME có sẵn. Bạn có thể chuyển hướng người dùng đến một URL hoặc cung cấp URL đó dưới dạng một đường liên kết có thể nhấp.

Xuất nội dung tài liệu trên Google Workspace ở phiên bản cũ hơn trong trình duyệt

Để xuất nội dung tài liệu trên Google Workspace ở phiên bản cũ hơn trong trình duyệt, hãy sử dụng phương thức revisions.get cùng với mã nhận dạng của tệp cần tải xuống và mã nhận dạng của bản sửa đổi để tạo đường liên kết xuất mà bạn có thể tải xuống. Nếu người dùng có quyền tải tệp xuống, thì một đường liên kết để tải tệp và nội dung của tệp xuống sẽ được trả về. Bạn có thể chuyển hướng người dùng đến URL này hoặc cung cấp URL này dưới dạng một đường liên kết có thể nhấp vào.

Xuất nội dung tài liệu trên Google Workspace trong các thao tác kéo dài

Để xuất nội dung tài liệu trên Google Workspace trong các thao tác diễn ra trong thời gian dài, hãy sử dụng phương thức files.download cùng với mã nhận dạng của tệp cần tải xuống và mã nhận dạng của bản sửa đổi. Để biết thêm thông tin, hãy xem bài viết Quản lý các thao tác diễn ra trong thời gian dài.

Giới hạn cách chia sẻ tệp