Method: files.list

يسرد ملفات المستخدم.

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

طلب HTTP

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

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

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

المَعلمات
corpora

string

مجموعات العناصر (الملفات/المستندات) التي ينطبق عليها طلب البحث النصوص المتوافقة هي "user" و"domain" و"drive" و"allDrives". أفضّل "user" أو "drive" على "allDrives" لتحقيق الكفاءة. يتم ضبط المجموعة تلقائيًا على "المستخدم". ومع ذلك، يمكن أن يتغيّر ذلك حسب الفلتر المحدَّد من خلال المَعلمة 'q'.
corpus
(deprecated)

enum (Corpus)

متوقّف نهائيًا: مصدر الملفات المطلوب إدراجها. استخدِم "corpora" بدلاً من ذلك.
driveId

string

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

boolean

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

boolean

متوقّفة نهائيًا: يمكنك استخدام includeItemsFromAllDrives بدلاً منها.
orderBy

string

قائمة بمفاتيح الترتيب مفصولة بفواصل. المفاتيح الصالحة هي "CreateTime" و"folder" و"modifiedByMeTime" و"modifiedTime" و"name" و"name_natural" و"quotaBytesUsed" و"recency" و"sharedWithMeTime" و"starred" و"viewedByMeTime". يعمل كل مفتاح على الترتيب تصاعديًا تلقائيًا، ولكن يمكن عكسه باستخدام مفتاح التعديل "تنازلي". مثال على الاستخدام: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

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

string

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

string

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

string

قائمة بمسافات مفصولة بفواصل للاستعلام داخل المجموعة. القيمتان المسموح بإدراجهما هما "drive" و"appDataالمجلد".
supportsAllDrives

boolean

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

boolean

متوقّفة نهائيًا: يمكنك استخدام supportsAllDrives بدلاً منها.
teamDriveId
(deprecated)

string

متوقّفة نهائيًا: يمكنك استخدام driveId بدلاً منها.
includePermissionsForView

string

تحدد أذونات الملف الشخصي الإضافية التي يتم تضمينها في الرد. يمكن استخدام الحالة "المنشورة" فقط.
includeLabels

string

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

نص الطلب

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

نص الاستجابة

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

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

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

string

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

string

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

object (File)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات 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.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 الملفات التي تمت مشاركتها مع نطاق المستخدم.