Method: files.list

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

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

تعرض هذه الطريقة جميع الملفات تلقائيًا، بما في ذلك الملفات المحذوفة إلى المهملات. إذا كنت لا تريد ظهور الملفات المحذوفة إلى المهملات في القائمة، استخدِم مَعلمة طلب البحث trashed=false لإزالة الملفات المحذوفة إلى المهملات من النتائج.

طلب HTTP

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

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

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

المعلمات
corpora

string

تحدِّد هذه المَعلمة مجموعة من العناصر (الملفات أو المستندات) التي ينطبق عليها طلب البحث. تشمل العناصر المتوافقة ما يلي:

  • user
  • domain
  • drive
  • allDrives

لتحقيق الكفاءة، يُفضَّل استخدام user أو drive بدلاً من allDrives. تكون قيمة `corpora` تلقائيًا هي user. ومع ذلك، يمكن أن تتغيّر هذه القيمة استنادًا إلى الفلتر الذي تم ضبطه من خلال المَعلمة q. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة تنظيم الملفات.
corpus
(deprecated)

enum (Corpus)

تم إيقاف هذه المَعلمة: مصدر الملفات المطلوب إدراجها. استخدِم corpora بدلاً منها.
driveId

string

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

boolean

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

boolean

تم إيقاف هذه المَعلمة: استخدِم includeItemsFromAllDrives بدلاً منها.
orderBy

string

قائمة قيم مفصولة بفاصلة لمفاتيح الترتيب المفاتيح الصالحة هي:

  • createdTime: وقت إنشاء الملف تجنَّب استخدام هذا المفتاح لطلبات البحث عن مجموعات كبيرة من العناصر لأنّ ذلك قد يؤدي إلى انتهاء المهلة أو حدوث مشاكل أخرى. لإجراء ترتيب مرتبط بالوقت على مجموعات كبيرة من العناصر، استخدِم modifiedTime desc بدلاً من ذلك.
  • folder: رقم تعريف المجلد يتم ترتيب هذا الحقل باستخدام الترتيب الأبجدي.
  • modifiedByMeTime: آخر مرة عدّل فيها المستخدِم الملف
  • modifiedTime: آخر مرة عدّل فيها أي مستخدِم الملف
  • name: اسم الملف يتم ترتيب هذا الحقل باستخدام الترتيب الأبجدي، لذا يكون الترتيب على النحو التالي: 1 و12 و2 و22.
  • name_natural: اسم الملف يتم ترتيب هذا الحقل باستخدام الترتيب الطبيعي، لذا يكون الترتيب على النحو التالي: 1 و2 و12 و22.
  • quotaBytesUsed: عدد وحدات البايت لمساحة التخزين المتوفّرة التي يستخدمها الملف
  • recency: أحدث طابع زمني من حقول التاريخ والوقت في الملف
  • sharedWithMeTime: وقت مشاركة الملف مع المستخدِم، إذا انطبق ذلك
  • starred: تحديد ما إذا كان المستخدِم قد وضع نجمة على الملف
  • viewedByMeTime: آخر مرة عرض فيها المستخدِم الملف

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

integer

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

إذا لم يتم تحديد هذه المَعلمة، يتم عرض 100 ملف على الأكثر لمساحات التخزين السحابي المشتركة، والقائمة الكاملة للملفات لمساحات التخزين السحابي غير المشتركة.

الحد الأقصى للقيمة هو 100، ويتم تغيير القيم التي تزيد عن 100 إلى 100.
pageToken

string

الرمز المميّز لمتابعة طلب قائمة سابق في الصفحة التالية يجب ضبط هذه المَعلمة على قيمة nextPageToken من الاستجابة السابقة.
q

string

طلب بحث لفلترة نتائج الملفات للتعرّف على البنية المتوافقة، يُرجى الاطّلاع على مقالة البحث عن الملفات والمجلدات.
spaces

string

قائمة قيم مفصولة بفاصلة للمساحات المطلوب البحث عنها ضمن الأجزاء الأساسية. القيم المسموح بها هي drive وappDataFolder. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة تنظيم الملفات.
supportsAllDrives

boolean

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

boolean

تم إيقاف هذه المَعلمة: استخدِم supportsAllDrives بدلاً منها.
teamDriveId
(deprecated)

string

تم إيقاف هذه المَعلمة: استخدِم driveId بدلاً منها.
includePermissionsForView

string

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

string

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

نص الطلب

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

نص الاستجابة

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

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

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

object (File)

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

string

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

string

يحدّد نوع هذا المورد. القيمة: السلسلة الثابتة "drive#fileList"

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

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

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • 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

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

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

عمليات التعداد
user الملفات التي يملكها المستخدِم أو التي تمت مشاركتها معه
domain الملفات التي تمت مشاركتها مع نطاق المستخدِم