Method: files.list

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

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

طلب HTTP

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

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

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

المعلمات
corpora

string

محتوى العناصر (الملفات/المستندات) التي ينطبق عليها الطلب الهيئات المتوافقة هي default وdomain وdrive وallDrives. يُفضَّل استخدام default أو drive بدلاً من allDrives لتوفير الطاقة.
corpus
(deprecated)

enum (Corpus)

تم إيقافه نهائيًا: نص العناصر (الملفات/المستندات) التي ينطبق عليها طلب البحث استخدِم corpora بدلاً من ذلك.
driveId

string

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

boolean

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

boolean

تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام includeItemsFromAllDrives بدلاً منها.
maxResults

integer

الحد الأقصى لعدد الملفات التي سيتم عرضها في كل صفحة من الممكن أن تكون صفحات النتائج جزئية أو فارغة حتى قبل الوصول إلى نهاية قائمة الملفات.
orderBy

string

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

  • createdDate: وقت إنشاء الملف
  • folder: رقم تعريف المجلد يتم ترتيب هذا الحقل باستخدام الترتيب الأبجدي.
  • lastViewedByMeDate: آخر مرة شاهد فيها المستخدم الملف
  • modifiedByMeDate: آخر مرة عدّل فيها المستخدم الملف.
  • modifiedDate: آخر مرة عدَّل فيها أي مستخدم الملف
  • quotaBytesUsed: عدد وحدات البايت لمساحة التخزين المتوفّرة التي يستخدمها الملف
  • ‫recency: الطابع الزمني الأخير من حقول التاريخ والوقت في الملف
  • sharedWithMeDate: وقت مشاركة الملف مع المستخدم، إن أمكن.
  • starred: ما إذا كان المستخدم قد أعطى الملف علامة النجمة
  • title: عنوان الملف يتم ترتيب هذا الحقل باستخدام الترتيب الأبجدي، أي 1 و12 و2 و22.
  • title_natural: عنوان الملف يتم ترتيب هذا الحقل باستخدام ترتيب الترتيب الطبيعي، أي 1 و2 و12 و22.

يتم ترتيب كل مفتاح تصاعديًا تلقائيًا، ولكن يمكن عكسه باستخدام المُعدِّل desc. مثال على الاستخدام: ?orderBy=folder,modifiedDate desc,title.

يُرجى العِلم أنّ هناك قيدًا حاليًا على المستخدمين الذين لديهم مليون ملف تقريبًا يتم تجاهل ترتيب الترتيب المطلوب فيه.
pageToken

string

الرمز المميّز للصفحة للملفات
projection
(deprecated)

enum (Projection)

متوقّفة نهائيًا: لا تؤدي هذه المَعلمة أي وظيفة.
q

string

سلسلة طلب البحث للعثور على الملفات
spaces

string

قائمة مفصولة بفواصل للمساحات المطلوب البحث عنها القيم المسموح بها هي drive وappDataFolder.
supportsAllDrives

boolean

ما إذا كان التطبيق الذي يطلب الوصول يتيح استخدام كل من "ملفاتي" ومساحات التخزين السحابي المشتركة
supportsTeamDrives
(deprecated)

boolean

تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام supportsAllDrives بدلاً منها.
teamDriveId
(deprecated)

string

تم إيقاف هذه السياسة نهائيًا، لذا يُرجى استخدام driveId بدلاً منها.
includePermissionsForView

string

تُحدِّد أذونات العرض الإضافية المطلوب تضمينها في الاستجابة. يُسمح فقط بالقيمة published.
includeLabels

string

قائمة مفصولة بفواصل بأرقام تعريف التصنيفات المطلوب تضمينها في الجزء labelInfo من الاستجابة

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

قائمة بالملفات

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string,
  "items": [
    {
      object (File)
    }
  ]
}
الحقول
nextPageToken

string

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

string

يكون هذا الخيار دائمًا drive#fileList.
etag

string

علامة ETag للقائمة.
items[]

object (File)

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

نطاقات التفويض

يتطلب أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • 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

تكون بعض النطاقات محظورة وتتطلّب تقييم أمان ليتمكّن تطبيقك من استخدامها. لمزيد من المعلومات، يمكنك الاطّلاع على دليل التفويض.

الجزء الأساسي

عمليات التعداد
DEFAULT العناصر التي وصل إليها المستخدم
DOMAIN العناصر التي تمت مشاركتها مع نطاق المستخدم