REST Resource: permissions

リソース: 権限

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

デフォルトでは、権限リクエストはフィールドのサブセットのみを返します。権限の種類、ID、タイプ、ロールは常に返されます。特定のフィールドを取得するには、https://developers.google.com/drive/api/guides/fields-parameter をご覧ください。

一部のリソース メソッド(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 アカウントで定義されているユーザーのフルネーム(例: 「太郎 太郎」)。
  • group - Google グループの名前(例: 「The Company Administrators」)。
  • 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 タイプの権限にのみ入力されます。

メソッド

create

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

delete

権限を削除します。

get

ID で権限を取得します。

list

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

update

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