Method: files.list

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

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

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

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

المَعلمات
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 dis,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 العناصر التي تمت مشاركتها في نطاق المستخدم.