במדריך הזה מוסבר איך Google Drive API תומך בכמה דרכים לחיפוש קבצים ותיקיות.
אפשר להשתמש בשיטה list
במשאב files
כדי להחזיר את כל הקבצים והתיקיות של משתמש ב-Drive או חלק מהם. אפשר גם להשתמש בשיטה list
כדי לאחזר את fileId
שנדרש לשיטות מסוימות של משאבים (כמו השיטה get
והשיטה update
).
שימוש בפרמטר fields
אם רוצים לציין את השדות שיוחזרו בתגובה, אפשר להגדיר את fields
פרמטר המערכת files
בכל שיטה של המשאב. אם משמיטים את הפרמטר fields
, השרת מחזיר קבוצת ברירת מחדל של שדות שספציפיים לשיטה. לדוגמה, ה-method list
מחזירה רק את השדות kind
, id
, name
, mimeType
ו-resourceKey
לכל קובץ. כדי להחזיר שדות שונים, אפשר לעיין במאמר החזרת שדות ספציפיים.
קבלת קובץ
כדי לקבל קובץ, משתמשים ב-method get
במשאב files
עם פרמטר הנתיב fileId
.
אם אתם לא יודעים את מזהה הקובץ, אתם יכולים לרשום את כל הקבצים באמצעות method list
.
השיטה מחזירה את הקובץ כמופע של משאב files
. אם מספקים את פרמטר השאילתה alt=media
, התשובה כוללת את תוכן הקובץ בגוף התשובה. הוראות להורדה או לייצוא של הקובץ מופיעות במאמר הורדה וייצוא של קבצים.
כדי לאשר את הסיכון בהורדת תוכנות זדוניות מוכרות או קבצים פוגעניים אחרים, מגדירים את פרמטר השאילתה acknowledgeAbuse
לערך true
. השדה הזה רלוונטי רק אם הפרמטר alt=media
מוגדר והמשתמש הוא הבעלים של הקובץ או מארגן של האחסון השיתופי שבו הקובץ נמצא.
חיפוש של כל הקבצים והתיקיות בתיקייה 'האחסון שלי' של המשתמש הנוכחי
אפשר להשתמש בשיטה list
בלי פרמטרים כדי להחזיר את כל הקבצים והתיקיות.
GET https://www.googleapis.com/drive/v3/files
חיפוש קבצים או תיקיות ספציפיים בתיקיית 'האחסון שלי' של המשתמש הנוכחי
כדי לחפש קבוצה ספציפית של קבצים או תיקיות, משתמשים בשדה q
של מחרוזת השאילתה
עם השיטה list
כדי לסנן את הקבצים שיוחזרו על ידי שילוב של מונח חיפוש אחד או יותר.
התחביר של מחרוזת השאילתה כולל את שלושת החלקים הבאים:
query_term operator values
כאשר:
query_term
הוא מונח השאילתה או השדה שרוצים לחפש.
operator
מציין את התנאי למונח השאילתה.
values
הם הערכים הספציפיים שרוצים להשתמש בהם כדי לסנן את תוצאות החיפוש.
לדוגמה, מחרוזת השאילתה הבאה מסננת את החיפוש כך שיוחזרו רק תיקיות על ידי הגדרת סוג MIME:
q: mimeType = 'application/vnd.google-apps.folder'
כדי לראות את כל מונחי השאילתה של הקובץ, אפשר לעיין במונחי שאילתה ספציפיים לקובץ.
כדי לראות את כל האופרטורים של השאילתות שאפשר להשתמש בהם כדי ליצור שאילתה, אפשר לעיין במאמר אופרטורים של שאילתות.
דוגמאות למחרוזות שאילתה
בטבלה הבאה מפורטות דוגמאות לכמה מחרוזות בסיסיות של שאילתות. הקוד בפועל שונה בהתאם לספריית הלקוח שבה אתם משתמשים לחיפוש.
בנוסף, צריך להוסיף תווי בריחה (escape) לתווים מיוחדים בשמות הקבצים כדי לוודא שהשאילתה פועלת בצורה תקינה. לדוגמה, אם שם קובץ מכיל גם גרש ('
) וגם לוכסן הפוך ("\"
), צריך להשתמש בלוכסן הפוך כדי לבטל את המשמעות שלהם: name
contains 'quinn\'s paper\\essay'
.
מה רוצים לשאול | דוגמה |
---|---|
קבצים בשם hello | name = 'hello' |
קבצים שהשם שלהם מכיל את המילים hello ו-goodbye | name contains 'hello' and name contains 'goodbye' |
קבצים שהשם שלהם לא מכיל את המילה hello | not name contains 'hello' |
קבצים שמכילים את הטקסט important (חשוב) ונמצאים באשפה | fullText contains 'important' and trashed = true |
קבצים שמכילים את המילה hello | fullText contains 'hello' |
קבצים שלא מכילים את המילה hello | not fullText contains 'hello' |
קבצים שמכילים בדיוק את הביטוי hello world | fullText contains '"hello world"' |
קובצים עם שאילתה שמכילה את התו '\' (לדוגמה, '\authors') | fullText contains '\\authors' |
קבצים שהם תיקיות | mimeType = 'application/vnd.google-apps.folder' |
קבצים שאינם תיקיות | mimeType != 'application/vnd.google-apps.folder' |
קבצים ששונו אחרי תאריך מסוים (אזור הזמן שמוגדר כברירת מחדל הוא UTC) | modifiedTime > '2012-06-04T12:00:00' |
קבצים של תמונות או סרטונים ששונו אחרי תאריך מסוים | modifiedTime > '2012-06-04T12:00:00' and (mimeType contains 'image/' or mimeType contains 'video/') |
קבצים שמסומנים בכוכב | starred = true |
קבצים בתוך אוסף (לדוגמה, מזהה התיקייה באוסף parents ) |
'1234567' in parents |
קבצים בתיקיית נתוני אפליקציה באוסף | 'appDataFolder' in parents |
קבצים שהמשתמש test@example.org הוא הבעלים שלהם | 'test@example.org' in owners |
קבצים שלמשתמש test@example.org יש הרשאת כתיבה לגביהם | 'test@example.org' in writers |
קבצים שלחברי הקבוצה group@example.org יש הרשאת כתיבה לגביהם | 'group@example.org' in writers |
קבצים ששותפו עם המשתמש המורשה עם השם hello | sharedWithMe and name contains 'hello' |
קבצים עם מאפיין קובץ בהתאמה אישית שגלוי לכל האפליקציות | properties has { key='mass' and value='1.3kg' } |
קבצים עם מאפיין קובץ בהתאמה אישית שפרטי לאפליקציה ששולחת את הבקשה | appProperties has { key='additionalID' and value='8e8aceg2af2ge72e78' } |
קבצים שלא שותפו עם אף אחד או עם אף דומיין (רק פרטיים, או ששותפו עם משתמשים או קבוצות ספציפיים) | visibility = 'limited' |
סינון תוצאות החיפוש באמצעות ספריית לקוח
בדוגמת הקוד הבאה מוצג אופן השימוש בספריית לקוח כדי לסנן את תוצאות החיפוש לפי שמות קבצים ומזהים של קובצי JPEG. בדוגמה הזו נעשה שימוש במונח השאילתה mimeType
כדי לצמצם את התוצאות לקבצים מהסוג image/jpeg
. הוא גם מגדיר את הערך של spaces
ל-drive
כדי לצמצם עוד יותר את החיפוש למרחב ב-Drive. אם הפונקציה nextPageToken
מחזירה null
, אין יותר תוצאות.
Java
Python
Node.js
PHP
חיפוש קבצים באמצעות מאפיין קובץ מותאם אישית
כדי לחפש קבצים עם מאפיין קובץ מותאם אישית, משתמשים במונח השאילתה properties
או appProperties
עם מפתח וערך. לדוגמה, כדי לחפש מאפיין מותאם אישית של קובץ שהוא פרטי לאפליקציה ששולחת את הבקשה, שנקרא additionalID
עם הערך 8e8aceg2af2ge72e78
:
appProperties has { key='additionalID' and value='8e8aceg2af2ge72e78' }
מידע נוסף זמין במאמר הוספת מאפיינים מותאמים אישית לקבצים.
חיפוש קבצים עם תווית ספציפית או ערך שדה ספציפי
כדי לחפש קבצים עם תוויות ספציפיות, משתמשים במונח labels
של שאילתת החיפוש עם מזהה תווית ספציפי. לדוגמה: 'labels/LABEL_ID' in
labels
אם הפעולה בוצעה בהצלחה, גוף התגובה יכיל את כל המקרים של הקובץ שבהם התווית הוחלה.
כדי לחפש קבצים ללא מזהה תווית ספציפי: Not
'labels/LABEL_ID' in labels
.
אפשר גם לחפש קבצים לפי ערכים ספציפיים בשדות. לדוגמה, כדי לחפש קבצים עם ערך טקסט:
labels/LABEL_ID.text_field_id ='TEXT'
.
מידע נוסף זמין במאמר חיפוש קבצים עם תווית או ערך שדה ספציפיים.
חיפוש במקורות המידע
חיפושים שמפעילים את השיטה list
משתמשים ב-corpora
של user
כברירת מחדל. כדי לחפש מאגרי מידע אחרים, כמו קבצים ששותפו עם domain
, מגדירים את הפרמטר corpora
.
אפשר לחפש בכמה מאגרי מידע בשאילתה אחת, אבל אם השילוב של מאגרי המידע גדול מדי, יכול להיות שיוחזרו תוצאות חלקיות. אם incompleteSearch
הוא true
בגוף התגובה, סימן שלא כל המסמכים הוחזרו. אם זה קורה, כדאי לצמצם את השאילתה על ידי בחירת מאגר מידע אחר, כמו user
או drive
.
נושאים קשורים
- חיפוש תיקיות אחסון שיתופי
- מונחים ואופרטורים של שאילתות חיפוש
- סוגי MIME שנתמכים ב-Google Workspace וב-Google Drive
- תפקידים והרשאות
- חיפוש קבצים עם תווית ספציפית או ערך שדה ספציפי