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