Method: files.list

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

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

בקשת HTTP

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

כתובת ה-URL כוללת תחביר של קידוד gRPC.

פרמטרים של שאילתה

פרמטרים
corpora

string

קטעי פריטים (קבצים/מסמכים) שהשאילתה חלה עליהם. הישויות הנתמכות הן 'user', 'domain', 'drive' ו-'allDrives'. עדיפות ל-'user' או 'drive' ל-'allDrives' ליעילות. כברירת מחדל, גוף הקובץ מוגדר כ 'משתמש'. עם זאת, הערך הזה יכול להשתנות בהתאם למסנן שהוגדר באמצעות הפרמטר 'q'.
corpus
(deprecated)

enum (Corpus)

הוצא משימוש: מקור הקבצים שיש לרשום. אפשר להשתמש ב-"corpor".
driveId

string

המזהה של האחסון השיתופי לחיפוש.
includeItemsFromAllDrives

boolean

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

boolean

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

string

רשימה של מפתחות מיון שמופרדים בפסיקים. המפתחות החוקיים הם 'createdTime' , 'folder' , 'modifiedByMeTime' , 'modifiedTime' , 'name' , 'name_natural', '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.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 קבצים ששותפו עם הדומיין של המשתמש.