Method: files.list

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

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

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

درخواست HTTP

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

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

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

پارامترها
corpora

string

بدنه‌های آیتم‌ها (فایل‌ها/اسناد) که کوئری به آنها اعمال می‌شود. بدنه‌های پشتیبانی‌شده عبارتند از default ، domain ، drive و allDrives . برای کارایی بیشتر default یا drive به allDrives ترجیح دهید.

corpus
(deprecated)

enum ( Corpus )

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

driveId

string

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

includeItemsFromAllDrives

boolean

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

includeTeamDriveItems
(deprecated)

boolean

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

maxResults

integer

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

orderBy

string

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

  • createdDate : زمانی که فایل ایجاد شده است.
  • folder : شناسه پوشه. این فیلد با استفاده از ترتیب حروف الفبا مرتب شده است.
  • lastViewedByMeDate : آخرین باری که فایل توسط کاربر مشاهده شده است.
  • modifiedByMeDate : آخرین باری که فایل توسط کاربر تغییر داده شده است.
  • modifiedDate : آخرین باری که فایل توسط کسی تغییر داده شده است.
  • quotaBytesUsed : تعداد بایت‌های سهمیه ذخیره‌سازی استفاده‌شده توسط فایل.
  • recency : جدیدترین مهر زمانی از فیلدهای تاریخ-زمان فایل.
  • sharedWithMeDate : در صورت وجود، زمان اشتراک‌گذاری فایل با کاربر.
  • starred : مشخص می‌کند که آیا کاربر فایل را ستاره‌گذاری کرده است یا خیر.
  • title : عنوان فایل. این فیلد با استفاده از ترتیب حروف الفبا مرتب شده است، بنابراین ۱، ۱۲، ۲، ۲۲.
  • title_natural : عنوان فایل. این فیلد با استفاده از مرتب‌سازی طبیعی مرتب شده است، بنابراین ۱، ۲، ۱۲، ۲۲.

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

توجه داشته باشید که در حال حاضر محدودیتی برای کاربرانی با تقریباً یک میلیون فایل وجود دارد که در آنها ترتیب مرتب‌سازی درخواستی نادیده گرفته می‌شود.

pageToken

string

توکن صفحه برای فایل‌ها.

projection
(deprecated)

enum ( Projection )

منسوخ شده: این پارامتر هیچ عملکردی ندارد.

q

string

رشته پرس و جو برای جستجوی فایل ها.

spaces

string

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

supportsAllDrives

boolean

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

supportsTeamDrives
(deprecated)

boolean

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

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

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

includeLabels

string

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

درخواست بدنه

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

بدنه پاسخ

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

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

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

object ( File )

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

nextPageToken

string

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

kind

string

این همیشه drive#fileList ‎ است.

etag

string

برچسب ET لیست.

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

به یکی از حوزه‌های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • https://www.googleapis.com/auth/drive.apps.readonly
  • 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

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

کورپوس

انوم‌ها
DEFAULT مواردی که کاربر به آنها دسترسی داشته است.
DOMAIN مواردی که در دامنه کاربر به اشتراک گذاشته شده‌اند.