REST Resource: permissions

リソース: 権限

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

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

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

string

このユーザーの追加ロール。現在は commenter のみが許可されていますが、将来的にはさらに多くのものがサポートされる可能性があります。
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

出力専用。この権限が継承されるかどうか。このフィールドには常に値が入力されます。
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 を使用してください。
id

string

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

string

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

string

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

  • user
  • group
  • domain
  • anyone
role

string

このユーザーのメインのロール。今後、新しい値がサポートされる可能性がありますが、現在は次の値が許可されています。

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
authKey
(deprecated)

string

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

string

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

string

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

string

出力専用。この権限が参照するユーザーまたはグループのメールアドレス。これは出力専用フィールドで、権限の種類が user または group の場合に存在します。
domain

string

出力専用。この権限が参照するエンティティのドメイン名。これは出力専用フィールドで、権限の種類が user、group、または domain の場合に存在します。
etag

string

出力専用。権限の ETag。
expirationDate

string

この権限の有効期限が切れる時刻（RFC 3339 日時）。有効期限には次の制限があります。

  • ユーザー権限とグループ権限にのみ設定できます
  • 日付は将来の日付にする必要があります
  • 1 年以上先の日付は指定できません
deleted

boolean

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

string

この権限のビューを示します。ビューに属する権限に対してのみ入力されます。

published

および

metadata

のみがサポートされています。

  • published

    : 権限のロールが published_reader です。

  • metadata

    : アイテムのアクセスが制限されており、スコープに親への読み取りアクセス権が少なくとも付与されているため、このアイテムはメタデータ ビューにのみ表示されます。注:

    metadata

    ビューは現在、フォルダでのみサポートされています。
pendingOwner

boolean

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

boolean

true の場合、アイテムに直接権限が追加されているオーガナイザー、オーナー、ユーザーのみがアイテムにアクセスできます。

メソッド

delete

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

get

 ID で権限を取得します。

getIdForEmail

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

insert

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

list

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

patch

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

update

 権限を更新します。