REST Resource: permissions

資源:權限

檔案的權限。這項權限可讓使用者、群組、網域或全世界存取檔案或資料夾階層。

部分資源方法 (例如 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 帳戶中使用的全名,例如「王大明」。
  • 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 語意更新權限。