Method: files.list

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

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

בקשת HTTP

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

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

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

פרמטרים
corpora

string

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

enum (Corpus)

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

string

המזהה של האחסון השיתופי שבו רוצים לחפש.
includeItemsFromAllDrives

boolean

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

boolean

הוצאה משימוש: יש להשתמש במקום זאת ב-includeItemsFromAllDrives.
orderBy

string

רשימה של מפתחות מיון שמופרדים בפסיקים. המפתחות החוקיים הם 'createdTime' , 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred' ו-'viewedByMeTime'. כל מפתח ממיין בסדר עולה כברירת מחדל, אבל אפשר לשנות את הערך שלו באמצעות מקש הצירוף 'תיאור'. שימוש לדוגמה: ?orderBy=folder,modifiedTime score,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.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)
user קבצים שבבעלות המשתמש או ששותפו על ידי המשתמש.
domain קבצים ששותפו עם הדומיין של המשתמש.