הורדה וייצוא של קבצים

קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

ממשק ה-API של Google Drive תומך בכמה סוגים של פעולות הורדה וייצוא, כפי שמפורט בטבלה הבאה:

הורדות
תוכן של קובץ blob בשיטה files.get עם הפרמטר של כתובת ה-URL מסוג alt=media.
להשתמש בתוכן של קובץ Blob בגרסה קודמת באמצעות השיטה revisions.get עם הפרמטר alt=media של כתובת ה-URL.
תוכן של קובץ Blob בדפדפן באמצעות השדה webContentLink.
ייצוא
תוכן של מסמך ב-Google Workspace בפורמט שבו האפליקציה יכולה לטפל, באמצעות files.export.
התוכן של מסמכי Google Workspace בדפדפן מתבצע באמצעות השדה exportLinks.
אפשר להשתמש בתוכן של Google Workspace בגרסה קודמת בדפדפן באמצעות השדה exportLinks.

בהמשך המדריך מופיעות הוראות מפורטות לביצוע פעולות ההורדה והייצוא.

הורדת תוכן מ-blob

כדי להוריד קובץ blob שמאוחסן ב-Drive, צריך להשתמש בשיטה files.get עם מזהה הקובץ להורדה ובפרמטר alt=media של כתובת ה-URL. הפרמטר של כתובת האתר alt=media מודיע לשרת שמתקבלת בקשה להורדת תוכן כפורמט חלופי של תגובה.

הפרמטר של כתובת האתר alt=media הוא פרמטר המערכת שזמין בכל ממשקי ה-API ל-REST של Google. אם אתם משתמשים בספריית לקוחות ב-Drive API, אין צורך להגדיר את הפרמטר הזה באופן מפורש.

בדוגמת הקוד הבאה מוסבר איך להשתמש בשיטה files.get כדי להוריד קובץ עם ספריות הלקוח של 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
from __future__ import print_function

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

דוגמת הקוד הזו משתמשת בשיטת ספרייה המוסיפה את פרמטר כתובת האתר alt=media לבקשת ה-HTTP הבסיסית.

להורדות של קבצים מהאפליקציה שלכם צריכה להיות הרשאה של הרשאות ברמת קריאה, שמאפשרת גישה לתוכן הקובץ. לדוגמה, לאפליקציה שההיקף שלה הוא drive.readonly.metadata אין הרשאה להוריד את תוכן הקובץ. דוגמת הקוד הזו מנצלת את טווח הקבצים המוגבל ב-Drive, שמאפשר למשתמשים להציג ולנהל את כל הקבצים שלכם ב-Drive. למידע נוסף על ההיקפים של Drive, קראו את המאמר מידע על הרשאות וממשקי API ספציפיים ל-API.

משתמשים עם הרשאות עריכה יכולים להגביל את ההורדה על ידי משתמשים עם קריאה בלבד על ידי הגדרת השדה copyRequiresWriterPermission ל-false.

קבצים שזוהו פוגעניים (כמו תוכנות מזיקות) זמינים להורדה רק על ידי בעלי הקבצים. כמו כן, יש לכלול את פרמטר השאילתה get acknowledgeAbuse=true כדי לציין שהמשתמש הסכים להוריד תוכנות שעלולות להיות בלתי רצויות או קבצים פוגעניים אחרים. האפליקציה שלכם צריכה להזהיר את המשתמש באופן אינטראקטיבי לפני השימוש בפרמטר השאילתה הזה.

הורדה חלקית

הורדה חלקית כרוכה בהורדה רק של חלק מסוים בקובץ. ניתן לציין את החלק בקובץ שרוצים להוריד באמצעות טווח בייט, עם הכותרת Range. למשל:

Range: bytes=500-999

הורדת תוכן של blob בגרסה קודמת

כדי להוריד תוכן של קובצי blob בגרסה קודמת, יש להשתמש בשיטה revisions.get עם מזהה הקובץ להורדה, במזהה הגרסה הקודמת ובפרמטר alt=media של כתובת ה-URL. הפרמטר של כתובת ה-URL alt=media מודיע לשרת שמתקבלת בקשה להורדת תוכן כפורמט תגובה חלופי. בדומה לשיטה files.get, שיטת revisions.get מקבלת גם את פרמטר השאילתה האופציונלי acknowledgeAbuse ואת הכותרת Range. למידע נוסף על הורדת גרסאות קודמות, לחצו על הורדה ופרסום של גרסאות קבצים.

הורדת תוכן של blob בדפדפן

כדי להוריד את התוכן של קובצי blob ששמורים ב-Drive בדפדפן, ולא דרך ה-API, צריך להשתמש בשדה webContentLink במשאב Files. אם למשתמש יש גישת הורדה לקובץ, יוחזר קישור להורדת הקובץ והתוכן שלו. אתם יכולים להפנות את המשתמש לכתובת ה-URL הזו, או להציע אותה כקישור שניתן ללחוץ עליו.

ייצוא תוכן המסמך מ-Google Workspace

כדי לייצא תוכן בייטים של מסמכי Google Workspace, יש להשתמש בשיטה files.export עם מזהה הקובץ לייצוא ובסוג ה-MIME הנכון. התוכן המיוצא מוגבל ל-10MB.

בדוגמת הקוד הבאה מוסבר איך משתמשים בשיטה files.export כדי לייצא מסמך Google Workspace בפורמט PDF באמצעות ספריות הלקוח של 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
from __future__ import print_function

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

דוגמת הקוד הזו משתמשת בהיקף המוגבל של drive, שמאפשר למשתמשים להציג ולנהל את כל הקבצים שלכם ב-Drive. למידע נוסף על ההיקפים של Drive, קראו את המאמר מידע על הרשאה ואימות ספציפיים ל-API.

דוגמת הקוד גם מצהירה על סוג ה-MIME של הייצוא בתור application/pdf. רשימה מלאה של כל סוגי ה-MIME לייצוא שנתמכים בכל מסמך של Google Workspace זמינה במאמר ייצוא סוגי MIME למסמכי Google Workspace.

ייצוא תוכן של מסמכים מ-Google Workspace בדפדפן

כדי לייצא תוכן של מסמכים מ-Google Workspace בתוך דפדפן, צריך להשתמש בשדה exportLinks של המשאב Files. בהתאם לסוג המסמך, הקישור להורדת הקובץ והתוכן שלו מוחזרים לכל סוג MIME שזמין. אתם יכולים להפנות את המשתמש לכתובת URL, או להציע אותה כקישור שניתן ללחוץ עליו.

ייצוא התוכן של מסמכי Google Workspace מגרסה קודמת של הדפדפן

כדי לייצא תוכן של מסמכים מ-Google Workspace בגרסה קודמת בדפדפן, יש להשתמש בשיטה revisions.get עם מזהה הקובץ להורדה ומזהה הגרסה הקודמת. אם למשתמש יש גישת הורדה לקובץ, יוחזר קישור להורדת הקובץ והתוכן שלו. אתם יכולים להפנות את המשתמש לכתובת ה-URL הזו, או להציע אותה כקישור שניתן ללחוץ עליו.