Method: files.list

تعرض هذه السمة ملفات المستخدم.

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

طلب HTTP

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

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

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

المعلمات
corpora

string

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

enum (Corpus)

تم إيقاف هذا الحقل نهائيًا: مصدر الملفات المطلوب إدراجها. استخدِم "مجموعات النصوص" بدلاً من ذلك.
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 
{
  "files": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean
}
الحقول
files[]

object (File)

قائمة الملفات إذا تم ملء nextPageToken، قد تكون هذه القائمة غير مكتملة ويجب استرداد صفحة إضافية من النتائج.
nextPageToken

string

الرمز المميز للصفحة التالية من الملفات. لن يظهر هذا الحقل إذا تم الوصول إلى نهاية قائمة الملفات. إذا تم رفض الرمز المميّز لأي سبب، يجب تجاهله وإعادة بدء التقسيم على صفحات من الصفحة الأولى من النتائج. يكون الرمز المميز للصفحة صالحًا عادةً لعدة ساعات. ومع ذلك، إذا تمت إضافة سلع جديدة أو إزالتها، قد تختلف النتائج المتوقّعة.
kind

string

تحدّد نوع المورد. القيمة: السلسلة الثابتة "drive#fileList".

نطاقات الأذونات

يجب توفير أحد نطاقات 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 الملفات التي تمت مشاركتها مع نطاق المستخدم