Method: files.list

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

השיטה הזו מקבלת את הפרמטר q, שהוא שאילתת חיפוש שמשלבת מונח חיפוש אחד או יותר.

כברירת מחדל, השיטה הזו מחזירה את כל הקבצים, כולל קבצים שהועברו לאשפה. אם אתם לא רוצים שקבצים שהועברו לאשפה יופיעו ברשימה, אתם יכולים להשתמש בפרמטר השאילתה trashed=false כדי להסיר קבצים שהועברו לאשפה מהתוצאות.

בקשת HTTP

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

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

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

פרמטרים
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 
{
  "items": [
    {
      object (File)
    }
  ],
  "nextPageToken": string,
  "kind": string,
  "etag": string,
  "selfLink": string,
  "incompleteSearch": boolean,
  "nextLink": string
}
שדות
items[]

object (File)

רשימת הקבצים. אם הערך של nextPageToken מאוכלס, יכול להיות שהרשימה הזו לא מלאה וצריך לאחזר דף נוסף של תוצאות.
nextPageToken

string

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

string

הערך הזה תמיד יהיה drive#fileList.
etag

string

תג ה-ETag של הרשימה.

היקפי הרשאות

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