REST Resource: permissions

資源：權限

檔案的權限。權限可授予使用者、群組、網域或全球使用者對檔案或資料夾階層的存取權。

部分資源方法 (例如 permissions.update) 需要 permissionId。使用 permissions.list 方法擷取檔案、資料夾或共用雲端硬碟的 ID。

JSON 表示法 
{
  "additionalRoles": [
    string
  ],
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "id": string,
  "name": string,
  "type": string,
  "role": string,
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "expirationDate": string,
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
欄位
additionalRoles[]

string

這個使用者的其他角色。目前僅允許 commenter，但日後可能會支援更多格式。
permissionDetails[]

object

僅供輸出。詳細說明此項目的權限是沿用或直接適用於此項目。
permissionDetails[].permissionType

string

僅供輸出。此使用者的權限類型。雖然日後可能會新增值，但目前可用的值如下：

  • file
  • member
permissionDetails[].role

string

僅供輸出。這個使用者的主要角色。雖然日後可能會新增值，但目前可用的值如下：

  • organizer
  • fileOrganizer
  • writer
  • reader
permissionDetails[].additionalRoles[]

string

僅供輸出。這個使用者的其他角色。目前僅支援 commenter，但日後可能會支援更多格式。
permissionDetails[].inheritedFrom

string

僅供輸出。沿用這項權限的項目 ID。只有共用雲端硬碟中的項目會填入這項資料。
permissionDetails[].inherited

boolean

僅供輸出。這項權限是否會沿用。這個欄位一律會填入資料。
teamDrivePermissionDetails[]
(deprecated)

object

僅供輸出。已淘汰：請改用 permissionDetails。
teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

僅供輸出。已淘汰：請改用 permissionDetails/permissionType。
teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

僅供輸出。已淘汰：請改用 permissionDetails/role。
teamDrivePermissionDetails[]
(deprecated).additionalRoles[]
(deprecated)

string

僅供輸出。已淘汰：請改用 permissionDetails/additionalRoles。
teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

僅供輸出。已淘汰：請改用 permissionDetails/inheritedFrom。
teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

僅供輸出。已淘汰：請改用 permissionDetails/inherited。
id

string

此權限所參照的使用者 ID，與「關於」和「檔案」資源中的 permissionId 相同。提出 drive.permissions.insert 要求時，必須指定 id 或 value 欄位，但如果權限類型為 anyone，系統會忽略 id 和 value。
name

string

僅供輸出。這項權限的名稱。
type

string

帳戶類型。允許的值包括：

  • user
  • group
  • domain
  • anyone
role

string

這個使用者的主要角色。雖然日後可能會支援新的值，但目前允許的值如下：

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
authKey
(deprecated)

string

僅供輸出。已淘汰。
value

string

實體的電子郵件地址或網域名稱。這會在插入期間使用，不會在回應中填入。提出 drive.permissions.insert 要求時，必須指定 id 或 value 欄位，但如果權限類型為 anyone，系統會忽略 id 和 value。
kind

string

僅供輸出。這個值一律為 drive#permission。
emailAddress

string

僅供輸出。這個權限參照的使用者或群組電子郵件地址。這是專供輸出的欄位，當權限類型為 user 或 group 時，就會顯示此欄位。
domain

string

僅供輸出。這個權限參照的實體網域名稱。這是專供輸出的欄位，當權限類型為 user、group 或 domain 時，就會顯示此欄位。
etag

string

僅供輸出。權限的 ETag。
expirationDate

string

這項權限到期的時間 (RFC 3339 日期時間)。到期日有下列限制：

  • 只能對使用者和群組權限設定
  • 日期必須是未來的時間
  • 日期不得超過一年
deleted

boolean

僅供輸出。與這項權限相關聯的帳戶是否已刪除。這個欄位僅適用於使用者和群組權限。
view

string

表示此權限的檢視畫面。只有屬於檢視畫面的權限才會填入這項資料。

published

和

metadata

是唯一支援的值。

  • published

    ：權限的角色為 published_reader。

  • metadata

    : 項目只有在權限受限的情況下才會顯示在中繼資料檢視畫面，且範圍至少具有父項的讀取存取權。注意：

    metadata

    目前僅支援資料夾。
pendingOwner

boolean

與此權限相關聯的帳戶是否為待處理的擁有者。只有在共用雲端硬碟中不存在的檔案，才會填入 user 類型權限。
inheritedPermissionsDisabled

boolean

如果為 true，只有活動主辦人、擁有者，以及直接在項目上新增權限的使用者，才能存取該項目。

方法

delete

 刪除檔案或共用雲端硬碟的存取權限。

get

 根據 ID 取得權限。

getIdForEmail

 傳回電子郵件地址的權限 ID。

insert

 插入檔案或共用雲端硬碟的權限。

list

 列出檔案或共用雲端硬碟的權限。

patch

 使用 patch 語義更新權限。

update

 更新權限。