Method: files.list

تعرض هذه السمة ملفات المستخدم.

تقبل هذه الطريقة المَعلمة q، وهي طلب بحث يجمع بين عبارة بحث واحدة أو أكثر. لمزيد من المعلومات، يُرجى الاطّلاع على دليل البحث عن الملفات والمجلدات.

طلب HTTP

GET https://www.googleapis.com/drive/v2/files

يستخدِم عنوان URL بنية تحويل الترميز gRPC.

مَعلمات طلب البحث

المعلمات
corpora

string

تشير إلى نص العناصر (الملفات أو المستندات) التي ينطبق عليها طلب البحث. الأنواع المتوافقة هي default وdomain وdrive وallDrives. استخدِم default أو drive بدلاً من allDrives لتوفير الطاقة.
corpus
(deprecated)

enum (Corpus)

تم إيقافه نهائيًا: نص العناصر (الملفات/المستندات) التي ينطبق عليها طلب البحث. يمكنك استخدام corpora كبديل.
driveId

string

رقم تعريف مساحة التخزين السحابي المشتركة التي تريد البحث فيها
includeItemsFromAllDrives

boolean

تحديد ما إذا كان يجب تضمين عناصر "ملفاتي" ومساحة التخزين السحابي المشتركة في النتائج
includeTeamDriveItems
(deprecated)

boolean

تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة includeItemsFromAllDrives بدلاً منها.
maxResults

integer

الحد الأقصى لعدد الملفات التي سيتم عرضها في كل صفحة من المحتمل أن تكون صفحات النتائج جزئية أو فارغة حتى قبل الوصول إلى نهاية قائمة الملفات.
orderBy

string

تمثّل هذه المَعلمة قائمة مفصولة بفواصل لمفاتيح الترتيب. المفاتيح الصالحة هي:

  • createdDate: وقت إنشاء الملف
  • folder: رقم تعريف المجلد يتم ترتيب هذا الحقل باستخدام الترتيب الأبجدي.
  • lastViewedByMeDate: آخر مرة اطّلع فيها المستخدم على الملف
  • modifiedByMeDate: آخر مرة عدّل فيها المستخدم الملف.
  • modifiedDate: آخر مرة عدَّل فيها أي مستخدم الملف
  • quotaBytesUsed: عدد وحدات البايت لمساحة التخزين المتوفّرة التي يستخدمها الملف
  • recency: الطابع الزمني الأخير من حقول التاريخ والوقت في الملف
  • sharedWithMeDate: يشير إلى وقت مشاركة الملف مع المستخدم، إذا كان ذلك منطبقًا.
  • ‫starred: ما إذا كان المستخدم قد وضع نجمة على الملف.
  • title: عنوان الملف يتم ترتيب هذا الحقل أبجديًا، أي 1 و12 و2 و22.
  • title_natural: عنوان الملف يتم ترتيب هذا الحقل باستخدام ترتيب الفرز الطبيعي، أي 1 و2 و12 و22.

يتم ترتيب كل مفتاح تصاعديًا تلقائيًا، ولكن يمكن عكس الترتيب باستخدام المعدِّل "desc". مثال على الاستخدام: ?orderBy=folder,modifiedDate desc,title

يُرجى العِلم أنّ هناك قيودًا حالية على المستخدمين الذين لديهم مليون ملف تقريبًا، حيث يتم تجاهل ترتيب الفرز المطلوب.
pageToken

string

الرمز المميز للصفحة للملفات.
projection
(deprecated)

enum (Projection)

تم إيقافها نهائيًا: لا تعمل هذه المَعلمة.
q

string

سلسلة طلب البحث عن الملفات
spaces

string

قائمة مفصولة بفواصل تتضمّن المساحات المطلوب البحث فيها. القيمتان المسموح بإدراجهما هما drive وappDataFolder.
supportsAllDrives

boolean

تحديد ما إذا كان التطبيق الذي يطلب الوصول يتيح استخدام كل من "ملفاتي" ومساحات التخزين السحابي المشتركة
supportsTeamDrives
(deprecated)

boolean

تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة supportsAllDrives بدلاً منها.
teamDriveId
(deprecated)

string

تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام سياسة driveId بدلاً منها.
includePermissionsForView

string

تحدّد هذه السمة أذونات العرض الإضافية المطلوب تضمينها في الردّ. يُسمح فقط بالقيمة published.
includeLabels

string

قائمة مفصولة بفواصل تتضمّن معرّفات التصنيفات المطلوب تضمينها في الجزء labelInfo من الردّ.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

قائمة بالملفات

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "items": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string
}
الحقول
items[]

object (File)

قائمة الملفات إذا تم ملء nextPageToken، قد تكون هذه القائمة غير مكتملة ويجب استرداد صفحة إضافية من النتائج.
nextPageToken

string

الرمز المميز للصفحة التالية من الملفات. لن يظهر هذا الحقل إذا تم الوصول إلى نهاية قائمة الملفات. إذا تم رفض الرمز المميّز لأي سبب، يجب تجاهله وإعادة بدء التقسيم على صفحات من الصفحة الأولى من النتائج.
kind

string

يكون هذا الخيار drive#fileList دائمًا.
etag

string

تمثّل هذه السمة علامة ETag الخاصة بالقائمة.

نطاقات الأذونات

يجب توفير أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.meet.readonly
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.photos.readonly
  • https://www.googleapis.com/auth/drive.readonly

بعض النطاقات محظورة وتتطلّب إجراء تقييم أمان لتتمكّن من استخدامها في تطبيقك. لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

الجزء الأساسي

عمليات التعداد
DEFAULT العناصر التي وصل إليها المستخدم
DOMAIN العناصر التي تمت مشاركتها مع نطاق المستخدم