רשימה של הקבצים של המשתמש.
השיטה הזו מקבלת את הפרמטר q
, שהוא שאילתת חיפוש שמשלבת מונח חיפוש אחד או יותר. מידע נוסף זמין במדריך בנושא חיפוש קבצים ותיקיות.
בקשת HTTP
GET https://www.googleapis.com/drive/v2/files
כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.
פרמטרים של שאילתה
פרמטרים | |
---|---|
corpora |
גופי הפריטים (קבצים או מסמכים) שאליהם מתייחסת השאילתה. הגופים הנתמכים הם |
corpus |
הוצא משימוש: גוף הפריטים (קבצים או מסמכים) שעליהם חלה השאילתה. במקום זאת, אתם צריכים להשתמש ב- |
driveId |
המזהה של האחסון השיתופי שרוצים לחפש בו. |
includeItemsFromAllDrives |
האם לכלול בתוצאות פריטים מתיקיית 'האחסון שלי' ומתיקיות אחסון שיתופי. |
includeTeamDriveItems |
הוצא משימוש: במקומו צריך להשתמש ב- |
maxResults |
המספר המקסימלי של קבצים שיוחזרו בכל דף. יכול להיות שדפי תוצאות יהיו חלקיים או ריקים גם לפני שמגיעים לסוף רשימת הקבצים. |
orderBy |
רשימה מופרדת בפסיקים של מפתחות מיון. המפתחות התקינים הם:
כל מפתח ממוין בסדר עולה כברירת מחדל, אבל אפשר להפוך את הסדר באמצעות התוסף desc. דוגמה לשימוש: שימו לב: יש כרגע מגבלה למשתמשים שיש להם בערך מיליון קבצים, שבמסגרתה מתעלמים מסדר המיון המבוקש. |
pageToken |
טוקן דף לקבצים. |
projection |
הוצא משימוש: לפרמטר הזה אין פונקציה. |
q |
מחרוזת שאילתה לחיפוש קבצים. |
spaces |
רשימה מופרדת בפסיקים של מרחבים לשליחת שאילתה. הערכים הנתמכים הם |
supportsAllDrives |
האם האפליקציה ששולחת את הבקשה תומכת גם בתיקיית 'האחסון שלי' וגם בתיקיות אחסון שיתופי. |
supportsTeamDrives |
הוצא משימוש: במקומו צריך להשתמש ב- |
teamDriveId |
הוצא משימוש: במקומו צריך להשתמש ב- |
includePermissionsForView |
מציין אילו הרשאות של תצוגות נוספות לכלול בתשובה. יש תמיכה רק ב- |
includeLabels |
רשימה מופרדת בפסיקים של מזהי התוויות שרוצים לכלול בחלק |
גוף הבקשה
גוף הבקשה צריך להיות ריק.
גוף התשובה
רשימה של קבצים.
אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{
"items": [
{
object ( |
שדות | |
---|---|
items[] |
רשימת הקבצים. אם השדה nextPageToken מאוכלס, יכול להיות שהרשימה הזו לא מלאה וצריך לאחזר דף נוסף של תוצאות. |
nextPageToken |
אסימון הדף של הדף הבא של הקבצים. השדה הזה לא יופיע אם הגעתם לסוף רשימת הקבצים. אם האסימון נדחה מסיבה כלשהי, צריך לבטל אותו ולהתחיל את העימוד מחדש מהדף הראשון של התוצאות. |
kind |
הנתיב הזה תמיד |
etag |
תג ה-ETag של הרשימה. |
selfLink |
קישור חזרה לרשימה הזו. |
incompleteSearch |
האם תהליך החיפוש לא הושלם. אם הערך הוא true, יכול להיות שחלק מתוצאות החיפוש חסרות, כי לא בוצע חיפוש בכל המסמכים. המצב הזה יכול לקרות כשמחפשים בכמה כרכים של 'כל הכוננים', אבל אי אפשר לחפש בכל הכרכים. במקרה כזה, מומלץ ללקוחות לצמצם את השאילתה שלהם על ידי בחירת מאגר מידע אחר, כמו 'ברירת מחדל' או 'Drive'. |
nextLink |
קישור לדף הבא של הקבצים. |
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של 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 |
פריטים ששותפו עם הדומיין של המשתמש. |