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. התמונה שתתקבל חייבת להיות ברוחב של 1280 פיקסלים ובגובה של 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.

שיטות

delete

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

get

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

hide

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

insert

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

list

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

unhide

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

update

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