Method: files.list

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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: שם הקובץ. השדה הזה ממוין לפי סדר אלפביתי, למשל 1, 12, 2, 22.
  • title_natural: שם הקובץ. השדה הזה ממוין לפי סדר מיון טבעי, כלומר 1, 2, 12, 22.

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