تنزيل الملفات وتصديرها

تتيح واجهة 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

لتنزيل ملف كائن ثنائي كبير مخزَّن على Drive، استخدِم طريقة files.get مع معرّف الملف المطلوب تنزيله ومعلَمة عنوان URL alt=media. تُعلم مَعلمة عنوان URL ‏alt=media الخادم بأنّه يتم طلب تنزيل المحتوى كتنسيق ردّ بديل.

مَعلمة عنوان URL alt=media هي مَعلمة نظام متاحة في جميع واجهات Google REST API. إذا كنت تستخدم مكتبة برامج لواجهة 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
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;
        }
    }
}

يستخدم نموذج الرمز البرمجي هذا طريقة مكتبة تضيف مَعلمة عنوان 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 في إصدار سابق، استخدِم طريقة revisions.get مع رقم تعريف الملف المطلوب تنزيله ورقم تعريف المراجعة ومعلَمة عنوان URL alt=media. تُعلم مَعلمة عنوان URL alt=media الخادم بأنّه يتم طلب تنزيل المحتوى كتنسيق رد بديل. على غرار files.get، تقبل الطريقة revisions.get أيضًا مَعلمة طلب البحث الاختيارية acknowledgeAbuse والعنوان Range. لمزيد من المعلومات، راجِع مقالة إدارة العمليات الطويلة الأمد.

يظهر هنا بروتوكول الطلب.

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

تنزيل محتوى ملف blob في متصفّح

لتنزيل محتوى ملفات blob المخزّنة على Drive في متصفّح بدلاً من تنزيلها من خلال واجهة برمجة التطبيقات، استخدِم الحقل webContentLink الخاص بمورد files. إذا كان لدى المستخدم إذن بتنزيل الملف، سيتم عرض رابط لتنزيل الملف ومحتواه. يمكنك إما إعادة توجيه المستخدم إلى عنوان URL هذا أو تقديمه كرابط قابل للنقر.

تنزيل محتوى ملف كائن ثنائي كبير الحجم أثناء العمليات الطويلة الأمد

لتنزيل محتوى ملفات 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
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;
        }
    }
}

يستخدم نموذج الرمز هذا النطاق 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 مع معرّف الملف المطلوب تنزيله ومعرّف المراجعة. لمزيد من المعلومات، يُرجى الاطّلاع على إدارة العمليات الطويلة الأمد.

حصر طريقة مشاركة الملفات