يسرد ملفات المستخدم.
تقبل هذه الطريقة المعلَمة q
، وهي عبارة عن طلب بحث يجمع عبارة واحدة أو أكثر من عبارات البحث. للمزيد من المعلومات، يُرجى الاطّلاع على دليل البحث عن الملفات والمجلدات.
طلب HTTP
GET https://www.googleapis.com/drive/v3/files
يستخدِم عنوان URL بنية تحويل ترميز gRPC.
معلمات طلب البحث
المَعلمات | |
---|---|
corpora |
مجموعات العناصر (الملفات/المستندات) التي ينطبق عليها طلب البحث النصوص المتوافقة هي "user" و"domain" و"drive" و"allDrives". أفضّل "user" أو "drive" على "allDrives" لتحقيق الكفاءة. يتم ضبط المجموعة تلقائيًا على "المستخدم". ومع ذلك، يمكن أن يتغيّر ذلك حسب الفلتر المحدَّد من خلال المَعلمة 'q'. |
corpus |
متوقّف نهائيًا: مصدر الملفات المطلوب إدراجها. استخدِم "corpora" بدلاً من ذلك. |
driveId |
رقم تعريف مساحة التخزين السحابي المشتركة للبحث |
includeItemsFromAllDrives |
يمكنك اختيار ما إذا كان يجب تضمين كل من "ملفاتي" والعناصر في مساحة التخزين السحابي المشتركة في النتائج. |
includeTeamDriveItems |
متوقّفة نهائيًا: يمكنك استخدام |
orderBy |
قائمة بمفاتيح الترتيب مفصولة بفواصل. المفاتيح الصالحة هي "CreateTime" و"folder" و"modifiedByMeTime" و"modifiedTime" و"name" و"name_natural" و"quotaBytesUsed" و"recency" و"sharedWithMeTime" و"starred" و"viewedByMeTime". يعمل كل مفتاح على الترتيب تصاعديًا تلقائيًا، ولكن يمكن عكسه باستخدام مفتاح التعديل "تنازلي". مثال على الاستخدام: ?orderBy=folder,modifiedTime desc,name. |
pageSize |
الحد الأقصى لعدد الملفات المطلوب عرضها في كل صفحة. ويمكن أن تظهر صفحات نتائج جزئية أو فارغة حتى قبل الوصول إلى نهاية قائمة الملفات. |
pageToken |
الرمز المميّز لمتابعة طلب قائمة سابق في الصفحة التالية يجب ضبط هذه القيمة على قيمة "nextPageToken" من الاستجابة السابقة. |
q |
استعلام لفلترة نتائج الملف. يمكنك الاطّلاع على دليل "البحث عن الملفات والمجلدات" لمعرفة البنية المتوافقة. |
spaces |
قائمة بمسافات مفصولة بفواصل للاستعلام داخل المجموعة. القيمتان المسموح بإدراجهما هما "drive" و"appDataالمجلد". |
supportsAllDrives |
ما إذا كان التطبيق الذي يقدّم الطلب متوافقًا مع كل من "ملفاتي" ومساحات التخزين السحابي المشتركة. |
supportsTeamDrives |
متوقّفة نهائيًا: يمكنك استخدام |
teamDriveId |
متوقّفة نهائيًا: يمكنك استخدام |
includePermissionsForView |
تحدد أذونات الملف الشخصي الإضافية التي يتم تضمينها في الرد. يمكن استخدام الحالة "المنشورة" فقط. |
includeLabels |
قائمة مفصولة بفواصل تضم معرّفات التصنيفات المراد تضمينها في الجزء |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
قائمة بالملفات.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"nextPageToken": string,
"kind": string,
"incompleteSearch": boolean,
"files": [
{
object ( |
الحقول | |
---|---|
nextPageToken |
الرمز المميز للصفحة للصفحة التالية من الملفات. لن يظهر هذا الخيار في حال الوصول إلى نهاية قائمة الملفات. وإذا تم رفض الرمز المميز لأي سبب من الأسباب، يجب تجاهله وإعادة تشغيل التقسيم على صفحات من الصفحة الأولى من النتائج. يكون الرمز المميز للصفحة عادةً صالحًا لعدة ساعات. ومع ذلك، قد تختلف النتائج المتوقّعة في حال إضافة عناصر جديدة أو إزالتها. |
kind |
تحدد نوع هذا المورد. القيمة: السلسلة الثابتة |
incompleteSearch |
ما إذا كانت عملية البحث غير مكتملة. إذا كانت الإجابة صحيحة، قد يعني ذلك أنّ بعض نتائج البحث قد تكون مفقودة، لأنّه لم يتم البحث في جميع المستندات. يمكن أن يحدث ذلك عند البحث في عدة مساحات تخزين سحابي باستخدام مجموعة "allDrives"، ولكن يتعذّر البحث في جميع المجموعات. عندما يحدث هذا، نقترح أن يقوم العملاء بتضييق نطاق الاستعلام الخاص بهم عن طريق اختيار مجموعة مختلفة مثل 'user' أو 'drive'. |
files[] |
قائمة الملفات. في حال تعبئة 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 |
الملفات التي تمت مشاركتها مع نطاق المستخدم. |