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。概要リソースとファイル リソースの permissionId と同じです。drive.permissions.insert リクエストを行う場合は、id フィールドまたは value フィールドのいずれか 1 つのみを指定する必要があります。ただし、権限タイプが anyone の場合は、idvalue の両方が無視されます。

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 の場合は、idvalue の両方が無視されます。

kind

string

出力のみ。これは常に drive#permission です。

emailAddress

string

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

domain

string

出力のみ。この権限が参照するエンティティのドメイン名。これは、権限タイプが usergroup、または 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 タイプの権限に対してのみ入力されます。

Methods

delete

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

get

ID で権限を取得します。

getIdForEmail

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

insert

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

list

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

patch

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

update

権限を更新します。