REST Resource: permissions

資源：Permission

檔案的權限。權限可授予使用者、群組、網域或全球使用者存取檔案或資料夾階層的權限。詳情請參閱「共用檔案、資料夾和雲端硬碟」。

根據預設，權限要求只會傳回部分欄位。系統一律會傳回權限 kind、ID、type 和 role。如要擷取特定欄位，請參閱「傳回特定欄位」。

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

JSON 表示法 
{
  "permissionDetails": [
    {
      "permissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "id": string,
  "displayName": string,
  "type": string,
  "kind": string,
  "photoLink": string,
  "emailAddress": string,
  "role": string,
  "allowFileDiscovery": boolean,
  "domain": string,
  "expirationTime": string,
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
欄位
permissionDetails[]

object

僅供輸出。這項目的權限是沿用還是直接套用。
permissionDetails[].permissionType

string

僅供輸出。這位使用者的權限類型。支援的值包括：

  • file
  • member
permissionDetails[].inheritedFrom

string

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

string

僅供輸出。這位使用者的主要角色。支援的值包括：

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader

詳情請參閱「角色和權限」。
permissionDetails[].inherited

boolean

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

object

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

string

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

string

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

string

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

boolean

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

string

僅供輸出。這項權限的 ID。這是授予對象的專屬 ID，並以 permissionId 形式發布在使用者資源中。ID 應視為不透明值。
displayName

string

僅供輸出。權限值的「可識別」名稱。以下列出每種權限類型的範例：

  • user - 使用者在 Google 帳戶中定義的全名，例如「Dana A.」。
  • group - Google 群組的名稱，例如「公司管理員」。
  • domain：字串網域名稱，例如「cymbalgroup.com」。
  • anyone - No displayName is present.
type

string

受讓人類型。支援的值包括：

  • user
  • group
  • domain
  • anyone

建立權限時，如果 type 為 user 或 group，您必須提供使用者或群組的 emailAddress。如果 type 為 domain，則必須提供 domain。如果 type 為 anyone，則無需提供額外資訊。
kind

string

僅供輸出。表示資源的種類。值：固定字串 "drive#permission"。
emailAddress

string

這個權限參照的使用者或群組的電子郵件地址。
role

string

這個權限授予的角色。支援的值包括：

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader

詳情請參閱「角色和權限」。
allowFileDiscovery

boolean

依權限判定檔案是否可供搜尋。這項設定僅適用於 domain 或 anyone 類型的權限。
domain

string

這個權限參照的網域。
expirationTime

string

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

  • 僅限對使用者和群組權限設定到期時間。
  • 時間必須設在未來。
  • 時間不得超過一年。
deleted

boolean

僅供輸出。與這項權限相關聯的帳戶是否已刪除。這個欄位只與 user 或 group 類型的權限有關。
view

string

指出這項權限的檢視畫面。只有檢視區塊的權限會填入這項資料。

支援的值只有 published 和 metadata：

  • published：權限的角色為 publishedReader。
  • metadata：該項目只能在 metadata 檢視畫面中顯示，因為該項目設有存取限制，且範圍至少具備上層的讀取權限。metadata 檢視畫面僅支援資料夾。

詳情請參閱「檢視畫面」。
pendingOwner

boolean

與這項權限相關聯的帳戶是否為待處理的擁有者。僅適用於非共用雲端硬碟檔案的 user 類型權限。
inheritedPermissionsDisabled

boolean

true：只有主辦人、擁有者和直接在項目中新增權限的使用者可以存取。

方法

create

 為檔案或共用雲端硬碟建立權限。

delete

 刪除權限。

get

 依 ID 取得權限。

list

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

update

 使用 patch 語義更新權限。