يسرد ملفات المستخدم.
تقبل هذه الطريقة المَعلمة 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' و'مجلد' و'modifiedByMeTime' و'modifiedTime' و'name' و'name_natural' و'quotaBytesUsed' و'recency' و'sharedWithMeTime' و'starred' و 'viewedByMeTime'. يعمل كل مفتاح على ترتيب تصاعدي تلقائيًا، ولكن يمكن عكسه باستخدام مفتاح التعديل "desc". مثال على الاستخدام: ?orderBy=مجلد,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 |
ما إذا كانت عملية البحث غير مكتملة إذا كانت القيمة هي true، قد تكون بعض نتائج البحث مفقودة، بسبب عدم البحث في جميع المستندات. ويمكن أن يحدث هذا عند البحث عن محركات أقراص متعددة باستخدام مجموعات "allDrives"، ولكن تعذّر البحث في جميع المجموعات. عندما يحدث ذلك، يتم اقتراح أن يقوم العملاء بتضييق نطاق طلب البحث عن طريق اختيار مجموعة نص مختلفة مثل "المستخدم" أو "الحملة". |
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.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 |
الملفات التي تمت مشاركتها مع نطاق المستخدم |