REST Resource: drives

資源：雲端硬碟

共用雲端硬碟的表示法。

部分資源方法 (例如 drives.update) 需要 driveId。請使用 drives.list 方法擷取共用雲端硬碟 ID。

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

僅供輸出。這個共用雲端硬碟的 ID，也是這個共用雲端硬碟的頂層資料夾 ID。
name

string

這個共用雲端硬碟的名稱。
colorRgb

string

這個共用雲端硬碟的顏色，以 RGB 十六進位字串表示。只能針對未設定 themeId 的 drive.drives.update 要求設定。
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

要設定背景圖片和顏色的主題 ID。您可以從 drive.about.get 回應擷取一組可能的 driveThemes。如果 drive.drives.create 要求中未指定，系統會隨機選取主題，做為背景圖片和顏色。這個欄位只能寫入；只能針對未設定 colorRgb 或 backgroundImageFile 的要求進行設定。
backgroundImageFile

object

圖片檔和裁剪參數，也就是設定這個共用雲端硬碟的背景圖片。這個欄位只能寫入；只能針對未設定 themeId 的 drive.drives.update 要求進行設定。如果有指定，就必須設定 backgroundImageFile 的所有欄位。
backgroundImageFile.id

string

Google 雲端硬碟中用於背景圖片的圖片檔 ID。
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

僅供輸出。這個共用雲端硬碟的機構單位。只有在 useDomainAdminAccess 參數設為 true 時，drives.list 回應才會填入這個欄位。

方法

create

 建立共用雲端硬碟。

delete

 永久刪除使用者為「organizer」的共用雲端硬碟。

get

 依 ID 取得共用雲端硬碟中繼資料。

hide

 從預設檢視畫面隱藏共用雲端硬碟。

list

列出使用者的共用雲端硬碟。

unhide

 將共用雲端硬碟還原至預設檢視畫面。

update

 更新共用雲端硬碟的中繼資料。