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' و'مجلد' و'modifiedByMeTime' و'modifiedTime' و'name' و'name_natural' و'quotaBytesUsed' و'recency' و'sharedWithMeTime' و'starred' و 'viewedByMeTime'. يعمل كل مفتاح على ترتيب تصاعدي تلقائيًا، ولكن يمكن عكسه باستخدام مفتاح التعديل "desc". مثال على الاستخدام: ?orderBy=مجلد,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.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 الملفات التي تمت مشاركتها مع نطاق المستخدم