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'. כברירת מחדל, מאגרי המידע מוגדרים כ 'משתמש'. עם זאת, אפשר לשנות את זה בהתאם למסנן שמוגדר באמצעות הפרמטר q.
corpus
(deprecated)

enum (Corpus)

הוצא משימוש: המקור של הקבצים שיוצגו ברשימה. במקום זאת, צריך להשתמש ב-'corpora'.
driveId

string

המזהה של האחסון השיתופי שרוצים לחפש בו.
includeItemsFromAllDrives

boolean

האם לכלול בתוצאות פריטים מתיקיית 'האחסון שלי' ומתיקיות אחסון שיתופי.
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

האם האפליקציה ששולחת את הבקשה תומכת גם בתיקיית 'האחסון שלי' וגם בתיקיות אחסון שיתופי.
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

יש היקפי הרשאות מוגבלים שנדרשת הערכת אבטחה כדי להשתמש בהם באפליקציה. מידע נוסף זמין במדריך ההרשאות.

קורפוס

טיפוסים בני מנייה (enum)
user קבצים שבבעלות המשתמש או ששותפו איתו.
domain קבצים ששותפו עם הדומיין של המשתמש.