Method: files.list

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

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

درخواست HTTP

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

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

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

پارامترها
corpora

string

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

corpus
(deprecated)

enum ( Corpus )

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

driveId

string

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

includeItemsFromAllDrives

boolean

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

includeTeamDriveItems
(deprecated)

boolean

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

maxResults

integer

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

orderBy

string

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

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

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

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

pageToken

string

نشانه صفحه برای فایل ها

projection
(deprecated)

enum ( Projection )

Deprecated: این پارامتر عملکردی ندارد.

q

string

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

spaces

string

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

supportsAllDrives

boolean

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

supportsTeamDrives
(deprecated)

boolean

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

teamDriveId
(deprecated)

string

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

includePermissionsForView

string

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

includeLabels

string

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

درخواست بدن

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

بدن پاسخگو

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

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

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

string

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

kind

string

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

etag

string

ETag لیست.

items[]

object ( File )

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

محدوده مجوز

به یکی از حوزه های 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

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

بدنه

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