Method: files.list

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

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

בקשת HTTP

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

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

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

פרמטרים
corpora

string

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

enum (Corpus)

הוצא משימוש: מקור הקבצים לרשימה. שימוש בשדה 'קורפורה' במקום זאת.
driveId

string

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

boolean

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

boolean

האפשרות הזו הוצאה משימוש. במקום זאת, אתם צריכים להשתמש ב-includeItemsFromAllDrives.
orderBy

string

רשימה מופרדת בפסיקים של מפתחות מיון. המפתחות החוקיים הם:

  • createdTime: מתי הקובץ נוצר.
  • folder: מזהה התיקייה. השדה הזה ממוין לפי סדר אלפביתי.
  • modifiedByMeTime: הפעם האחרונה שבה המשתמש שינה את הקובץ.
  • modifiedTime: הפעם האחרונה שבה מישהו ביצע שינוי בקובץ.
  • name: שם הקובץ. השדה הזה ממוין לפי סדר אלפביתי, כך שהערכים 1, 12, 2, 22.
  • name_natural: שם הקובץ. השדה הזה ממוין לפי סדר מיון טבעי, כלומר 1, 2, 12, 22.
  • quotaBytesUsed: מספר הבייטים של מכסת האחסון שהקובץ השתמש בהם.
  • recency: חותמת הזמן העדכנית ביותר משדות התאריך והשעה של הקובץ.
  • sharedWithMeTime: המועד שבו הקובץ שותף עם המשתמש, אם רלוונטי.
  • starred: אם המשתמש סימן את הקובץ בכוכב.
  • viewedByMeTime: הפעם האחרונה שהמשתמש צפה בקובץ.

כל מקש ממיין בסדר עולה כברירת מחדל, אך ניתן להפוך את המקשים באמצעות 'יורד'. מגביל. שימוש לדוגמה: ?orderBy=folder,modifiedTime desc,name.
pageSize

integer

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

string

האסימון להמשך בקשת רשימה קודמת בדף הבא. יש להגדיר אותו לערך של 'nextPageToken'. מהתשובה הקודמת.
q

string

שאילתה לסינון תוצאות הקובץ. בקטע 'חיפוש קבצים ו תיקיות" לתחביר נתמך.
spaces

string

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

boolean

אם האפליקציה ששלחה את הבקשה תומכת גם בתיקייה 'האחסון שלי' וגם בתיקיות אחסון שיתופי.
supportsTeamDrives
(deprecated)

boolean

האפשרות הזו הוצאה משימוש. במקום זאת, אתם צריכים להשתמש ב-supportsAllDrives.
teamDriveId
(deprecated)

string

האפשרות הזו הוצאה משימוש. במקום זאת, אתם צריכים להשתמש ב-driveId.
includePermissionsForView

string

מציינת אילו הרשאות תצוגה נוספות לכלול בתשובה. רק 'פורסם' נתמך.
includeLabels

string

רשימה מופרדת בפסיקים של מזהים של תוויות שיש לכלול בחלק labelInfo של התשובה.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

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

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "nextPageToken": string,
  "kind": string,
  "incompleteSearch": boolean,
  "files": [
    {
      object (File)
    }
  ]
}
שדות
nextPageToken

string

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

string

מזהה את סוג המשאב. ערך: המחרוזת הקבועה "drive#fileList".
files[]

object (File)

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

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.appdata
  • 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)
user קבצים שבבעלות המשתמש או ששותפו איתו.
domain קבצים ששותפו עם הדומיין של המשתמש.