ליצירת רשימה של קובצי המשתמש.
השיטה הזו מקבלת את הפרמטר q
, שהוא שאילתת חיפוש שמשלבת לפחות מונח חיפוש אחד. למידע נוסף, ראו חיפוש קבצים התיקיות.
בקשת HTTP
GET https://www.googleapis.com/drive/v3/files
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
corpora |
גופי הפריטים (קבצים/מסמכים) שעליהם חלה השאילתה. הגופים הנתמכים הם 'user', 'domain', 'drive' ו-'allDrives'. העדפה ל'משתמש' או 'drive' אל 'allDrives' לשיפור היעילות. כברירת מחדל, מאגר מוגדר כ'משתמש'. עם זאת, הדבר עשוי להשתנות בהתאם למסנן שמוגדר באמצעות הפונקציה 'q' הפרמטר. |
corpus |
הוצא משימוש: מקור הקבצים לרשימה. שימוש בשדה 'קורפורה' במקום זאת. |
driveId |
המזהה של האחסון השיתופי לחיפוש. |
includeItemsFromAllDrives |
אם צריך לכלול בתוצאות גם פריטים בתיקייה 'האחסון שלי' וגם פריטים באחסון השיתופי. |
includeTeamDriveItems |
הוצא משימוש: במקומו צריך להשתמש ברכיב |
orderBy |
רשימה של מפתחות מיון שמופרדים בפסיקים. מפתחות חוקיים הם 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred' ו-'viewedByMeTime'. כל מקש ממיין בסדר עולה כברירת מחדל, אך ניתן להפוך את המקשים באמצעות 'יורד'. לעיבוד טקסט. שימוש לדוגמה: ?orderBy=folder,modifiedTime desc,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'. לא ניתן היה לחפש את כל הקורפורה. במקרה כזה, מומלץ שהלקוחות יצמצם את השאילתה שלהם על ידי בחירת אוסף נתונים אחר כגון 'user' או '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.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 |
קבצים ששותפו עם הדומיין של המשתמש. |