REST Resource: drives

משאב: Drive

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

ל-methods מסוימות של משאבים (כמו 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
  },
  "createdTime": 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.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. התמונה שמתקבלת חייבת להיות ברוחב של 1280 פיקסלים ובגובה של 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, משתמשים עם התפקיד 'מארגן' או 'מארגן הקבצים' יוכלו לשתף תיקיות.
orgUnitId

string

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

שיטות

create

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

delete

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

get

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

hide

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

list

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

unhide

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

update

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