Method: files.list

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

השיטה הזו מקבלת את הפרמטר q, שהוא שאילתת חיפוש שמשלבת מונח חיפוש אחד או יותר.

כברירת מחדל, השיטה הזו מחזירה את כל הקבצים, כולל קבצים שהועברו לאשפה. אם אתם לא רוצים שקבצים שהועברו לאשפה יופיעו ברשימה, אתם יכולים להשתמש בפרמטר השאילתה trashed=false כדי להסיר קבצים שהועברו לאשפה מהתוצאות.

בקשת 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

האם לכלול בתוצאות פריטים מתיקיית 'האחסון שלי' ומתיקיות אחסון שיתופי.
includeTeamDriveItems
(deprecated)

boolean

הוצא משימוש: במקומו צריך להשתמש ב-includeItemsFromAllDrives.
orderBy

string

רשימה מופרדת בפסיקים של מפתחות מיון. המפתחות התקינים הם:

  • createdTime: מתי הקובץ נוצר. מומלץ להימנע משימוש במפתח הזה לשאילתות על אוספים גדולים של פריטים, כי זה עלול לגרום לפסק זמן או לבעיות אחרות. כדי למיין לפי זמן אוסף גדול של פריטים, משתמשים במקום זאת בפונקציה modifiedTime.
  • ‫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 קבצים ששותפו עם הדומיין של המשתמש.