משאב: קובץ
המטא-נתונים של קובץ.
חלק מהשיטות של משאבים (כמו files.update) דורשות fileId. משתמשים בשיטה files.list כדי לאחזר את המזהה של קובץ.
| ייצוג ב-JSON |
|---|
{ "kind": string, "driveId": string, "fileExtension": string, "copyRequiresWriterPermission": boolean, "md5Checksum": string, "contentHints": { "indexableText": string, "thumbnail": { "image": string, "mimeType": string } }, "writersCanShare": boolean, "viewedByMe": boolean, "mimeType": string, "exportLinks": { string: string, ... }, "parents": [ string ], "thumbnailLink": string, "iconLink": string, "shared": boolean, "lastModifyingUser": { object ( |
| שדות | |
|---|---|
kind |
פלט בלבד. מזהה את סוג המשאב. הערך: המחרוזת הקבועה |
driveId |
פלט בלבד. המזהה של האחסון השיתופי שבו נמצא הקובץ. השדה הזה מאוכלס רק עבור פריטים באחסון שיתופי. |
fileExtension |
פלט בלבד. הרכיב האחרון של |
copyRequiresWriterPermission |
האם האפשרויות להעתקה, להדפסה או להורדה של הקובץ הזה צריכות להיות מושבתות עבור בעלי הרשאת קריאה והרשאת תגובה. |
md5Checksum |
פלט בלבד. סכום הביקורת MD5 של תוכן הקובץ. ההגדרה הזו רלוונטית רק לקבצים עם תוכן בינארי ב-Google Drive. |
contentHints |
מידע נוסף על תוכן הקובץ. השדות האלה אף פעם לא מאוכלסים בתגובות. |
contentHints.indexableText |
הטקסט שיעבור אינדוקס בקובץ כדי לשפר את השאילתות של fullText. האורך המקסימלי של המחרוזת הוא 128 KB והיא יכולה להכיל רכיבי HTML. |
contentHints.thumbnail |
תמונה ממוזערת של הקובץ. התמונה הזו תשמש רק אם לא תהיה אפשרות ליצור תמונה ממוזערת רגילה ב-Google Drive. |
contentHints.thumbnail.image |
נתוני התמונה הממוזערת בקידוד Base64 בטוח לכתובות URL (RFC 4648 סעיף 5). מחרוזת בקידוד Base64. |
contentHints.thumbnail.mimeType |
סוג ה-MIME של התמונה הממוזערת. |
writersCanShare |
האם משתמשים עם הרשאה |
viewedByMe |
פלט בלבד. האם המשתמש צפה בקובץ. |
mimeType |
סוג ה-MIME של הקובץ. אם לא מציינים ערך, Google Drive מנסה לזהות באופן אוטומטי ערך מתאים מתוך התוכן שהועלה. אי אפשר לשנות את הערך אלא אם מעלים גרסה חדשה. אם קובץ נוצר עם סוג MIME של Google Docs, התוכן שהועלה מיובא, אם אפשר. הפורמטים הנתמכים לייבוא מפורסמים במשאב |
exportLinks |
פלט בלבד. קישורים לייצוא קבצים בכלי העריכה של Docs לפורמטים ספציפיים. אובייקט שמכיל רשימה של |
parents[] |
המזהה של תיקיית ההורה שמכילה את הקובץ. לקובץ יכולה להיות רק תיקיית הורה אחת. אי אפשר לציין כמה תיקיות הורה. אם לא מציינים את התיקייה כחלק מבקשת יצירה, הקובץ ממוקם ישירות בתיקייה 'האחסון שלי' של המשתמש. אם לא מציינים את התיקייה כחלק מבקשת העתקה, הקובץ מקבל בירושה את כל תיקיית ההורה שאפשר לגלות של קובץ המקור. כדי לשנות את רשימת ההורים, צריך להשתמש בפרמטרים |
thumbnailLink |
פלט בלבד. קישור זמני לתמונה הממוזערת של הקובץ, אם יש כזה. בדרך כלל נמשך כמה שעות. לא מיועד לשימוש ישיר באפליקציות אינטרנט בגלל מדיניות שיתוף משאבים בין מקורות (CORS). כדאי להשתמש בשרת Proxy. השדה הזה מאוכלס רק כשאפליקציית הבקשה יכולה לגשת לתוכן הקובץ. אם הקובץ לא שותף באופן ציבורי, צריך לאחזר את כתובת ה-URL שמוחזרת ב- |
iconLink |
פלט בלבד. קישור סטטי לא מאומת לסמל הקובץ. |
shared |
פלט בלבד. האם הקובץ שותף. לא מאוכלס עבור פריטים באחסון שיתופי. |
lastModifyingUser |
פלט בלבד. המשתמש האחרון שערך את הקובץ. השדה הזה מאוכלס רק כשהשינוי האחרון בוצע על ידי משתמש מחובר. |
owners[] |
פלט בלבד. הבעלים של הקובץ. יכול להיות שלקובצי Legacy מסוימים יהיו יותר מבעלים אחד. השדה הזה לא מאוכלס עבור פריטים באחסון שיתופי. |
headRevisionId |
פלט בלבד. המזהה של הגרסה העדכנית של הקובץ. האפשרות הזו זמינה כרגע רק לקבצים עם תוכן בינארי ב-Google Drive. |
sharingUser |
פלט בלבד. המשתמש ששיתף את הקובץ עם המשתמש ששלח את הבקשה, אם רלוונטי. |
webViewLink |
פלט בלבד. קישור לפתיחת הקובץ בכלי רלוונטי של Google לעריכה או לצפייה בדפדפן. |
webContentLink |
פלט בלבד. קישור להורדת תוכן הקובץ בדפדפן. האפשרות הזו זמינה רק לקבצים עם תוכן בינארי ב-Google Drive. |
size |
פלט בלבד. הגודל בבייטים של אובייקטים בינאריים גדולים וקבצים של כלי העריכה של Google Workspace. השדה הזה לא יאוכלס עבור קבצים שאין להם גודל, כמו קיצורי דרך ותיקיות. |
viewersCanCopyContent |
הוצא משימוש: במקומו, צריך להשתמש ב- |
permissions[] |
פלט בלבד. הרשימה המלאה של ההרשאות לקובץ. האפשרות הזו זמינה רק אם המשתמש ששולח את הבקשה יכול לשתף את הקובץ. לא מאוכלס עבור פריטים באחסון שיתופי. |
hasThumbnail |
פלט בלבד. האם יש לקובץ הזה תמונה ממוזערת. ההגדרה הזו לא מציינת אם לאפליקציה ששולחת את הבקשה יש גישה לתמונה הממוזערת. כדי לבדוק את הגישה, מחפשים את השדה thumbnailLink. |
spaces[] |
פלט בלבד. רשימת המרחבים שבהם נמצא הקובץ. הערכים הנתמכים כרגע הם |
folderColorRgb |
הצבע של תיקייה או קיצור דרך לתיקייה כמחרוזת הקסדצימלית של RGB. הצבעים הנתמכים מפורסמים בשדה אם מציינים צבע שלא נתמך, המערכת משתמשת בצבע הכי קרוב בפלטה. |
id |
המזהה של הקובץ. |
name |
שם הקובץ. השם לא חייב להיות ייחודי בתוך תיקייה. שימו לב: עבור פריטים שלא ניתן לשנות, כמו תיקיות ברמה העליונה של תיקיות אחסון שיתופי, תיקיית הבסיס של 'האחסון שלי' והתיקייה 'נתוני אפליקציות', השם הוא קבוע. |
description |
תיאור קצר של הקובץ. |
starred |
האם המשתמש סימן את הקובץ בכוכב. |
trashed |
האם הקובץ הועבר לאשפה, באופן מפורש או מתיקיית אב שהועברה לאשפה. רק הבעלים יכול להעביר קובץ לפח, אבל משתמשים אחרים עדיין יכולים לגשת לקובץ בפח של הבעלים עד שהוא נמחק באופן סופי. |
explicitlyTrashed |
פלט בלבד. האם הקובץ הועבר במפורש לאשפה, בניגוד להעברה לאשפה באופן רקורסיבי מתיקיית האב. |
createdTime |
השעה שבה הקובץ נוצר (תאריך ושעה בפורמט RFC 3339). |
modifiedTime |
התאריך והשעה שבהם בוצע השינוי האחרון בקובץ על ידי משתמש כלשהו (RFC 3339 date-time). שימו לב שההגדרה |
modifiedByMeTime |
פלט בלבד. הפעם האחרונה שבה המשתמש שינה את הקובץ (תאריך ושעה בפורמט RFC 3339). |
viewedByMeTime |
הפעם האחרונה שהמשתמש צפה בקובץ (תאריך ושעה בפורמט RFC 3339). |
sharedWithMeTime |
פלט בלבד. השעה שבה הקובץ שותף עם המשתמש, אם רלוונטי (תאריך ושעה בפורמט RFC 3339). |
quotaBytesUsed |
פלט בלבד. מספר הבייטים של מכסת האחסון שהקובץ תופס. הנתונים האלה כוללים את הגרסה העדכנית וגם גרסאות קודמות שבהן האפשרות |
version |
פלט בלבד. מספר גרסה שגדל באופן מונוטוני של הקובץ. השינוי הזה משקף כל שינוי שבוצע בקובץ בשרת, גם אם הוא לא גלוי למשתמש. |
originalFilename |
שם הקובץ המקורי של התוכן שהועלה, אם הוא זמין, או הערך המקורי של השדה |
ownedByMe |
פלט בלבד. האם הקובץ בבעלות המשתמש. לא מאוכלס עבור פריטים באחסון שיתופי. |
fullFileExtension |
פלט בלבד. סיומת הקובץ המלאה שחולצה מהשדה השדה הזה מתעדכן אוטומטית כשמשנים את השדה |
properties |
אוסף של צמדי מפתח/ערך שרירותיים שגלויים לכל האפליקציות. רשומות עם ערכי null מנוקות בבקשות עדכון והעתקה. אובייקט שמכיל רשימה של |
appProperties |
אוסף של צמדי מפתח/ערך שרירותיים שפרטיים לאפליקציה ששולחת את הבקשה. רשומות עם ערכי null מנוקות בבקשות עדכון והעתקה. אפשר לאחזר את המאפיינים האלה רק באמצעות בקשה מאומתת. בקשה מאומתת משתמשת באסימון גישה שהתקבל באמצעות מזהה לקוח ב-OAuth 2.0. אי אפשר להשתמש במפתח API כדי לאחזר נכסים פרטיים. אובייקט שמכיל רשימה של |
isAppAuthorized |
פלט בלבד. האם הקובץ נוצר או נפתח על ידי האפליקציה ששולחת את הבקשה. |
teamDriveId |
הוצא משימוש: פלט בלבד. במקום זאת, אתם צריכים להשתמש ב- |
capabilities |
פלט בלבד. היכולות שיש למשתמש הנוכחי בקובץ הזה. כל יכולת מתאימה לפעולה ספציפית שהמשתמש יכול לבצע. מידע נוסף זמין במאמר בנושא הסבר על יכולות הקבצים. |
capabilities.canChangeViewersCanCopyContent |
הוצא משימוש: פלט בלבד. |
capabilities.canMoveChildrenOutOfDrive |
פלט בלבד. האם המשתמש הנוכחי יכול להעביר פריטי צאצא של התיקייה הזו מחוץ לאחסון השיתופי. הערך הוא |
capabilities.canReadDrive |
פלט בלבד. האם למשתמש הנוכחי יש הרשאת קריאה באחסון השיתופי שאליו הקובץ הזה שייך. השדה הזה מאוכלס רק עבור פריטים באחסון שיתופי. |
capabilities.canEdit |
פלט בלבד. האם המשתמש הנוכחי יכול לערוך את הקובץ הזה. גורמים אחרים עשויים להגביל את סוג השינויים שמשתמש יכול לבצע בקובץ. לדוגמה, ראו |
capabilities.canCopy |
פלט בלבד. האם המשתמש הנוכחי יכול להעתיק את הקובץ הזה. לפריט באחסון שיתופי, האם המשתמש הנוכחי יכול להעתיק צאצאים שאינם תיקיות של הפריט הזה, או את הפריט הזה אם הוא לא תיקייה. |
capabilities.canComment |
פלט בלבד. האם המשתמש הנוכחי יכול להגיב על הקובץ הזה. |
capabilities.canAddChildren |
פלט בלבד. האם המשתמש הנוכחי יכול להוסיף תיקיות צאצא לתיקייה הזו. הערך הזה הוא תמיד |
capabilities.canDelete |
פלט בלבד. האם המשתמש הנוכחי יכול למחוק את הקובץ הזה. |
capabilities.canDownload |
פלט בלבד. האם המשתמש הנוכחי יכול להוריד את הקובץ הזה. |
capabilities.canListChildren |
פלט בלבד. האם המשתמש הנוכחי יכול לראות את התיקיות שמוכלות בתיקייה הזו. הערך הזה הוא תמיד |
capabilities.canRemoveChildren |
פלט בלבד. האם המשתמש הנוכחי יכול להסיר תיקיות צאצא מהתיקייה הזו. הערך הזה הוא תמיד |
capabilities.canRename |
פלט בלבד. האם המשתמש הנוכחי יכול לשנות את השם של הקובץ הזה. |
capabilities.canTrash |
פלט בלבד. האם המשתמש הנוכחי יכול להעביר את הקובץ הזה לאשפה. |
capabilities.canReadRevisions |
פלט בלבד. האם המשתמש הנוכחי יכול לקרוא את משאב הגרסאות של הקובץ הזה. לפריט באחסון שיתופי, האם אפשר לקרוא את הגרסאות של צאצאים שאינם תיקיות של הפריט הזה, או את הפריט הזה אם הוא לא תיקייה. |
capabilities.canReadTeamDrive |
הוצא משימוש: פלט בלבד. במקום זאת, אתם צריכים להשתמש ב- |
capabilities.canMoveTeamDriveItem |
הוצא משימוש: פלט בלבד. במקומה, צריך להשתמש ב- |
capabilities.canChangeCopyRequiresWriterPermission |
פלט בלבד. האם המשתמש הנוכחי יכול לשנות את ההגבלה של הקובץ הזה ב- |
capabilities.canMoveItemIntoTeamDrive |
הוצא משימוש: פלט בלבד. במקום זאת, אתם צריכים להשתמש ב- |
capabilities.canUntrash |
פלט בלבד. האם המשתמש הנוכחי יכול לשחזר את הקובץ הזה מהאשפה. |
capabilities.canModifyContent |
פלט בלבד. האם המשתמש הנוכחי יכול לשנות את התוכן של הקובץ הזה. |
capabilities.canMoveItemWithinTeamDrive |
הוצא משימוש: פלט בלבד. במקום זאת, אתם צריכים להשתמש ב- |
capabilities.canMoveItemOutOfTeamDrive |
הוצא משימוש: פלט בלבד. במקום זאת, אתם צריכים להשתמש ב- |
capabilities.canDeleteChildren |
פלט בלבד. האם המשתמש הנוכחי יכול למחוק תיקיות משנה של התיקייה הזו. הערך הוא |
capabilities.canMoveChildrenOutOfTeamDrive |
הוצא משימוש: פלט בלבד. במקום זאת, אתם צריכים להשתמש ב- |
capabilities.canMoveChildrenWithinTeamDrive |
הוצא משימוש: פלט בלבד. במקום זאת, אתם צריכים להשתמש ב- |
capabilities.canTrashChildren |
פלט בלבד. האם המשתמש הנוכחי יכול להעביר לאשפה את הפריטים שמוכלים בתיקייה הזו. הערך הוא |
capabilities.canMoveItemOutOfDrive |
פלט בלבד. האם המשתמש הנוכחי יכול להעביר את הפריט הזה מחוץ לכונן הזה על ידי שינוי ההורה שלו. שימו לב: בקשה לשינוי ההורה של הפריט עדיין עשויה להיכשל, בהתאם להורה החדש שמתווסף. |
capabilities.canAddMyDriveParent |
פלט בלבד. האם המשתמש הנוכחי יכול להוסיף הורה לפריט בלי להסיר הורה קיים באותה בקשה. לא מאוכלס עבור קבצים באחסון שיתופי. |
capabilities.canRemoveMyDriveParent |
פלט בלבד. האם המשתמש הנוכחי יכול להסיר הורה מהפריט בלי להוסיף הורה אחר באותה בקשה. לא מאוכלס עבור קבצים באחסון שיתופי. |
capabilities.canMoveItemWithinDrive |
פלט בלבד. האם המשתמש הנוכחי יכול להעביר את הפריט הזה בתוך ה-Drive הזה. שימו לב: יכול להיות שבקשה לשינוי ההורה של הפריט עדיין תיכשל, בהתאם להורה החדש שנוסף ולהורה שמוסר. |
capabilities.canShare |
פלט בלבד. האם המשתמש הנוכחי יכול לשנות את הגדרות השיתוף של הקובץ הזה. |
capabilities.canMoveChildrenWithinDrive |
פלט בלבד. האם המשתמש הנוכחי יכול להעביר פריטים בתיקייה הזו ב-Drive. הערך הוא |
capabilities.canModifyContentRestriction |
הוצא משימוש: פלט בלבד. אפשר להשתמש ב- |
capabilities.canAddFolderFromAnotherDrive |
פלט בלבד. האם המשתמש הנוכחי יכול להוסיף תיקייה מ-Drive אחר (אחסון שיתופי אחר או 'האחסון שלי') לתיקייה הזו. הערך הוא |
capabilities.canChangeSecurityUpdateEnabled |
פלט בלבד. האם המשתמש הנוכחי יכול לשנות את השדה |
capabilities.canAcceptOwnership |
פלט בלבד. האם המשתמש הנוכחי הוא הבעלים בהמתנה של הקובץ. לא מאוכלס עבור קבצים באחסון שיתופי. |
capabilities.canReadLabels |
פלט בלבד. האם המשתמש הנוכחי יכול לקרוא את התוויות בקובץ. |
capabilities.canModifyLabels |
פלט בלבד. האם המשתמש הנוכחי יכול לשנות את התוויות בקובץ. |
capabilities.canModifyEditorContentRestriction |
פלט בלבד. האם המשתמש הנוכחי יכול להוסיף או לשנות הגבלות על התוכן בקובץ, שהן הגבלות לעורכים. |
capabilities.canModifyOwnerContentRestriction |
פלט בלבד. האם המשתמש הנוכחי יכול להוסיף או לשנות הגבלות על תוכן שמוגבלות לבעלים. |
capabilities.canRemoveContentRestriction |
פלט בלבד. האם יש הגבלת תוכן בקובץ שהמשתמש הנוכחי יכול להסיר. |
capabilities.canDisableInheritedPermissions |
האם משתמש יכול להשבית הרשאות שעברו בירושה. |
capabilities.canEnableInheritedPermissions |
האם משתמש יכול להפעיל מחדש הרשאות שעברו בירושה. |
capabilities.canChangeItemDownloadRestriction |
פלט בלבד. האם המשתמש הנוכחי יכול לשנות את ההגבלות על הורדת הקובץ שהוגדרו על ידי הבעלים או המארגן. |
capabilities.canStartApproval |
האם המשתמש הנוכחי יכול להתחיל תהליך אישור בקובץ. |
capabilities.canAccessViaGenAi |
האם המשתמש הנוכחי יכול לגשת לקובץ הזה באמצעות תכונות של Gen AI. מידע נוסף זמין במאמר בנושא התאמה של קובץ MCP ב-Drive. |
hasAugmentedPermissions |
פלט בלבד. האם יש הרשאות ישירות לקובץ הזה. השדה הזה מאוכלס רק עבור פריטים באחסון שיתופי. |
trashingUser |
פלט בלבד. אם הקובץ הועבר במפורש לאשפה, המשתמש שהעביר אותו לאשפה. השדה הזה מאוכלס רק עבור פריטים באחסון שיתופי. |
thumbnailVersion |
פלט בלבד. גרסת התמונה הממוזערת לשימוש בביטול תוקף של מטמון התמונות הממוזערות. |
trashedTime |
פלט בלבד. השעה שבה הפריט הועבר לאשפה (תאריך ושעה בפורמט RFC 3339). השדה הזה מאוכלס רק עבור פריטים באחסון שיתופי. |
modifiedByMe |
פלט בלבד. האם המשתמש הזה שינה את הקובץ. |
permissionIds[] |
פלט בלבד. רשימה של מזהי הרשאות של משתמשים שיש להם גישה לקובץ הזה. |
imageMediaMetadata |
פלט בלבד. מטא-נתונים נוספים על מדיית תמונות, אם יש כאלה. |
imageMediaMetadata.flashUsed |
פלט בלבד. האם נעשה שימוש בפלאש כדי ליצור את התמונה. |
imageMediaMetadata.meteringMode |
פלט בלבד. מצב המדידה ששימש ליצירת התמונה. |
imageMediaMetadata.sensor |
פלט בלבד. סוג החיישן ששימש ליצירת התמונה. |
imageMediaMetadata.exposureMode |
פלט בלבד. מצב החשיפה שבו צולמה התמונה. |
imageMediaMetadata.colorSpace |
פלט בלבד. מרחב הצבעים של התמונה. |
imageMediaMetadata.whiteBalance |
פלט בלבד. מצב איזון הלבן ששימש ליצירת התמונה. |
imageMediaMetadata.width |
פלט בלבד. רוחב התמונה בפיקסלים. |
imageMediaMetadata.height |
פלט בלבד. גובה התמונה בפיקסלים. |
imageMediaMetadata.location |
פלט בלבד. פרטי המיקום הגיאוגרפי שמאוחסנים בתמונה. |
imageMediaMetadata.location.latitude |
פלט בלבד. קו הרוחב ששמור בתמונה. |
imageMediaMetadata.location.longitude |
פלט בלבד. קו האורך שמאוחסן בתמונה. |
imageMediaMetadata.location.altitude |
פלט בלבד. הגובה מעל פני הים שמאוחסן בתמונה. |
imageMediaMetadata.rotation |
פלט בלבד. מספר הסיבובים ב-90 מעלות בכיוון השעון שבוצעו מהכיוון המקורי של התמונה. |
imageMediaMetadata.time |
פלט בלבד. התאריך והשעה שבהם התמונה צולמה (EXIF DateTime). |
imageMediaMetadata.cameraMake |
פלט בלבד. יצרן המצלמה שבה צולמה התמונה. |
imageMediaMetadata.cameraModel |
פלט בלבד. הדגם של המצלמה שבה צולמה התמונה. |
imageMediaMetadata.exposureTime |
פלט בלבד. משך החשיפה, בשניות. |
imageMediaMetadata.aperture |
פלט בלבד. הצמצם ששימש ליצירת התמונה (מספר הצמצם). |
imageMediaMetadata.focalLength |
פלט בלבד. אורך המוקד ששימש ליצירת התמונה, במילימטרים. |
imageMediaMetadata.isoSpeed |
פלט בלבד. מהירות ה-ISO ששימשה ליצירת התמונה. |
imageMediaMetadata.exposureBias |
פלט בלבד. פיצוי החשיפה של התמונה (ערך APEX). |
imageMediaMetadata.maxApertureValue |
פלט בלבד. מספר ה-f הקטן ביותר של העדשה באורך המוקד ששימש ליצירת התמונה (ערך APEX). |
imageMediaMetadata.subjectDistance |
פלט בלבד. המרחק מנושא הצילום, במטרים. |
imageMediaMetadata.lens |
פלט בלבד. העדשה ששימשה ליצירת התמונה. |
videoMediaMetadata |
פלט בלבד. מטא-נתונים נוספים על מדיה מסוג סרטון. יכול להיות שהאפשרות הזו לא תהיה זמינה מיד אחרי ההעלאה. |
videoMediaMetadata.width |
פלט בלבד. רוחב הסרטון בפיקסלים. |
videoMediaMetadata.height |
פלט בלבד. גובה הסרטון בפיקסלים. |
videoMediaMetadata.durationMillis |
פלט בלבד. משך הסרטון באלפיות השנייה. |
shortcutDetails |
פרטי קובץ קיצור הדרך. השדה הזה מאוכלס רק בקבצים של קיצורי דרך, שבהם השדה mimeType מוגדר ל- |
shortcutDetails.targetId |
המזהה של הקובץ שקיצור הדרך מצביע אליו. אפשר להגדיר רק בבקשות |
shortcutDetails.targetMimeType |
פלט בלבד. סוג ה-MIME של הקובץ שאליו מצביע קיצור הדרך. הערך של השדה הזה הוא תמונת מצב של סוג ה-MIME של היעד, שצולמה כשהקיצור נוצר. |
shortcutDetails.targetResourceKey |
פלט בלבד. ה- |
contentRestrictions[] |
הגבלות על הגישה לתוכן הקובץ. השדה יאוכלס רק אם קיימת הגבלה כזו. |
resourceKey |
פלט בלבד. מפתח שנדרש כדי לגשת לפריט דרך קישור משותף. |
linkShareMetadata |
פלט בלבד. פרטים שקשורים ל-LinkShare. המאפיין מכיל פרטים על כתובות ה-URL של הקישורים שבהם הלקוחות משתמשים כדי להפנות למוצר הזה. |
linkShareMetadata.securityUpdateEligible |
פלט בלבד. האם הקובץ עומד בדרישות לעדכון אבטחה. |
linkShareMetadata.securityUpdateEnabled |
פלט בלבד. האם עדכון האבטחה מופעל בקובץ הזה. |
labelInfo |
פלט בלבד. סקירה כללית של התוויות בקובץ. |
labelInfo.labels[] |
פלט בלבד. קבוצת התוויות בקובץ כפי שנדרש על ידי מזהי התוויות בפרמטר |
sha1Checksum |
פלט בלבד. סכום הבדיקה של SHA1 שמשויך לקובץ הזה, אם הוא זמין. השדה הזה מאוכלס רק עבור קבצים עם תוכן שמאוחסן ב-Google Drive. הוא לא מאוכלס עבור קבצים של עורכי Google Docs או קובצי קיצור דרך. |
sha256Checksum |
פלט בלבד. סכום הבדיקה SHA256 שמשויך לקובץ הזה, אם הוא זמין. השדה הזה מאוכלס רק עבור קבצים עם תוכן שמאוחסן ב-Google Drive. הוא לא מאוכלס עבור קבצים של עורכי Google Docs או קובצי קיצור דרך. |
inheritedPermissionsDisabled |
האם ההרשאות שהקובץ קיבל בירושה מושבתות. ההרשאות שעוברות בירושה מופעלות כברירת מחדל. |
downloadRestrictions |
הגבלות על הורדה חלות על הקובץ. |
clientEncryptionDetails |
פרטים שקשורים להצפנה מצד הלקוח. הקובץ מכיל פרטים על מצב ההצפנה של הקובץ ופרטים לגבי מנגנון ההצפנה שבו הלקוחות צריכים להשתמש כדי לפענח את התוכן של הפריט הזה. האפשרות הזו תופיע רק בקבצים ולא בתיקיות או בקיצורי דרך. |
ContentRestriction
הגבלה על הגישה לתוכן של הקובץ.
| ייצוג ב-JSON |
|---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
| שדות | |
|---|---|
readOnly |
האם התוכן של הקובץ הוא לקריאה בלבד. אם קובץ הוא לקריאה בלבד, יכול להיות שלא תהיה אפשרות להוסיף גרסה חדשה של הקובץ, להוסיף או לשנות תגובות ולשנות את שם הקובץ. |
reason |
הסיבה להגבלת התוכן בקובץ. אפשר לשנות את הערך הזה רק בבקשות שמוגדר בהן גם |
type |
פלט בלבד. סוג הגבלת התוכן. הערך האפשרי היחיד בשלב הזה הוא |
restrictingUser |
פלט בלבד. המשתמש שהגדיר את הגבלת התוכן. השדה הזה מאוכלס רק אם |
restrictionTime |
פלט בלבד. השעה שבה הוגדרה הגבלת התוכן (בפורמט RFC 3339 date-time). השדה הזה מאוכלס רק אם |
ownerRestricted |
האם רק משתמש שהוא הבעלים של הקובץ יכול לשנות או להסיר את הגבלת התוכן. בקבצים בתיקיות אחסון שיתופי, כל משתמש עם הרשאות |
systemRestricted |
פלט בלבד. האם הגבלת התוכן הוחלה על ידי המערכת, למשל בגלל חתימה אלקטרונית. המשתמשים לא יכולים לשנות או להסיר הגבלות על תוכן שמוגבל על ידי המערכת. |
DownloadRestrictionsMetadata
הגבלות על הורדה חלות על הקובץ.
| ייצוג ב-JSON |
|---|
{ "itemDownloadRestriction": { object ( |
| שדות | |
|---|---|
itemDownloadRestriction |
הגבלת ההורדה של הקובץ הוחלה ישירות על ידי הבעלים או המארגן. החישוב הזה לא מתבסס על הגדרות האחסון השיתופי או על כללי DLP. |
effectiveDownloadRestrictionWithContext |
פלט בלבד. ההגבלה על ההורדה שחלה על הקובץ הזה. ההגדרה הזו מתייחסת לכל הגדרות ההגבלה ולכללי DLP. |
DownloadRestriction
הגבלה על העתקה והורדה של הקובץ.
| ייצוג ב-JSON |
|---|
{ "restrictedForReaders": boolean, "restrictedForWriters": boolean } |
| שדות | |
|---|---|
restrictedForReaders |
האם ההורדה וההעתקה מוגבלות לקוראים. |
restrictedForWriters |
האם האפשרות להוריד ולהעתיק מוגבלת לבעלי הרשאת כתיבה. אם הערך הוא True, גם הקוראים לא יכולים להוריד את הספר. |
ClientEncryptionDetails
פרטים על ההצפנה מצד הלקוח שהוחלה על הקובץ.
| ייצוג ב-JSON |
|---|
{
"encryptionState": string,
"decryptionMetadata": {
object ( |
| שדות | |
|---|---|
encryptionState |
מצב ההצפנה של הקובץ. הערכים הצפויים כאן הם:
|
decryptionMetadata |
המטא-נתונים שמשמשים לפעולות בצד הלקוח. |
DecryptionMetadata
ייצוג של DecryptionMetadata של הצפנה מצד הלקוח (CSE).
| ייצוג ב-JSON |
|---|
{ "wrappedKey": string, "kaclsId": string, "kaclsName": string, "aes256GcmChunkSize": string, "jwt": string, "keyFormat": string, "encryptionResourceKeyHash": string } |
| שדות | |
|---|---|
wrappedKey |
המפתח העטוף בקידוד Base64 שמתאים לכתובות URL, שמשמש להצפנת התוכן של הקובץ. |
kaclsId |
המזהה של KACLS (השירות למפתחות הרשאות גישה) שמשמש להצפנת הקובץ. |
kaclsName |
השם של KACLS (שירות ACL למפתחות) שמשמש להצפנת הקובץ. |
aes256GcmChunkSize |
גודל החלק שבו נעשה שימוש אם התוכן הוצפן באמצעות הצפנה מסוג AES 256 GCM. הערכים האפשריים הם:
|
jwt |
אסימון JWT (JSON Web Token) חתום שאפשר להשתמש בו כדי להעניק הרשאה למשתמש ששולח את הבקשה באמצעות שירות ה-ACL של המפתח (KACLS). ב-JWT מצוין שלמשתמש ששולח את הבקשה יש לפחות הרשאות קריאה בקובץ. |
keyFormat |
פורמט המפתח של המפתח שלא עבר הסרה של העטיפה. חייב להיות |
encryptionResourceKeyHash |
תמצית הגיבוב (digest) של מטא-נתוני המשאב בפורמט HMAC-SHA256 בקידוד Base64 שמתאים לכתובות URL, עם מפתח ה-DEK (מפתח להצפנת נתונים) שלו. מידע נוסף זמין בכתובת https://developers.google.com/workspace/cse/reference |
Methods |
|
|---|---|
|
יוצר עותק של קובץ ומחיל את העדכונים המבוקשים באמצעות סמנטיקה של תיקון. |
|
יוצר קובץ. |
|
מחיקה סופית של קובץ שבבעלות המשתמש בלי להעביר אותו לאשפה. |
|
הורדה של תוכן מקובץ. |
|
מחיקה סופית של כל הקבצים שבאשפה של המשתמש. |
|
מייצא מסמך Google Workspace לסוג ה-MIME המבוקש ומחזיר את תוכן הבייטים המיוצא. |
|
יוצר אסימון של מנוע חיפוש בהתאמה אישית שאפשר להשתמש בו כדי ליצור או לעדכן קבצים של מנוע חיפוש בהתאמה אישית. |
|
יוצרת קבוצה של מזהי קבצים שאפשר לספק בבקשות ליצירה או להעתקה. |
|
אחזור מטא-נתונים או תוכן של קובץ לפי מזהה. |
|
רשימת הקבצים של המשתמש. |
|
רשימת התוויות בקובץ. |
|
משנה את קבוצת התוויות שמוחלות על קובץ. |
|
מעדכן את המטא-נתונים, התוכן או את שניהם של קובץ. |
|
הרשמה לקבלת עדכונים על שינויים בקובץ. |