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)

הוצא משימוש: מקור הקבצים לרשימה. במקום זאת, צריך להשתמש במילה 'קורפורה'.
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 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 קבצים ששותפו עם הדומיין של המשתמש.