REST Resource: drives

משאב: Drive

ייצוג של אחסון שיתופי.

כדי להשתמש בחלק מהשיטות של המשאבים (כמו drives.update), נדרש driveId. משתמשים בשיטה drives.list כדי לאחזר את המזהה של אחסון שיתופי.

ייצוג ב-JSON
{
  "id": string,
  "name": string,
  "colorRgb": string,
  "kind": string,
  "backgroundImageLink": string,
  "capabilities": {
    "canAddChildren": boolean,
    "canComment": boolean,
    "canCopy": boolean,
    "canDeleteDrive": boolean,
    "canDownload": boolean,
    "canEdit": boolean,
    "canListChildren": boolean,
    "canManageMembers": boolean,
    "canReadRevisions": boolean,
    "canRename": boolean,
    "canRenameDrive": boolean,
    "canChangeDriveBackground": boolean,
    "canShare": boolean,
    "canChangeCopyRequiresWriterPermissionRestriction": boolean,
    "canChangeDomainUsersOnlyRestriction": boolean,
    "canChangeDriveMembersOnlyRestriction": boolean,
    "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": boolean,
    "canResetDriveRestrictions": boolean,
    "canDeleteChildren": boolean,
    "canTrashChildren": boolean
  },
  "themeId": string,
  "backgroundImageFile": {
    "id": string,
    "xCoordinate": number,
    "yCoordinate": number,
    "width": number
  },
  "createdDate": string,
  "hidden": boolean,
  "restrictions": {
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean,
    "adminManagedRestrictions": boolean,
    "sharingFoldersRequiresOrganizerPermission": boolean
  },
  "orgUnitId": string
}
שדות
id

string

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

name

string

השם של האחסון השיתופי.

colorRgb

string

הצבע של האחסון השיתופי הזה כמחרוזת הקסדצימלית RGB. אפשר להגדיר אותו רק בבקשה מסוג drive.drives.update שלא מגדירה את themeId.

kind

string

פלט בלבד. הערך הזה תמיד הוא drive#drive

capabilities

object

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

capabilities.canAddChildren

boolean

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

capabilities.canComment

boolean

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

capabilities.canCopy

boolean

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

capabilities.canDeleteDrive

boolean

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

capabilities.canDownload

boolean

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

capabilities.canEdit

boolean

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

capabilities.canListChildren

boolean

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

capabilities.canManageMembers

boolean

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

capabilities.canReadRevisions

boolean

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

capabilities.canRename

boolean

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

capabilities.canRenameDrive

boolean

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

capabilities.canChangeDriveBackground

boolean

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

capabilities.canShare

boolean

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

capabilities.canChangeCopyRequiresWriterPermissionRestriction

boolean

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

capabilities.canChangeDomainUsersOnlyRestriction

boolean

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

capabilities.canChangeDriveMembersOnlyRestriction

boolean

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

capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

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

capabilities.canResetDriveRestrictions

boolean

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

capabilities.canDeleteChildren

boolean

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

capabilities.canTrashChildren

boolean

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

themeId

string

המזהה של העיצוב שממנו יוגדרו צבע הרקע ותמונת הרקע. אפשר לאחזר את הקבוצה של driveThemes האפשריים מתשובה של drive.about.get. אם לא מציינים עיצוב בבקשה drive.drives.insert, המערכת בוחרת עיצוב אקראי שממנו מוגדרים צבע הרקע ותמונת הרקע. זהו שדה לכתיבה בלבד. אפשר להגדיר אותו רק בבקשות שלא מוגדרים בהן colorRgb או backgroundImageFile.

backgroundImageFile

object

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

backgroundImageFile.id

string

המזהה של קובץ תמונה ב-Google Drive שישמש כתמונת הרקע.

backgroundImageFile.xCoordinate

number

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

backgroundImageFile.yCoordinate

number

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

backgroundImageFile.width

number

רוחב התמונה החתוכה בטווח הסגור של 0 עד 1. הערך הזה מייצג את רוחב התמונה החתוכה חלקי רוחב התמונה כולה. הגובה מחושב על ידי החלת יחס גובה-רוחב של 80 ל-9. התמונה המתקבלת צריכה להיות ברוחב של 1,280 פיקסלים לפחות ובגובה של 144 פיקסלים לפחות.

createdDate

string

פלט בלבד. השעה שבה נוצר האחסון השיתופי (תאריך ושעה בפורמט RFC 3339).

hidden

boolean

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

restrictions

object

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

restrictions.copyRequiresWriterPermission

boolean

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

restrictions.domainUsersOnly

boolean

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

restrictions.driveMembersOnly

boolean

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

restrictions.adminManagedRestrictions

boolean

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

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

אם הערך הוא true, רק משתמשים עם תפקיד מארגן יכולים לשתף תיקיות. אם הערך הוא false, משתמשים עם תפקיד מארגן או תפקיד מארגן קבצים יכולים לשתף תיקיות.

orgUnitId

string

פלט בלבד. היחידה הארגונית של האחסון השיתופי הזה. השדה הזה מאוכלס בתשובות drives.list רק כשהפרמטר useDomainAdminAccess מוגדר כ-true.

Methods

delete

מחיקת אחסון שיתופי באופן סופי שבו המשתמש הוא organizer.

get

אחזור המטא-נתונים של אחסון שיתופי לפי מזהה.

hide

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

insert

יצירת אחסון שיתופי חדש.

list

רשימה של תיקיות האחסון השיתופי של המשתמש.

unhide

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

update

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