Method: files.list

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

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

طلب HTTP

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

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

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

المَعلمات
corpora

string

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

enum (Corpus)

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

string

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

boolean

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

boolean

تم الإيقاف: استخدِم includeItemsFromAllDrives بدلاً من ذلك.
orderBy

string

تمثّل هذه السمة قائمة بمفاتيح ترتيب مفصولة بفواصل. المفاتيح الصالحة هي "createdTime" و"folder" و"modifiedByMeTime" و"modifiedTime" و"name" و"name_normal' و"quotaBytesUsed" و"recency" و"sharedWithMeTime" و"starred" و"viewedByMeTime". يتم ترتيب كل مفتاح تصاعديًا بشكل تلقائي، ولكن يمكن عكس ذلك باستخدام المُعدِّل "تنازلي". مثال على الاستخدام: ?orderBy=folder,modifiedTime sec,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.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 الملفات التي تمت مشاركتها مع نطاق المستخدم.