REST Resource: permissions

リソース: Permission

ファイルの権限。権限は、ファイルまたはフォルダ階層に対するアクセス権を、ユーザー、グループ、ドメイン、または全世界に付与します。

一部のリソース メソッド（permissions.update など）には permissionId が必要です。permissions.list メソッドを使用して、ファイル、フォルダ、または共有ドライブの ID を取得します。

JSON 表現 
{
  "id": string,
  "name": string,
  "type": string,
  "role": string,
  "additionalRoles": [
    string
  ],
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "expirationDate": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean
}
フィールド
id

string

この権限が参照するユーザーの ID。About リソースと Files リソースの permissionId と同じです。drive.permissions.insert リクエストを行うときは、id フィールドまたは value フィールドのいずれか 1 つのみを指定する必要があります。ただし、権限タイプが anyone の場合、id と value はどちらも無視されます。
name

string

出力専用。この権限の名前。
type

string

アカウントの種類。指定できる値は次のとおりです。

  • user
  • group
  • domain
  • anyone
role

string

このユーザーのメインの役割。将来的には新しい値がサポートされる可能性がありますが、現時点では以下が許可されています。

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
additionalRoles[]

string

このユーザーの追加のロール。現時点では commenter のみ許可されていますが、今後他の言語もサポートされる可能性があります。
authKey
(deprecated)

string

出力専用。サポート終了。
value

string

エンティティのメールアドレスまたはドメイン名。これは挿入時に使用され、レスポンスには入力されません。drive.permissions.insert リクエストを行うときは、id フィールドまたは value フィールドのいずれか 1 つのみを指定する必要があります。ただし、権限タイプが anyone の場合、id と value はどちらも無視されます。
kind

string

出力専用。これは常に drive#permission です。
emailAddress

string

出力専用。この権限が参照するユーザーまたはグループのメールアドレス。権限タイプが user または group の場合に表示される出力専用フィールドです。
domain

string

出力専用。この権限が参照するエンティティのドメイン名。権限タイプが user、group、domain の場合に表示される出力専用フィールドです。
etag

string

出力専用。権限の ETag。
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

出力専用。この権限が継承されているかどうか。このフィールドは常に入力されます。これは出力専用フィールドです。
expirationDate

string

この権限の有効期限（RFC 3339 の日付-時間）。有効期限には次の制限があります。

  • ユーザーとグループの権限に対してのみ設定可能
  • 将来の日付を指定してください
  • 1 年以内の日付は指定できません
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 を使用してください。
deleted

boolean

出力専用。この権限に関連付けられているアカウントが削除されているかどうか。このフィールドは、ユーザーとグループの権限にのみ関係します。
view

string

この権限のビューを示します。ビューに属する権限に対してのみ設定されます。サポートされる値は published のみです。
pendingOwner

boolean

この権限に関連付けられているアカウントが保留中のオーナーであるかどうか。共有ドライブにないファイルに対する user タイプの権限に対してのみ入力されます。

メソッド

delete

 ファイルまたは共有ドライブから権限を削除します。

get

 ID で権限を取得します。

getIdForEmail

 メールアドレスの権限 ID を返します。

insert

 ファイルまたは共有ドライブの権限を挿入します。

list

 ファイルまたは共有ドライブの権限を一覧表示します。

patch

 パッチ セマンティクスを使用して権限を更新します。

update

 権限を更新します。