REST Resource: permissions

リソース: Permission

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

一部のリソース メソッド(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。これは譲受人の一意の識別子であり、permissionId としてユーザー リソースに公開されます。ID は不透明な値として扱う必要があります。

displayName

string

出力のみ。権限の値の「美しい」名前。権限の種類ごとの例を以下に示します。

  • user - Google アカウントに定義されているユーザーの氏名(「Joe Smith」など)。
  • group - Google グループの名前(「会社の管理者」など)。
  • domain - 文字列のドメイン名(thecompany.com など)。
  • anyone - displayName は存在しません。
type

string

譲受人のタイプ。指定できる値は次のとおりです。

  • user
  • group
  • domain
  • anyone

権限を作成する際に、typeuser または group の場合、ユーザーまたはグループの emailAddress を指定する必要があります。typedomain の場合は、domain を指定する必要があります。anyone タイプの場合、追加情報は必要ありません。

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

検索によるファイルの検索を許可するかどうか。これは、domain または anyone タイプの権限にのみ適用されます。

domain

string

この権限によって参照されるドメイン。

expirationTime

string

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

  • ユーザーとグループの権限に対してのみ設定できます。
  • 時刻は将来の日付にする必要があります。
  • 今後 1 年を超える時刻は指定できません。
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 タイプの権限に対してのみ入力されます。

Methods

create

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

delete

権限を削除します。

get

ID で権限を取得します。

list

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

update

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