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

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

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

הורדות

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

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

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

ייצוא

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

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

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

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

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

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

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

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

דוגמת הקוד הבאה מראה איך להשתמש ב-method 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;
        }
    }
}

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

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

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

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

הורדה חלקית

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

Range: bytes=500-999

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

כדי להוריד את התוכן של קובצי blob בגרסה קודמת, צריך להשתמש ב revisions.get עם המזהה של הקובץ להורדה, מזהה הגרסה ופרמטר alt=media של כתובת האתר. הפרמטר 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

הצגת הקוד ב-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 הזו או להציע אותה בתור קישור שניתן ללחוץ עליו קישור.

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

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

Java

Python

Node.js

PHP

‎.NET

הורדה חלקית

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

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

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

Java

Python

Node.js

PHP

‎.NET

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

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

נושאים קשורים