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 description,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

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

קורפוס

טיפוסים בני מנייה (enums)
DEFAULT הפריטים שהמשתמש ניגש אליהם.
DOMAIN פריטים ששותפו עם הדומיין של המשתמש.