רשימת הקבצים של המשתמש.
השיטה הזו מקבלת את הפרמטר q
, שהוא שאילתת חיפוש שמשלבת מונח חיפוש אחד או יותר. למידע נוסף, ניתן לעיין במדריך חיפוש קבצים ותיקיות.
בקשת HTTP
GET https://www.googleapis.com/drive/v3/files
בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
corpora |
גופי פריטים (קבצים/מסמכים) שעליהם השאילתה חלה. הגופים הנתמכים הם 'user', 'domain', 'drive' ו-'allDrives'. לצורך יעילות, עדיף להשתמש ב-'user' או ב-'drive' על 'allDrives'. כברירת מחדל, הקובץ מוגדר כ 'משתמש'. עם זאת, הוא יכול להשתנות בהתאם למסנן שהוגדר באמצעות הפרמטר 'q'. |
corpus |
הוצא משימוש: המקור של הקבצים לרשימה. צריך להשתמש בשדה 'corpora'. |
driveId |
המזהה של האחסון השיתופי שבו רוצים לחפש. |
includeItemsFromAllDrives |
אם הפריטים 'האחסון שלי' וגם פריטים באחסון השיתופי צריכים להיכלל בתוצאות. |
includeTeamDriveItems |
הוצאה משימוש: יש להשתמש במקום זאת ב- |
orderBy |
רשימה של מפתחות מיון שמופרדים בפסיקים. המפתחות החוקיים הם 'createdTime' , 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred' ו-'viewedByMeTime'. כל מפתח ממיין בסדר עולה כברירת מחדל, אבל אפשר לשנות את הערך שלו באמצעות מקש הצירוף 'תיאור'. שימוש לדוגמה: ?orderBy=folder,modifiedTime score,name. |
pageSize |
מספר הקבצים המקסימלי שיש להחזיר בכל דף. אפשר להציג דפי תוצאות חלקיים או ריקים אפילו לפני שרשימת הקבצים תסתיים. |
pageToken |
האסימון להמשך בקשה קודמת לרשימה בדף הבא. צריך להגדיר את הערך הזה לערך 'nextPageToken' מהתגובה הקודמת. |
q |
שאילתה לסינון תוצאות הקבצים. אפשר לעיין במדריך 'חיפוש קבצים ותיקיות' כדי לבדוק אם יש תחביר נתמך. |
spaces |
רשימה מופרדת בפסיקים של רווחים לשאילתה בתוך הקובץ. הערכים הנתמכים הם 'drive' ו-'appDataFolder'. |
supportsAllDrives |
האם האפליקציה שביקשה תמיכה תומכת גם בתיקייה 'האחסון שלי' וגם בתיקיות אחסון שיתופי. |
supportsTeamDrives |
הוצאה משימוש: יש להשתמש במקום זאת ב- |
teamDriveId |
הוצאה משימוש: יש להשתמש במקום זאת ב- |
includePermissionsForView |
ההגדרה קובעת אילו הרשאות של תצוגות מפורטות נוספות ייכללו בתגובה. רק הערך 'פורסם' נתמך. |
includeLabels |
רשימה של מזהי התוויות שצריך לכלול בחלק |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התגובה
רשימה של קבצים.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
ייצוג JSON |
---|
{
"nextPageToken": string,
"kind": string,
"incompleteSearch": boolean,
"files": [
{
object ( |
שדות | |
---|---|
nextPageToken |
אסימון הדף של דף הקבצים הבא. הערך הזה לא יופיע אם רשימת הקבצים תסתיים. אם האסימון יידחה מסיבה כלשהי, יש לבטל אותו ולהתחיל את העימוד מחדש מהדף הראשון של תוצאות החיפוש. אסימון הדף תקף בדרך כלל לכמה שעות. עם זאת, אם מוסיפים או מסירים פריטים חדשים, התוצאות הצפויות עשויות להיות שונות. |
kind |
מזהה את סוג המשאב הזה. ערך: המחרוזת הקבועה |
incompleteSearch |
האם תהליך החיפוש לא היה מלא. אם הערך הוא true, ייתכן שחלק מתוצאות החיפוש לא יהיו זמינות מפני שלא בוצע חיפוש בכל המסמכים. מצב כזה יכול לקרות כשמחפשים מספר נסיעות עם מאגר 'allDrives', אבל לא ניתן לחפש בכל הרשומות. במקרה כזה, מוצע ללקוחות לצמצם את השאילתה שלהם על ידי בחירה במאגר נתונים אחר כגון 'משתמש' או 'drive'. |
files[] |
רשימת הקבצים. אם השדה 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 |
קבצים ששותפו עם הדומיין של המשתמש. |