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