במסמך הזה מתוארים שיקולים חשובים בכל הנוגע למתן שמות לקבצים ולעבודה עם
מטא-נתונים, כמו תמונות ממוזערות וטקסט שניתן להוסיף לאינדקס. כדי להוסיף ולאחזר קבצים, אפשר לעיין במאמר בנושא
מקור המידע files
.
ציון שמות קבצים וסיומות
כשמוסיפים קבצים, אפליקציות צריכות לציין סיומת קובץ במאפיין title (כותרת)
באמצעות Google Drive API. לדוגמה, פעולה להוספה של קובץ JPEG אמורה
לציין משהו כמו "name": "cat.jpg"
במטא-נתונים.
GET
התגובות הבאות יכולות לכלול את המאפיין fileExtension
לקריאה בלבד
מאוכלסים בתוסף שצוין במקור במאפיין name
. כאשר
משתמש ב-Google Drive מבקש להוריד קובץ או כשמתבצעת הורדה של הקובץ
באמצעות לקוח הסנכרון, Drive יוצר שם קובץ מלא (עם
) לפי הכותרת. במקרים שבהם התוסף חסר,
מערכת Drive מנסה לזהות את הסיומת לפי סוג הקובץ
סוג MIME.
שמירת טקסט שניתן להוסיף לאינדקס
כש-Drive יוסיף מסמכים לאינדקס באופן אוטומטי,
מזהה את סוג הקובץ, כולל מסמכי טקסט, קובצי PDF, תמונות עם טקסט,
וסוגים נפוצים אחרים. אם האפליקציה שומרת סוגים אחרים של קבצים (כמו שרטוטים,
וידאו וקיצורי דרך), תוכל לשפר את יכולת הגילוי על ידי הוספת
טקסט שניתן להוסיף לאינדקס בשדה contentHints.indexableText
של הקובץ.
טקסט שניתן להוסיף לאינדקס נוסף לאינדקס כ-HTML. אם שומרים את מחרוזת הטקסט שניתן להוסיף לאינדקס
<section attribute="value1">Here's some text</section>
, ואז 'ריכזנו כאן
טקסט" נוסף לאינדקס, אבל 'value1' לא מדויק. לכן שמירת קובץ XML בתור הוספה לאינדקס
הוא לא שימושי באותה מידה כמו שמירת HTML.
כשמציינים את indexableText
, חשוב לזכור גם:
- הגודל המקסימלי של הקובץ
contentHints.indexableText
הוא 128KB. - מתעדים את המונחים והמושגים העיקריים שאתם מצפים שהמשתמש יחפש.
- אל תנסו למיין טקסט לפי סדר חשיבות, כי הפעולה הזו מתבצעת על ידי הכלי לאינדקס. בצורה יעילה.
- האפליקציה צריכה לעדכן את הטקסט שניתן להוסיף לאינדקס בכל שמירה.
- יש לוודא שהטקסט קשור לתוכן או למטא-נתונים של הקובץ.
יכול להיות שהנקודה האחרונה הזו מובנת מאליה, אבל היא חשובה. לא כדאי להוסיף מונחים נפוצים לחיפוש כדי לאלץ קובץ להופיע בתוצאות החיפוש. הזה עלול לתסכל את המשתמשים, ואפילו לגרום להם למחוק את הקובץ.
העלאת תמונות ממוזערות
Drive יוצר באופן אוטומטי תמונות ממוזערות להרבה קבצים נפוצים שונים, כגון Google Docs , Sheets ו-Slides. תמונות ממוזערות עוזרות למשתמש לזהות בצורה טובה יותר קובצי Drive.
כשמדובר בסוגי קבצים שלא ניתן ליצור מהם תמונה ממוזערת רגילה ב-Drive
תוכלו לספק תמונה ממוזערת שנוצרה על ידי האפליקציה שלכם. במהלך
ליצור או לעדכן קובץ, להעלות תמונה ממוזערת על ידי הגדרת
השדה contentHints.thumbnail
במשאב files
.
פרטים נוספים:
- צריך להגדיר את השדה
contentHints.thumbnail.image
כבטוח לכתובת ה-URL ולשם הקובץ תמונה בקידוד base64 (מידע נוסף זמין בקטע RFC 4648) 5). - מגדירים את השדה
contentHints.thumbnail.mimeType
לסוג ה-MIME המתאים. לתמונה הממוזערת.
אם מערכת Drive יכולה ליצור תמונה ממוזערת מהקובץ, היא משתמשת שנוצר באופן אוטומטי, ומתעלמת מכל האפשרות שהעלית. אם לא ניתן תיצור תמונה ממוזערת, והיא תשתמש בתמונה שסיפקתם.
תמונות ממוזערות צריכות לעמוד בכללים הבאים:
- אפשר להעלות אותם בפורמטים PNG, GIF או JPG.
- הרוחב המומלץ הוא 1600 פיקסלים.
- הרוחב המינימלי הוא 220 פיקסלים.
- גודל הקובץ המקסימלי הוא 2MB.
- האפליקציה אמורה לעדכן אותם בכל שמירה.
מידע נוסף זמין במקור המידע files
.
אחזור של תמונות ממוזערות
אפשר לאחזר מטא-נתונים, כולל תמונות ממוזערות, של קובצי Drive.
פרטי התמונות הממוזערות מאוחסנים בשדה thumbnailLink
של
משאב files
.
החזרת תמונה ממוזערת ספציפית
דוגמת הקוד הבאה מציגה
בקשת שיטה של files.get
באמצעות
כמה שדות כפרמטר של שאילתה כדי להחזיר את המטא-נתונים thumbnailLink
של
קובץ ספציפי. למידע נוסף, ראו החזרת שדות ספציפיים עבור
.
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=id,name,mimeType,thumbnailLink
מחליפים את FILE_ID ב-fileId
של הקובץ שרוצים להפעיל.
למצוא.
אם האפשרות זמינה, הבקשה תחזיר כתובת URL לטווח קצר לתמונה הממוזערת של הקובץ.
בדרך כלל, הקישור נמשך כמה שעות. השדה יאוכלס רק
האפליקציה ששלחה את הבקשה יכולה לגשת לתוכן של הקובץ. אם הקובץ לא משותף
באופן ציבורי, כתובת ה-URL שמוחזרת ב-thumbnailLink
חייבת להיות מאוחזרת באמצעות
בקשה עם פרטי כניסה.
החזרת רשימה של תמונות ממוזערות
דוגמת הקוד הבאה מציגה
בקשת שיטה של files.list
באמצעות
כמה שדות כפרמטר של שאילתה כדי להחזיר את המטא-נתונים thumbnailLink
של
רשימה של קבצים. למידע נוסף, ראו חיפוש קבצים
תיקיות.
GET https://www.googleapis.com/drive/v3/files/?fields=files(id,name,mimeType,thumbnailLink)
כדי להגביל את תוצאות החיפוש לסוג קובץ מסוים, אפשר להחיל מחרוזת שאילתה על מגדירים את סוג ה-MIME. לדוגמה, דוגמת הקוד הבאה מראה איך להגביל את רשימה לקובצי Google Sheets. מידע נוסף על סוגי MIME זמין במאמר MIME נתמך ב-Google Workspace וב-Google Drive .
GET https://www.googleapis.com/drive/v3/files/q=mimeType='application/vnd.google-apps.spreadsheet'&fields=files(id,name,mimeType,thumbnailLink)