REST Resource: permissions

資源:權限

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

根據預設,權限要求只會傳回部分欄位。系統一律會傳回權限類型、ID、類型和角色。如要擷取特定欄位,請參閱 https://developers.google.com/drive/api/guides/fields-parameter。

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

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

string

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

displayName

string

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

  • user - 使用者在 Google 帳戶中定義的全名,例如「Joe Smith」。
  • group:Google 群組名稱,例如「公司管理員」。
  • domain:字串網域名稱,例如「thecompany.com」。
  • anyone:沒有 displayName
type

string

授權對象的類型。有效值如下:

  • user
  • group
  • domain
  • anyone

建立權限時,如果 typeusergroup,您必須為使用者或群組提供 emailAddress。如果 typedomain,您必須提供 domainanyone 類型不需要額外資訊。

kind

string

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

permissionDetails[]

object

僅供輸出。詳細說明共用雲端硬碟項目的權限是沿用自父項,或是直接在該項目上設定。這是專供輸出的欄位,只會顯示共用雲端硬碟項目。

permissionDetails[].permissionType

string

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

  • file
  • member
permissionDetails[].inheritedFrom

string

僅供輸出。繼承這項權限的項目 ID。這是僅供輸出的欄位。

permissionDetails[].role

string

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

  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
permissionDetails[].inherited

boolean

僅供輸出。這項權限是否會繼承。這個欄位一律會填入資料。這是僅供輸出的欄位。

emailAddress

string

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

role

string

這個權限授予的角色。雖然日後可能會支援新的值,但目前允許的值如下:

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

boolean

權限是否允許透過搜尋功能發現檔案。這項設定僅適用於 domainanyone 類型的權限。

domain

string

這個權限參照的網域。

expirationTime

string

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

  • 只能對使用者和群組權限設定。
  • 時間必須是未來的時間。
  • 時間不得超過一年。
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

deleted

boolean

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

view

string

表示此權限的檢視畫面。只有屬於檢視畫面的權限才會填入這項資料。系統僅支援「published」這個值。

pendingOwner

boolean

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

方法

create

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

delete

刪除權限。

get

根據 ID 取得權限。

list

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

update

使用 patch 語意更新權限。