Method: files.list

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

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

طلب HTTP

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

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

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

المعلمات
corpora

string

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

enum (Corpus)

مهمل: مصدر الملفات المطلوب إدراجها. استخدام 'corpora' بدلاً من ذلك.
driveId

string

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

boolean

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

boolean

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

string

قائمة مفصولة بفواصل لمفاتيح الترتيب في ما يلي المفاتيح الصالحة:

  • createdTime: وقت إنشاء الملف
  • folder: رقم تعريف المجلد ويتم ترتيب هذا الحقل حسب الترتيب الأبجدي.
  • modifiedByMeTime: آخر مرة عدّل فيها المستخدم الملف.
  • modifiedTime: آخر مرة عدَّل فيها أي مستخدم الملف
  • name: اسم الملف يتم ترتيب هذا الحقل باستخدام الترتيب الأبجدي، أي 1 و12 و2 و22.
  • name_natural: اسم الملف يتم فرز هذا الحقل باستخدام ترتيب الفرز الطبيعي، لذا 1، 2، 12، 22.
  • quotaBytesUsed: عدد وحدات البايت لمساحة التخزين المتوفّرة التي يستخدمها الملف
  • recency: أحدث طابع زمني من حقول التاريخ والوقت للملف
  • sharedWithMeTime: وقت مشاركة الملف مع المستخدم، إذا كان ذلك منطبقًا
  • starred: ما إذا كان المستخدم قد ميّز الملف بنجمة
  • viewedByMeTime: آخر مرة شاهد فيها المستخدم الملف.

يتم ترتيب كل مفتاح تصاعديًا تلقائيًا، ولكن يمكن عكسه باستخدام المُعدِّل desc. مثال على الاستخدام: ?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.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 الملفات التي تمت مشاركتها مع نطاق المستخدم