דף זה תורגם על ידי Cloud Translation API.

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

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

פעולות הורדה

תוכן של קובץ Blob באמצעות השיטה files.get עם פרמטר כתובת ה-URL alt=media.

תוכן קובץ ה-Blob בגרסה קודמת באמצעות השיטה revisions.get עם פרמטר כתובת ה-URL alt=media.

תוכן קובץ Blob בדפדפן באמצעות השדה webContentLink.

תוכן של קובץ Blob באמצעות השיטה files.download במהלך פעולות ממושכות. זו הדרך היחידה להוריד קבצים של Google Vids.

ייצוא פעולות

תוכן של מסמך Google Workspace בפורמט שהאפליקציה יכולה לטפל בו, באמצעות השיטה files.export.

תוכן של מסמך Google Workspace בדפדפן באמצעות השדה exportLinks.

תוכן של מסמך Google Workspace בגרסה קודמת בדפדפן באמצעות השדה exportLinks.

תוכן של מסמך Google Workspace באמצעות השיטה files.download במהלך פעולות ארוכות טווח.

לפני שמורידים או מייצאים תוכן של קובץ, צריך לוודא שהמשתמשים יכולים להוריד את הקובץ באמצעות השדה capabilities.canDownload במשאב files.

תיאורים של סוגי הקבצים שמוזכרים כאן, כולל קובצי blob וקובצי Google Workspace, מופיעים במאמר סוגי קבצים.

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

הורדת תוכן של קובץ blob

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

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

בדוגמת הקוד הבאה מוצג שימוש בשיטה files.get כדי להוריד קובץ באמצעות ספריות הלקוח של Drive API.

Java

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

הצגת הקוד ב-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

הצגת הקוד ב-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

הצגת הקוד ב-GitHub

/**
 * Downloads a file
 * @param{string} realFileId file ID
 * @return{obj} file status
 * */
async function downloadFile(realFileId) {
  // Get credentials and build service
  // TODO (developer) - Use appropriate auth mechanism for your app

  const {GoogleAuth} = require('google-auth-library');
  const {google} = require('googleapis');

  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });
  const service = google.drive({version: 'v3', auth});

  fileId = realFileId;
  try {
    const file = await service.files.get({
      fileId: fileId,
      alt: 'media',
    });
    console.log(file.status);
    return file.status;
  } catch (err) {
    // TODO(developer) - Handle error
    throw err;
  }
}

PHP

drive/snippets/drive_v3/src/DriveDownloadFile.php

הצגת הקוד ב-GitHub

use Google\Client;
use Google\Service\Drive;
function downloadFile()
 {
    try {

      $client = new Client();
      $client->useApplicationDefaultCredentials();
      $client->addScope(Drive::DRIVE);
      $driveService = new Drive($client);
      $realFileId = readline("Enter File Id: ");
      $fileId = '0BwwA4oUTeiV1UVNwOHItT0xfa2M';
      $fileId = $realFileId;
      $response = $driveService->files->get($fileId, array(
          'alt' => 'media'));
      $content = $response->getBody()->getContents();
      return $content;

    } catch(Exception $e) {
      echo "Error Message: ".$e;
    }

}

‎.NET

drive/snippets/drive_v3/DriveV3Snippets/DownloadFile.cs

הצגת הקוד ב-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;
        }
    }
}

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

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

משתמשים עם הרשאות owner (לקבצים בתיקייה 'האחסון שלי') או עם הרשאות organizer (לקבצים בתיקיות אחסון שיתופי) יכולים להגביל את ההורדה באמצעות האובייקט DownloadRestrictionsMetadata. מידע נוסף זמין במאמר בנושא איך מונעים ממשתמשים להוריד, להדפיס או להעתיק את הקובץ.

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

הורדה חלקית

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

Range: bytes=500-999

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

אפשר להוריד רק גרסאות של תוכן קובץ Blob שסומנו כ'שמירה לתמיד'. כדי להוריד גרסה, קודם צריך להגדיר אותה כ'שמירה לתמיד'. מידע נוסף זמין במאמר ציון גרסאות שיש לשמור כדי למנוע מחיקה אוטומטית.

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

כאן מוצג פרוטוקול הבקשה.

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

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

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

הורדת תוכן של קובץ blob במהלך פעולות לטווח ארוך

כדי להוריד את התוכן של קובצי blob במהלך פעולות ארוכות טווח, משתמשים בשיטה files.download עם המזהה של הקובץ להורדה. אפשר גם להגדיר את מזהה הגרסה. זו הדרך היחידה להוריד קבצים של Google Vids. מידע נוסף זמין במאמר ניהול פעולות ממושכות.

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

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

בדוגמת הקוד הבאה מוצג איך להשתמש בשיטה files.export כדי לייצא מסמך של Google Workspace בפורמט PDF באמצעות ספריות הלקוח של Drive API:

Java

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

הצגת הקוד ב-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

הצגת הקוד ב-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

הצגת הקוד ב-GitHub

/**
 * Download a Document file in PDF format
 * @param{string} fileId file ID
 * @return{obj} file status
 * */
async function exportPdf(fileId) {
  const {GoogleAuth} = require('google-auth-library');
  const {google} = require('googleapis');

  // Get credentials and build service
  // TODO (developer) - Use appropriate auth mechanism for your app
  const auth = new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/drive',
  });
  const service = google.drive({version: 'v3', auth});

  try {
    const result = await service.files.export({
      fileId: fileId,
      mimeType: 'application/pdf',
    });
    console.log(result.status);
    return result;
  } catch (err) {
    // TODO(developer) - Handle error
    throw err;
  }
}

PHP

drive/snippets/drive_v3/src/DriveExportPdf.php

הצגת הקוד ב-GitHub

use Google\Client;
use Google\Service\Drive;
function exportPdf()
{
    try {
        $client = new Client();
        $client->useApplicationDefaultCredentials();
        $client->addScope(Drive::DRIVE);
        $driveService = new Drive($client);
        $realFileId = readline("Enter File Id: ");
        $fileId = '1ZdR3L3qP4Bkq8noWLJHSr_iBau0DNT4Kli4SxNc2YEo';
        $fileId = $realFileId;
        $response = $driveService->files->export($fileId, 'application/pdf', array(
            'alt' => 'media'));
        $content = $response->getBody()->getContents();
        return $content;

    }  catch(Exception $e) {
         echo "Error Message: ".$e;
    }

}

‎.NET

drive/snippets/drive_v3/DriveV3Snippets/ExportPdf.cs

הצגת הקוד ב-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;
        }
    }
}

בדוגמת הקוד הזו נעשה שימוש בהיקף drive מוגבל שמאפשר למשתמשים להציג ולנהל את כל הקבצים ב-Drive. מידע נוסף על היקפי גישה ב-Drive זמין במאמר בחירת היקפי גישה ב-Google 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 הזו או להציע אותה כקישור שאפשר ללחוץ עליו.

ייצוא תוכן של מסמכים ב-Google Workspace במהלך פעולות ארוכות טווח

כדי לייצא תוכן של מסמך Google Workspace במהלך פעולות ארוכות טווח, משתמשים בשיטה files.download עם מזהה הקובץ להורדה ומזהה הגרסה. מידע נוסף זמין במאמר בנושא ניהול פעולות ממושכות.

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

הורדת תוכן של קובץ blob

Java

Python

Node.js

PHP

‎.NET

הורדה חלקית

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

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

הורדת תוכן של קובץ blob במהלך פעולות לטווח ארוך

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

Java

Python

Node.js

PHP

‎.NET

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

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

ייצוא תוכן של מסמכים ב-Google Workspace במהלך פעולות ארוכות טווח

הגבלת היכולת לשתף את הקבצים

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