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.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 פריטים ששותפו עם הדומיין של המשתמש.