Method: files.list

فایل های کاربر را لیست می کند.

این روش پارامتر q را می پذیرد، که عبارت جستجویی است که یک یا چند عبارت جستجو را ترکیب می کند. برای اطلاعات بیشتر، راهنمای جستجوی فایل‌ها و پوشه‌ها را ببینید.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
corpora

string

بدنه موارد (فایل ها/اسناد) که پرس و جو در مورد آنها اعمال می شود. بدنه های پشتیبانی شده عبارتند از 'user'، 'domain'، 'drive' و 'allDrives'. برای کارایی، «user» یا «drive» را به «allDrives» ترجیح دهید. به طور پیش فرض، corpora روی 'user' تنظیم شده است. با این حال، این می تواند بسته به فیلتر تنظیم شده از طریق پارامتر 'q' تغییر کند.

corpus
(deprecated)

enum ( Corpus )

منسوخ شده: منبع فایل هایی که باید فهرست شوند. به جای آن از «corpora» استفاده کنید.

driveId

string

شناسه درایو مشترک برای جستجو.

includeItemsFromAllDrives

boolean

آیا هر دو مورد My Drive و درایو مشترک باید در نتایج گنجانده شوند یا خیر.

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

اینکه آیا برنامه درخواست کننده هم از My Drives و هم درایوهای مشترک پشتیبانی می کند.

supportsTeamDrives
(deprecated)

boolean

منسوخ شده: به جای آن از supportsAllDrives استفاده کنید.

teamDriveId
(deprecated)

string

منسوخ شده: به جای آن از driveId استفاده کنید.

includePermissionsForView

string

مشخص می کند که کدام مجوزهای اضافی در پاسخ گنجانده شود. فقط "منتشر شده" پشتیبانی می شود.

includeLabels

string

فهرستی از شناسه‌های برچسب‌هایی که با کاما از هم جدا شده‌اند تا در قسمت labelInfo پاسخ قرار داده شوند.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

لیستی از فایل ها

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی داده هایی با ساختار زیر است:

نمایندگی JSON 
{
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean,
  "files": [
    {
      object (File)
    }
  ]
}
فیلدها
nextPageToken

string

نشانه صفحه برای صفحه بعدی فایل ها. اگر به انتهای لیست فایل ها رسیده باشد، این مورد وجود ندارد. اگر توکن به هر دلیلی رد شد، باید دور انداخته شود و صفحه‌بندی باید از صفحه اول نتایج دوباره شروع شود. نشانه صفحه معمولاً برای چند ساعت معتبر است. با این حال، اگر موارد جدیدی اضافه یا حذف شوند، نتایج مورد انتظار شما ممکن است متفاوت باشد.

kind

string

مشخص می کند که این چه نوع منبعی است. مقدار: رشته ثابت "drive#fileList" .

files[]

object ( File )

لیست فایل ها اگر 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

برخی از دامنه ها محدود هستند و برای استفاده از برنامه شما به ارزیابی امنیتی نیاز دارند. برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

بدنه

Enums
user فایل های متعلق به کاربر یا به اشتراک گذاشته شده با آنها.
domain فایل های به اشتراک گذاشته شده در دامنه کاربر.