REST Resource: files

משאב: קובץ

המטא-נתונים של קובץ.

כדי להשתמש בחלק מהשיטות של המשאבים (כמו files.update), נדרש fileId. משתמשים בשיטה files.list כדי לאחזר את המזהה של קובץ.

ייצוג ב-JSON
{
  "kind": string,
  "userPermission": {
    object (Permission)
  },
  "fileExtension": string,
  "md5Checksum": string,
  "selfLink": string,
  "ownerNames": [
    string
  ],
  "lastModifyingUserName": string,
  "editable": boolean,
  "writersCanShare": boolean,
  "downloadUrl": string,
  "mimeType": string,
  "exportLinks": {
    string: string,
    ...
  },
  "driveId": string,
  "parents": [
    {
      object (ParentReference)
    }
  ],
  "thumbnailLink": string,
  "appDataContents": boolean,
  "webViewLink": string,
  "iconLink": string,
  "shared": boolean,
  "lastModifyingUser": {
    object (User)
  },
  "owners": [
    {
      object (User)
    }
  ],
  "openWithLinks": {
    string: string,
    ...
  },
  "defaultOpenWithLink": string,
  "headRevisionId": string,
  "properties": [
    {
      object (Property)
    }
  ],
  "copyable": boolean,
  "etag": string,
  "sharingUser": {
    object (User)
  },
  "alternateLink": string,
  "embedLink": string,
  "webContentLink": string,
  "fileSize": string,
  "copyRequiresWriterPermission": boolean,
  "permissions": [
    {
      object (Permission)
    }
  ],
  "hasThumbnail": boolean,
  "spaces": [
    string
  ],
  "folderColorRgb": string,
  "id": string,
  "title": string,
  "description": string,
  "labels": {
    "viewed": boolean,
    "restricted": boolean,
    "starred": boolean,
    "hidden": boolean,
    "trashed": boolean,
    "modified": boolean
  },
  "explicitlyTrashed": boolean,
  "createdDate": string,
  "modifiedDate": string,
  "modifiedByMeDate": string,
  "lastViewedByMeDate": string,
  "markedViewedByMeDate": string,
  "sharedWithMeDate": string,
  "quotaBytesUsed": string,
  "version": string,
  "indexableText": {
    "text": string
  },
  "originalFilename": string,
  "ownedByMe": boolean,
  "canComment": boolean,
  "shareable": boolean,
  "fullFileExtension": string,
  "isAppAuthorized": boolean,
  "teamDriveId": string,
  "capabilities": {
    "canChangeRestrictedDownload": boolean,
    "canMoveChildrenOutOfDrive": boolean,
    "canReadDrive": boolean,
    "canEdit": boolean,
    "canCopy": boolean,
    "canComment": boolean,
    "canAddChildren": boolean,
    "canDelete": boolean,
    "canDownload": boolean,
    "canListChildren": boolean,
    "canRemoveChildren": boolean,
    "canRename": boolean,
    "canTrash": boolean,
    "canReadRevisions": boolean,
    "canReadTeamDrive": boolean,
    "canMoveTeamDriveItem": boolean,
    "canChangeCopyRequiresWriterPermission": boolean,
    "canMoveItemIntoTeamDrive": boolean,
    "canUntrash": boolean,
    "canModifyContent": boolean,
    "canMoveItemWithinTeamDrive": boolean,
    "canMoveItemOutOfTeamDrive": boolean,
    "canDeleteChildren": boolean,
    "canMoveChildrenOutOfTeamDrive": boolean,
    "canMoveChildrenWithinTeamDrive": boolean,
    "canTrashChildren": boolean,
    "canMoveItemOutOfDrive": boolean,
    "canAddMyDriveParent": boolean,
    "canRemoveMyDriveParent": boolean,
    "canMoveItemWithinDrive": boolean,
    "canShare": boolean,
    "canMoveChildrenWithinDrive": boolean,
    "canModifyContentRestriction": boolean,
    "canAddFolderFromAnotherDrive": boolean,
    "canChangeSecurityUpdateEnabled": boolean,
    "canAcceptOwnership": boolean,
    "canReadLabels": boolean,
    "canModifyLabels": boolean,
    "canModifyEditorContentRestriction": boolean,
    "canModifyOwnerContentRestriction": boolean,
    "canRemoveContentRestriction": boolean,
    "canDisableInheritedPermissions": boolean,
    "canEnableInheritedPermissions": boolean
  },
  "hasAugmentedPermissions": boolean,
  "trashingUser": {
    object (User)
  },
  "canReadRevisions": boolean,
  "thumbnailVersion": string,
  "trashedDate": string,
  "permissionIds": [
    string
  ],
  "thumbnail": {
    "image": string,
    "mimeType": string
  },
  "imageMediaMetadata": {
    "flashUsed": boolean,
    "meteringMode": string,
    "sensor": string,
    "exposureMode": string,
    "colorSpace": string,
    "whiteBalance": string,
    "width": integer,
    "height": integer,
    "location": {
      "latitude": number,
      "longitude": number,
      "altitude": number
    },
    "rotation": integer,
    "date": string,
    "cameraMake": string,
    "cameraModel": string,
    "exposureTime": number,
    "aperture": number,
    "focalLength": number,
    "isoSpeed": integer,
    "exposureBias": number,
    "maxApertureValue": number,
    "subjectDistance": integer,
    "lens": string
  },
  "videoMediaMetadata": {
    "width": integer,
    "height": integer,
    "durationMillis": string
  },
  "shortcutDetails": {
    "targetId": string,
    "targetMimeType": string,
    "targetResourceKey": string
  },
  "contentRestrictions": [
    {
      object (ContentRestriction)
    }
  ],
  "resourceKey": string,
  "linkShareMetadata": {
    "securityUpdateEligible": boolean,
    "securityUpdateEnabled": boolean
  },
  "labelInfo": {
    "labels": [
      {
        object (Label)
      }
    ]
  },
  "sha1Checksum": string,
  "sha256Checksum": string,
  "inheritedPermissionsDisabled": boolean
}
שדות
kind

string

פלט בלבד. סוג הקובץ. הערך הזה הוא תמיד drive#file.

userPermission

object (Permission)

פלט בלבד. ההרשאות של המשתמש המאומת בקובץ הזה.

fileExtension

string

פלט בלבד. הרכיב האחרון של fullFileExtension עם טקסט נלווה שלא נראה כחלק מהתוסף הוסר. השדה הזה מאוכלס רק בקבצים עם תוכן שמאוחסן ב-Google Drive. הוא לא מאוכלס בקבצים של עורכי Docs או בקבצי קיצור דרך.

md5Checksum

string

פלט בלבד. סיכום ביקורת (checksum) מסוג MD5 של תוכן הקובץ. השדה הזה מאוכלס רק בקבצים עם תוכן שמאוחסן ב-Google Drive. הוא לא מאוכלס בקבצים של עורכי Docs או בקבצי קיצור דרך.

ownerNames[]

string

פלט בלבד. השמות של הבעלים של הקובץ. לא מאוכלס בפריטים באחסון שיתופי.

lastModifyingUserName

string

פלט בלבד. שם המשתמש האחרון ששינה את הקובץ.

editable
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-capabilities/canEdit.

writersCanShare

boolean

אם הכותבים יכולים לשתף את המסמך עם משתמשים אחרים. לא מאוכלס בפריטים באחסון שיתופי.

downloadUrl

string

פלט בלבד. כתובת URL קצרת טווח להורדת הקובץ. השדה הזה מאוכלס רק לגבי קבצים עם תוכן שמאוחסן ב-Google Drive. הוא לא מאוכלס לגבי קבצים של Google Docs או קיצורי דרך.

mimeType

string

סוג ה-MIME של הקובץ. אפשר לשנות את האפשרות הזו רק במהלך עדכון כשמעלים תוכן חדש. אפשר להשאיר את השדה הזה ריק, וה-MIMEtype יקבע לפי סוג ה-MIME של התוכן שהועלו.

driveId

string

פלט בלבד. המזהה של האחסון השיתופי שבו נמצא הקובץ. השדה מאוכלס רק לגבי פריטים באחסון שיתופי.

parents[]

object (ParentReference)

המזהה של תיקיית ההורה שמכילה את הקובץ.

לקובץ יכולה להיות רק תיקיית הורה אחת. לא ניתן לציין כמה הורים.

אם לא צוין כחלק מבקשת ההוספה, הקובץ יופיע ישירות בתיקייה 'האחסון שלי' של המשתמש. אם לא מציינים את ההורה כחלק מבקשת ההעתקה, הקובץ יורש כל הורה גלוי של קובץ המקור. בבקשות files.update צריך להשתמש בפרמטרים addParents ו-removeParents כדי לשנות את רשימת ההורים.

appDataContents

boolean

פלט בלבד. האם הקובץ נמצא בתיקייה Application Data.

shared

boolean

פלט בלבד. האם הקובץ שותף. לא מאוכלס בפריטים באחסון שיתופי.

lastModifyingUser

object (User)

פלט בלבד. המשתמש האחרון ששינה את הקובץ. השדה הזה מאוכלס רק אם השינוי האחרון בוצע על ידי משתמש שמחובר לחשבון.

owners[]

object (User)

פלט בלבד. הבעלים של הקובץ. רק לקבצים מסוימים מדור קודם יכולים להיות כמה בעלים. השדה הזה לא מאוכלס בפריטים שבתיקיות אחסון שיתופי.

headRevisionId

string

פלט בלבד. המזהה של הגרסה הראשית של הקובץ. השדה הזה מאוכלס רק בקבצים עם תוכן שמאוחסן ב-Google Drive. הוא לא מאוכלס בקבצים של עורכי Docs או בקבצי קיצור דרך.

properties[]

object (Property)

רשימת הנכסים.

copyable
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-capabilities/canCopy.

etag

string

פלט בלבד. ה-ETag של הקובץ.

sharingUser

object (User)

פלט בלבד. המשתמש ששיתף את הפריט עם המשתמש הנוכחי, אם הוא זמין.

fileSize

string (int64 format)

פלט בלבד. הגודל בבייטים של blobs וקבצים של עורך מהדומיין הנוכחי. לא יאוכלס בקבצים שאין להם גודל, כמו קיצורי דרך ותיקיות.

copyRequiresWriterPermission

boolean

האם להשבית את האפשרויות להעתקה, להדפסה או להורדה של הקובץ הזה עבור הקוראים והמגיבים.

permissions[]

object (Permission)

פלט בלבד. רשימת ההרשאות של המשתמשים שיש להם גישה לקובץ הזה. לא מאוכלס בפריטים באחסון שיתופי.

hasThumbnail

boolean

פלט בלבד. אם לקובץ יש תמונה ממוזערת. הסטטוס הזה לא מציין אם לאפליקציה המבקשת יש גישה לתמונה הממוזערת. כדי לבדוק את הגישה, מחפשים את השדה thumbnailLink.

spaces[]

string

פלט בלבד. רשימת המרחבים המשותפים שמכילים את הקובץ. הערכים הנתמכים הם drive, ‏ appDataFolder ו-photos.

folderColorRgb

string

צבע התיקייה כמחרוזת הקסדצימלית RGB, אם הקובץ הוא תיקייה או קיצור דרך לתיקייה. רשימת הצבעים הנתמכים זמינה בשדה folderColorPalette של משאב About. אם יצוין צבע לא נתמך, הוא ישתנה לצבע הקרוב ביותר בלוח הצבעים.

id

string

המזהה של הקובץ.

title

string

שם הקובץ. שימו לב: לפריטים שלא ניתן לשנות, כמו התיקיות ברמה העליונה של האחסון השיתופי, תיקיית הבסיס של 'האחסון שלי' והתיקייה 'נתוני אפליקציה', השם הוא קבוע.

description

string

תיאור קצר של הקובץ.

labels

object

קבוצת תוויות לקובץ.

labels.viewed

boolean

האם המשתמש הזה צפה בקובץ.

labels.restricted
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-copyRequiresWriterPermission.

labels.starred

boolean

אם המשתמש סימן את הקובץ הזה בכוכב.

labels.hidden
(deprecated)

boolean

פלט בלבד. הוצא משימוש.

labels.trashed

boolean

האם הקובץ הזה הועבר לאשפה. התווית הזו חלה על כל המשתמשים שיש להם גישה לקובץ, אבל רק הבעלים יכולים לראות קבצים ולהוציא אותם מהאשפה.

labels.modified

boolean

פלט בלבד. האם המשתמש הזה שינה את הקובץ.

explicitlyTrashed

boolean

פלט בלבד. אם הקובץ הזה הועבר לאשפה באופן מפורש, בניגוד להעברה חזרה ושוב לאשפה.

createdDate

string

פלט בלבד. זמן היצירה של הקובץ (חותמת זמן בפורמט RFC 3339).

modifiedDate

string

הפעם האחרונה שבה מישהו שינה את הקובץ הזה (חותמת זמן בפורמט RFC 3339). אפשר לשנות את הערך הזה רק בזמן העדכון, כשמגדירים את הפרמטר setModifiedDate.

modifiedByMeDate

string

פלט בלבד. הפעם האחרונה שהמשתמש שינה את הקובץ (חותמת זמן בפורמט RFC 3339). שימו לב שהגדרת modifiedDate תעדכן גם את התאריך modifiedByMe של המשתמש שהגדיר את התאריך.

lastViewedByMeDate

string

הפעם האחרונה שהמשתמש צפה בקובץ הזה (חותמת זמן בפורמט RFC 3339).

markedViewedByMeDate
(deprecated)

string

פלט בלבד. הוצא משימוש.

sharedWithMeDate

string

פלט בלבד. השעה שבה הקובץ הזה שותף עם המשתמש (חותמת זמן בפורמט RFC 3339).

quotaBytesUsed

string (int64 format)

פלט בלבד. מספר הבייטים במכסה שנעשה בהם שימוש בקובץ הזה.

version

string (int64 format)

פלט בלבד. מספר גרסה של הקובץ שגדל באופן מונוטוני. הוא משקף כל שינוי שבוצע בקובץ בשרת, גם שינויים שלא גלויים למשתמש המבקש.

indexableText

object

מאפייני טקסט שניתנים להוספה לאינדקס של הקובץ (אפשר רק לכתוב אותם)

indexableText.text

string

הטקסט שרוצים להוסיף לאינדקס עבור הקובץ הזה.

originalFilename

string

שם הקובץ המקורי של התוכן שהועל, אם הוא זמין, או הערך המקורי של השדה title. האפשרות הזו זמינה רק לקבצים עם תוכן בינארי ב-Google Drive.

ownedByMe

boolean

פלט בלבד. אם הקובץ בבעלות המשתמש הנוכחי. לא מאוכלס בפריטים באחסון שיתופי.

canComment
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-capabilities/canComment.

shareable
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-capabilities/canShare.

fullFileExtension

string

פלט בלבד. סיומת הקובץ המלאה, שחולצה מהשם. יכול להכיל כמה סיומת מחוברות, למשל 'tar.gz'. הסרת תוסף מהשם לא מנקה את השדה הזה, אבל שינוי התוסף בשם מעדכן את השדה הזה. השדה הזה מאוכלס רק בקבצים עם תוכן שמאוחסן ב-Google Drive. הוא לא מאוכלס בקבצים של עורכי Docs או בקבצי קיצור דרך.

isAppAuthorized

boolean

פלט בלבד. האם הקובץ נוצר או נפתח על ידי האפליקציה המבקשת.

teamDriveId
(deprecated)

string

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-driveId.

capabilities

object

פלט בלבד. הרשאות המשתמש הנוכחי בקובץ הזה. כל יכולת תואמת לפעולה מפורטת שמשתמש יכול לבצע.

capabilities.canChangeRestrictedDownload
(deprecated)

boolean

פלט בלבד. הוצא משימוש.

capabilities.canMoveChildrenOutOfDrive

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להעביר תיקיות צאצא של התיקייה הזו מחוץ לאחסון השיתופי. הערך הוא שקר אם הפריט הוא לא תיקייה. השדה מאוכלס רק לגבי פריטים באחסון שיתופי.

capabilities.canReadDrive

boolean

פלט בלבד. האם למשתמש הנוכחי יש אפשרות לקרוא את האחסון השיתופי שאליו שייך הקובץ הזה. השדה מאוכלס רק לגבי פריטים באחסון שיתופי.

capabilities.canEdit

boolean

פלט בלבד. האם המשתמש הנוכחי יכול לערוך את הקובץ הזה. גורמים אחרים עשויים להגביל את סוג השינויים שמשתמש יכול לבצע בקובץ. לדוגמה, canChangeCopyRequiresWriterPermission או canModifyContent.

capabilities.canCopy

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להעתיק את הקובץ הזה. לגבי פריט באחסון שיתופי, האם המשתמש הנוכחי יכול להעתיק צאצאים של הפריט הזה שאינם תיקיות, או את הפריט עצמו אם הוא לא תיקייה.

capabilities.canComment

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להגיב על הקובץ הזה.

capabilities.canAddChildren

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להוסיף תיקיות צאצא לתיקייה הזו. הערך הזה תמיד יהיה false אם הפריט הוא לא תיקייה.

capabilities.canDelete

boolean

פלט בלבד. האם המשתמש הנוכחי יכול למחוק את הקובץ הזה.

capabilities.canDownload

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להוריד את הקובץ הזה.

capabilities.canListChildren

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להציג את רשימת הצאצאים של התיקייה הזו. הערך הזה תמיד יהיה false אם הפריט הוא לא תיקייה.

capabilities.canRemoveChildren

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להסיר ילדים מהתיקייה הזו. הערך הזה תמיד יהיה false אם הפריט הוא לא תיקייה. לתיקייה באחסון שיתופי, משתמשים במקום זאת ב-canDeleteChildren או ב-canTrashChildren.

capabilities.canRename

boolean

פלט בלבד. האם המשתמש הנוכחי יכול לשנות את שם הקובץ.

capabilities.canTrash

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להעביר את הקובץ הזה לאשפה.

capabilities.canReadRevisions

boolean

פלט בלבד. האם המשתמש הנוכחי יכול לקרוא את משאב הגרסאות של הקובץ הזה. בפריטים באחסון שיתופי, אפשר לקרוא גרסאות של צאצאים של הפריט הזה שאינם תיקיות, או את הפריט עצמו אם הוא לא תיקייה.

capabilities.canReadTeamDrive
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-canReadDrive.

capabilities.canMoveTeamDriveItem
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-canMoveItemWithinDrive או ב-canMoveItemOutOfDrive.

capabilities.canChangeCopyRequiresWriterPermission

boolean

פלט בלבד. האם המשתמש הנוכחי יכול לשנות את ההגבלה copyRequiresWriterPermission של הקובץ הזה.

capabilities.canMoveItemIntoTeamDrive
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-canMoveItemOutOfDrive.

capabilities.canUntrash

boolean

פלט בלבד. האם המשתמש הנוכחי יכול לשחזר את הקובץ הזה מהאשפה.

capabilities.canModifyContent

boolean

פלט בלבד. האם המשתמש הנוכחי יכול לשנות את התוכן של הקובץ הזה.

capabilities.canMoveItemWithinTeamDrive
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-canMoveItemWithinDrive.

capabilities.canMoveItemOutOfTeamDrive
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-canMoveItemOutOfDrive.

capabilities.canDeleteChildren

boolean

פלט בלבד. האם המשתמש הנוכחי יכול למחוק צאצאים של התיקייה הזו. הערך הוא שקר אם הפריט הוא לא תיקייה. השדה מאוכלס רק לגבי פריטים באחסון שיתופי.

capabilities.canMoveChildrenOutOfTeamDrive
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-canMoveChildrenOutOfDrive.

capabilities.canMoveChildrenWithinTeamDrive
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-canMoveChildrenWithinDrive.

capabilities.canTrashChildren

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להעביר לאשפה צאצאים של התיקייה הזו. הערך הוא שקר אם הפריט הוא לא תיקייה. השדה מאוכלס רק לגבי פריטים באחסון שיתופי.

capabilities.canMoveItemOutOfDrive

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להעביר את הפריט הזה מחוץ להתקן האחסון הזה על ידי שינוי ההורה שלו. חשוב לזכור שבקשה לשינוי ההורה של הפריט עדיין עשויה להיכשל, בהתאם להורה החדש שנוסף.

capabilities.canAddMyDriveParent

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להוסיף הורה לפריט בלי להסיר הורה קיים באותה בקשה. לא מאוכלס בקבצים מאחסון שיתופי.

capabilities.canRemoveMyDriveParent

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להסיר הורה מהפריט בלי להוסיף הורה נוסף באותה בקשה. לא מאוכלס בקבצים מאחסון שיתופי.

capabilities.canMoveItemWithinDrive

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להעביר את הפריט הזה בתוך האחסון הזה. שימו לב: יכול להיות שבקשה לשינוי ההורה של הפריט עדיין תיכשל, בהתאם להורה החדש שנוסף ולהורה שמבוטל.

capabilities.canShare

boolean

פלט בלבד. האם המשתמש הנוכחי יכול לשנות את הגדרות השיתוף של הקובץ הזה.

capabilities.canMoveChildrenWithinDrive

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להעביר תיקיות צאצאיות של התיקייה הזו בתוך ההתקן הזה. הערך הוא שקר אם הפריט הוא לא תיקייה. שימו לב: בקשה להעברת הצאצא עדיין עשויה להיכשל, בהתאם לגישה של המשתמש הנוכחי לצאצא ולתיקיית היעד.

capabilities.canModifyContentRestriction
(deprecated)

boolean

הוצא משימוש: פלט בלבד. משתמשים ב-canModifyEditorContentRestriction, ב-canModifyOwnerContentRestriction או ב-canRemoveContentRestriction.

capabilities.canAddFolderFromAnotherDrive

boolean

פלט בלבד. אם המשתמש הנוכחי יכול להוסיף לתיקייה הזו תיקייה מאחסון אחר (אחסון שיתופי אחר או 'האחסון שלי'). הערך הוא שקר אם הפריט הוא לא תיקייה. השדה מאוכלס רק לגבי פריטים באחסון שיתופי.

capabilities.canChangeSecurityUpdateEnabled

boolean

פלט בלבד. אם המשתמש הנוכחי יכול לשנות את השדה securityUpdateEnabled במטא-נתונים של שיתוף הקישור.

capabilities.canAcceptOwnership

boolean

פלט בלבד. האם המשתמש הנוכחי הוא הבעלים בהמתנה של הקובץ. לא מאוכלס בקבצים מאחסון שיתופי.

capabilities.canReadLabels

boolean

פלט בלבד. האם המשתמש הנוכחי יכול לקרוא את התוויות בקובץ.

capabilities.canModifyLabels

boolean

פלט בלבד. אם המשתמש הנוכחי יכול לשנות את התוויות בקובץ.

capabilities.canModifyEditorContentRestriction

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להוסיף או לשנות הגבלות תוכן בקובץ שהן מוגבלות לעורכים.

capabilities.canModifyOwnerContentRestriction

boolean

פלט בלבד. האם המשתמש הנוכחי יכול להוסיף או לשנות הגבלות תוכן שהבעלים הגביל.

capabilities.canRemoveContentRestriction

boolean

פלט בלבד. אם יש הגבלת תוכן על הקובץ שאפשר להסיר על ידי המשתמש הנוכחי.

capabilities.canDisableInheritedPermissions

boolean

פלט בלבד. אם משתמש יכול להשבית הרשאות שעברו בירושה.

capabilities.canEnableInheritedPermissions

boolean

פלט בלבד. אם משתמש יכול להפעיל מחדש הרשאות שעברו בירושה.

hasAugmentedPermissions

boolean

פלט בלבד. אם יש הרשאות ישירות בקובץ הזה. השדה הזה מאוכלס רק עבור פריטים באחסון שיתופי.

trashingUser

object (User)

פלט בלבד. אם הקובץ הועבר לאשפה באופן מפורש, המשתמש שהעביר אותו לאשפה. השדה מאוכלס רק לגבי פריטים באחסון שיתופי.

canReadRevisions
(deprecated)

boolean

פלט בלבד. האפשרות הזו הוצאה משימוש. במקום זאת, צריך להשתמש ב-capabilities/canReadRevisions.

thumbnailVersion

string (int64 format)

פלט בלבד. גרסת התמונה הממוזערת לשימוש בביטול התוקף של מטמון התמונות הממוזערות.

trashedDate

string

פלט בלבד. השעה שבה הפריט הועבר לאשפה (חותמת זמן בפורמט RFC 3339). השדה מאוכלס רק לגבי פריטים באחסון שיתופי.

permissionIds[]

string

פלט בלבד. רשימת מזהי ההרשאות של משתמשים שיש להם גישה לקובץ הזה.

thumbnail

object

תמונה ממוזערת של הקובץ. המערכת תשתמש באפשרות הזו רק אם לא ניתן ליצור תמונה ממוזערת רגילה.

thumbnail.image

string (bytes format)

הבייטים של התמונה הממוזערת בקידוד Base64 בטוח לכתובות URL. הוא צריך לעמוד בדרישות של סעיף 5 ב-RFC 4648.

מחרוזת בקידוד Base64.

thumbnail.mimeType

string

סוג ה-MIME של התמונה הממוזערת.

imageMediaMetadata

object

פלט בלבד. מטא-נתונים על מדיית תמונות. השדה הזה יופיע רק בסוגי תמונות, והתוכן שלו יהיה תלוי במה שאפשר לנתח מתוכן התמונה.

imageMediaMetadata.flashUsed

boolean

פלט בלבד. אם השתמשתם בפלאש כדי ליצור את התמונה.

imageMediaMetadata.meteringMode

string

פלט בלבד. מצב המדידה ששימש ליצירת התמונה.

imageMediaMetadata.sensor

string

פלט בלבד. סוג החיישן ששימש ליצירת התמונה.

imageMediaMetadata.exposureMode

string

פלט בלבד. מצב החשיפה שבו השתמשתם כדי ליצור את התמונה.

imageMediaMetadata.colorSpace

string

פלט בלבד. מרחב הצבעים של התמונה.

imageMediaMetadata.whiteBalance

string

פלט בלבד. מצב איזון הלבן ששימש ליצירת התמונה.

imageMediaMetadata.width

integer

פלט בלבד. רוחב התמונה בפיקסלים.

imageMediaMetadata.height

integer

פלט בלבד. הגובה של התמונה בפיקסלים.

imageMediaMetadata.location

object

פלט בלבד. פרטי המיקום הגיאוגרפי שמאוחסנים בתמונה.

imageMediaMetadata.location.latitude

number

פלט בלבד. קו הרוחב ששמור בתמונה.

imageMediaMetadata.location.longitude

number

פלט בלבד. קו הרוחב ששמור בתמונה.

imageMediaMetadata.location.altitude

number

פלט בלבד. הגובה שמאוחסן בתמונה.

imageMediaMetadata.rotation

integer

פלט בלבד. מספר הסיבובים ב-90 מעלות בכיוון השעון שחלים על התמונה מהכיוון המקורי שלה.

imageMediaMetadata.date

string

פלט בלבד. התאריך והשעה שבהם צולמה התמונה (חותמת זמן בפורמט EXIF).

imageMediaMetadata.cameraMake

string

פלט בלבד. היצרן של המצלמה ששימשה ליצירת התמונה.

imageMediaMetadata.cameraModel

string

פלט בלבד. הדגם של המצלמה ששימשה ליצירת התמונה.

imageMediaMetadata.exposureTime

number

פלט בלבד. משך החשיפה, בשניות.

imageMediaMetadata.aperture

number

פלט בלבד. הצמצם ששימש ליצירת התמונה (מספר f).

imageMediaMetadata.focalLength

number

פלט בלבד. אורך המוקד ששימש ליצירת התמונה, במילימטרים.

imageMediaMetadata.isoSpeed

integer

פלט בלבד. מהירות ה-ISO ששימשה ליצירת התמונה.

imageMediaMetadata.exposureBias

number

פלט בלבד. פיצוי החשיפה של התמונה (ערך APEX).

imageMediaMetadata.maxApertureValue

number

פלט בלבד. מספר ה-f הקטן ביותר של העדשה באורך המוקד ששימש ליצירת התמונה (ערך APEX).

imageMediaMetadata.subjectDistance

integer

פלט בלבד. המרחק לנושא התמונה, במטרים.

imageMediaMetadata.lens

string

פלט בלבד. העדשה ששימשה ליצירת התמונה.

videoMediaMetadata

object

פלט בלבד. מטא-נתונים על מדיית הסרטון. האפשרות הזו תופיע רק לגבי סוגים של סרטונים.

videoMediaMetadata.width

integer

פלט בלבד. רוחב הסרטון בפיקסלים.

videoMediaMetadata.height

integer

פלט בלבד. הגובה של הסרטון בפיקסלים.

videoMediaMetadata.durationMillis

string (int64 format)

פלט בלבד. משך הסרטון באלפיות שנייה.

shortcutDetails

object

פרטי הקובץ של קיצור הדרך. השדה מאוכלס רק בקבצי קיצור דרך שבהם השדה mimeType מוגדר כ-application/vnd.google-apps.shortcut. אפשר להגדיר את האפשרות הזו רק לבקשות files.insert.

shortcutDetails.targetId

string

המזהה של הקובץ שאליו מפנה קיצור הדרך הזה. אפשר להגדיר את האפשרות הזו רק לבקשות files.insert.

shortcutDetails.targetMimeType

string

פלט בלבד. סוג ה-MIME של הקובץ שאליו מפנה קיצור הדרך. הערך של השדה הזה הוא תמונת מצב של סוג ה-MIME של היעד, שצולמה כשיוצרים את קיצור הדרך.

shortcutDetails.targetResourceKey

string

פלט בלבד. ResourceKey של קובץ היעד.

contentRestrictions[]

object (ContentRestriction)

הגבלות על הגישה לתוכן של הקובץ. השדה מאוכלס רק אם קיימת הגבלה כזו.

resourceKey

string

פלט בלבד. מפתח שנחוץ כדי לגשת לפריט דרך קישור משותף.

linkShareMetadata.securityUpdateEligible

boolean

פלט בלבד. אם הקובץ עומד בדרישות לקבלת עדכון אבטחה.

linkShareMetadata.securityUpdateEnabled

boolean

פלט בלבד. אם עדכון האבטחה מופעל בקובץ הזה.

labelInfo

object

פלט בלבד. סקירה כללית של התוויות בקובץ.

labelInfo.labels[]

object (Label)

פלט בלבד. קבוצת התוויות בקובץ, כפי שנדרש לפי מזהי התוויות בפרמטר includeLabels. כברירת מחדל, לא מוחזר אף תווית.

sha1Checksum

string

פלט בלבד. סיכום הביקורת (checksum) מסוג SHA1 שמשויך לקובץ הזה, אם הוא זמין. השדה הזה מאוכלס רק בקבצים עם תוכן שמאוחסן ב-Google Drive. הוא לא מאוכלס בקבצים של עורכי Docs או בקבצי קיצור דרך.

sha256Checksum

string

פלט בלבד. סיכום הביקורת (checksum) של SHA256 שמשויך לקובץ הזה, אם הוא זמין. השדה הזה מאוכלס רק בקבצים עם תוכן שמאוחסן ב-Google Drive. הוא לא מאוכלס בקבצים של עורכי Docs או בקבצי קיצור דרך.

inheritedPermissionsDisabled

boolean

אם ההרשאות שעברו בירושה בקובץ הזה מושבתות. הרשאות שעברו בירושה מופעלות כברירת מחדל.

ContentRestriction

הגבלה על הגישה לתוכן של הקובץ.

ייצוג ב-JSON
{
  "readOnly": boolean,
  "reason": string,
  "type": string,
  "restrictingUser": {
    object (User)
  },
  "restrictionDate": string,
  "ownerRestricted": boolean,
  "systemRestricted": boolean
}
שדות
readOnly

boolean

אם התוכן של הקובץ הוא לקריאה בלבד. אם קובץ הוא לקריאה בלבד, אי אפשר להוסיף גרסה חדשה של הקובץ, אי אפשר להוסיף או לשנות הערות ואי אפשר לשנות את שם הקובץ.

reason

string

הסיבה שבגללה התוכן של הקובץ מוגבל. אפשר לשנות את הערך הזה רק בבקשות שבהן מוגדר גם readOnly=true.

type

string

פלט בלבד. סוג ההגבלה על התוכן. הערך היחיד האפשרי כרגע הוא globalContentRestriction.

restrictingUser

object (User)

פלט בלבד. המשתמש שהגדיר את הגבלת התוכן. העמודה מאוכלסת רק אם הערך של readOnly הוא true.

restrictionDate

string

פלט בלבד. השעה שבה הוגדרה הגבלת התוכן (חותמת זמן בפורמט RFC 3339). העמודה מאוכלסת רק אם הערך של readOnly הוא true.

ownerRestricted

boolean

אם רק משתמש שהוא הבעלים של הקובץ יכול לשנות או להסיר את הגבלת התוכן. לגבי קבצים בתיקיות אחסון שיתופי, כל משתמש עם הרשאות organizer יכול לשנות או להסיר את הגבלת התוכן הזו.

systemRestricted

boolean

פלט בלבד. אם הגבלת התוכן הופעלה על ידי המערכת, למשל בגלל חתימה אלקטרונית. משתמשים לא יכולים לשנות או להסיר הגבלות על תוכן מוגבל במערכת.

Methods

copy

יצירת עותק של הקובץ שצוין.

delete

מחיקה של קובץ שבבעלות המשתמש באופן סופי, בלי להעביר אותו לאשפה.

emptyTrash

מחיקה סופית של כל הקבצים של המשתמש שנמצאים בפח.

export

הפונקציה מייצאת מסמך Google Workspace לסוג ה-MIME המבוקש ומחזירה את תוכן הבייטים המיוצא.

generateIds

יצירת קבוצה של מזהי קבצים שאפשר לספק בבקשות להוספה או להעתקה.

get

אחזור המטא-נתונים או התוכן של קובץ לפי מזהה.

insert

הוספת קובץ חדש.

list

רשימה של הקבצים של המשתמש.

listLabels

הצגת רשימת התוויות בקובץ.

modifyLabels

שינוי קבוצת התוויות שהוחלו על קובץ.

patch

עדכון המטא-נתונים ו/או התוכן של קובץ.

touch

מגדירים את השעה המעודכנת של הקובץ לשעת השרת הנוכחית.

trash

העברת קובץ לאשפה.

untrash

שחזור קובץ מהאשפה.

update

עדכון המטא-נתונים ו/או התוכן של קובץ.

watch

הרשמה לקבלת עדכונים על שינויים בקובץ.