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 وtitle_natural. يعمل كل مفتاح على ترتيب تصاعدي تلقائيًا، ولكن يمكن عكسه باستخدام مفتاح التعديل desc. مثال على الاستخدام: ?orderBy=مجلد,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 
{
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      object (File)
    }
  ]
}
الحقول
nextPageToken

string

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

string

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

string

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

object (File)

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

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

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