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=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 
{
  "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.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 العناصر التي تمت مشاركتها مع نطاق المستخدم.