Method: files.list

רשימה של הקבצים של המשתמש.

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

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

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

מציין אילו הרשאות של תצוגה נוספת צריך לכלול בתשובה. רק הערך 'פורסם' נתמך.
includeLabels

string

רשימה מופרדת בפסיקים של מזהי תוויות שרוצים לכלול בחלק labelInfo של התשובה.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

רשימה של קבצים.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean,
  "files": [
    {
      object (File)
    }
  ]
}
שדות
nextPageToken

string

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

string

מזהה את סוג המשאב. ערך: המחרוזת הקבועה "drive#fileList".
files[]

object (File)

רשימת הקבצים. אם השדה nextPageToken מאוכלס, יכול להיות שהרשימה הזו חלקית וצריך לאחזר דף נוסף של תוצאות.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של 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 קבצים ששותפו עם הדומיין של המשתמש.