Method: files.list

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

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

בקשת HTTP

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

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

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

פרמטרים
corpora

string

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

enum (Corpus)

הוצאה משימוש: גוף הפריטים (קבצים/מסמכים) שהשאילתה חלה עליהם. במקומה, צריך להשתמש במדיניות corpora.
driveId

string

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

boolean

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

boolean

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

integer

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

string

רשימה של מפתחות מיון שמופרדים בפסיקים. המפתחות החוקיים הם createdDate, folder, lastViewedByMeDate, modifiedByMeDate, modifiedDate, quotaBytesUsed, recency, sharedWithMeDate, starred, title וגם title_natural. כל מפתח ממיין כברירת מחדל בסדר עולה, אבל אפשר לבטל אותו באמצעות מקש הצירוף desc. שימוש לדוגמה: ?orderBy=folder,modifiedDate desc,title. לידיעתך, יש מגבלה נוכחית עבור משתמשים עם כמיליון קבצים, שבהם המערכת מתעלמת מסדר המיון המבוקש.
pageToken

string

אסימון דף לקבצים.
projection
(deprecated)

enum (Projection)

הוצא משימוש: לפרמטר הזה אין פונקציה.
q

string

מחרוזת שאילתה לחיפוש קבצים.
spaces

string

רשימה של מרחבים משותפים שמופרדים בפסיקים. הערכים הנתמכים הם drive וגם appDataFolder.
supportsAllDrives

boolean

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