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,
    "canChangeDownloadRestriction": boolean
  },
  "themeId": string,
  "backgroundImageFile": {
    "id": string,
    "xCoordinate": number,
    "yCoordinate": number,
    "width": number
  },
  "createdTime": string,
  "hidden": boolean,
  "restrictions": {
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean,
    "adminManagedRestrictions": boolean,
    "sharingFoldersRequiresOrganizerPermission": boolean,
    "downloadRestriction": {
      object (DownloadRestriction)
    }
  },
  "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

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

capabilities.canChangeDownloadRestriction

boolean

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

themeId

string

המזהה של העיצוב שממנו יוגדרו תמונת הרקע והצבע. אפשר לאחזר את קבוצת הערכים האפשריים של driveThemes מתגובה של drive.about.get. אם לא מציינים עיצוב בבקשה drive.drives.create, נבחר עיצוב אקראי שממנו יוגדרו תמונת הרקע והצבע. זהו שדה לכתיבה בלבד. אפשר להגדיר אותו רק בבקשות שלא מוגדרים בהן 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 פיקסלים לפחות.

createdTime

string

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

hidden

boolean

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

restrictions

object

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

restrictions.copyRequiresWriterPermission

boolean

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

restrictions.domainUsersOnly

boolean

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

restrictions.driveMembersOnly

boolean

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

restrictions.adminManagedRestrictions

boolean

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

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

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

restrictions.downloadRestriction

object (DownloadRestriction)

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

orgUnitId

string

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

Methods

create

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

delete

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

get

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

hide

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

list

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

unhide

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

update

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