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