Method: files.list

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

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

این متد به طور پیش‌فرض همه فایل‌ها، از جمله فایل‌های حذف‌شده را برمی‌گرداند. اگر نمی‌خواهید فایل‌های حذف‌شده در لیست نمایش داده شوند، از پارامتر query trashed=false برای حذف فایل‌های حذف‌شده از نتایج استفاده کنید.

درخواست HTTP

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

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
corpora

string

مجموعه‌ای از اقلام (فایل‌ها یا اسناد) را که پرس‌وجو برای آنها اعمال می‌شود، مشخص می‌کند. اقلام پشتیبانی‌شده عبارتند از:

  • user
  • domain
  • drive
  • allDrives

برای کارایی بیشتر، گزینه user یا drive به allDrives ترجیح دهید. به طور پیش‌فرض، corpora روی user تنظیم شده است. با این حال، این می‌تواند بسته به فیلتری که از طریق پارامتر q تنظیم می‌شود، تغییر کند. برای اطلاعات بیشتر، به سازماندهی فایل مراجعه کنید.

corpus
(deprecated)

enum ( Corpus )

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

driveId

string

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

includeItemsFromAllDrives

boolean

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

includeTeamDriveItems
(deprecated)

boolean

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

orderBy

string

فهرستی از کلیدهای مرتب‌سازی که با کاما از هم جدا شده‌اند. کلیدهای معتبر عبارتند از:

  • createdTime : زمانی که فایل ایجاد شده است. از استفاده از این کلید برای پرس‌وجوها در مجموعه‌های بزرگ آیتم خودداری کنید زیرا ممکن است منجر به وقفه‌های زمانی یا سایر مشکلات شود. برای مرتب‌سازی مرتبط با زمان در مجموعه‌های بزرگ آیتم، به جای آن modifiedTime استفاده کنید.
  • folder : شناسه پوشه. این فیلد با استفاده از ترتیب حروف الفبا مرتب شده است.
  • modifiedByMeTime : آخرین باری که فایل توسط کاربر تغییر داده شده است.
  • modifiedTime : آخرین باری که فایل توسط کسی تغییر داده شده است.
  • name : نام فایل. این فیلد با استفاده از ترتیب حروف الفبا مرتب شده است، بنابراین ۱، ۱۲، ۲، ۲۲.
  • name_natural : نام فایل. این فیلد با استفاده از مرتب‌سازی طبیعی مرتب شده است، بنابراین ۱، ۲، ۱۲، ۲۲.
  • quotaBytesUsed : تعداد بایت‌های سهمیه ذخیره‌سازی استفاده‌شده توسط فایل.
  • recency : جدیدترین مهر زمانی از فیلدهای تاریخ-زمان فایل.
  • sharedWithMeTime : در صورت وجود، زمان اشتراک‌گذاری فایل با کاربر.
  • starred : مشخص می‌کند که آیا کاربر فایل را ستاره‌گذاری کرده است یا خیر.
  • viewedByMeTime : آخرین باری که فایل توسط کاربر مشاهده شده است.

هر کلید به طور پیش‌فرض به صورت صعودی مرتب‌سازی می‌کند، اما می‌توان با استفاده از اصلاح‌کننده desc را معکوس کرد. مثال کاربرد: ?orderBy=folder,modifiedTime desc,name .

pageSize

integer

حداکثر تعداد فایل‌هایی که در هر صفحه برگردانده می‌شوند. صفحات نتیجه ناقص یا خالی حتی قبل از رسیدن به انتهای لیست فایل‌ها امکان‌پذیر است.

pageToken

string

توکن برای ادامه درخواست لیست قبلی در صفحه بعد. این باید روی مقدار nextPageToken از پاسخ قبلی تنظیم شود.

q

string

یک پرس‌وجو برای فیلتر کردن نتایج فایل. برای مشاهده‌ی سینتکس‌های پشتیبانی‌شده، به «جستجوی فایل‌ها و پوشه‌ها» مراجعه کنید.

spaces

string

فهرستی از فاصله‌ها که با کاما از هم جدا شده‌اند تا درون مجموعه داده‌ها جستجو شوند. مقادیر پشتیبانی‌شده عبارتند از drive و appDataFolder . برای اطلاعات بیشتر، به سازماندهی فایل مراجعه کنید.

supportsAllDrives

boolean

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

supportsTeamDrives
(deprecated)

boolean

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

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

مشخص می‌کند که کدام مجوزهای نمای اضافی باید در پاسخ لحاظ شوند. فقط published پشتیبانی می‌شود.

includeLabels

string

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

درخواست بدنه

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

بدنه پاسخ

فهرستی از فایل‌ها.

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

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

object ( File )

فهرست فایل‌ها. اگر nextPageToken پر شده باشد، ممکن است این فهرست ناقص باشد و باید یک صفحه اضافی از نتایج واکشی شود.

nextPageToken

string

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

kind

string

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

دامنه‌های مجوز

به یکی از حوزه‌های 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 فایل‌هایی که در دامنه کاربر به اشتراک گذاشته شده‌اند.