REST Resource: permissions

リソース: Permission

ファイルに対する権限。権限は、ユーザー、グループ、ドメイン、またはすべてのユーザーにファイルまたはフォルダ階層へのアクセス権を付与します。詳しくは、ファイル、フォルダ、ドライブを共有するをご覧ください。

デフォルトでは、権限リクエストはフィールドのサブセットのみを返します。権限 kind、ID、type、role は常に返されます。特定のフィールドを取得するには、特定のフィールドを返すをご覧ください。

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

JSON 表現 
{
  "permissionDetails": [
    {
      "permissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "id": string,
  "displayName": string,
  "type": string,
  "kind": string,
  "photoLink": string,
  "emailAddress": string,
  "role": string,
  "allowFileDiscovery": boolean,
  "domain": string,
  "expirationTime": string,
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
フィールド
permissionDetails[]

object

出力専用。このアイテムの権限が継承されたものか、このアイテムに直接設定されたものかの詳細。
permissionDetails[].permissionType

string

出力専用。このユーザーの権限タイプ。次の値がサポートされています。

  • file
  • member
permissionDetails[].inheritedFrom

string

出力専用。この権限が継承されるアイテムの ID。共有ドライブ内のアイテムにのみ入力されます。
permissionDetails[].role

string

出力専用。このユーザーのメインのロール。次の値がサポートされています。

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader

詳細については、ロールと権限をご覧ください。
permissionDetails[].inherited

boolean

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

id

string

出力専用。この権限の ID。これは権限付与者の固有の識別子で、ユーザー リソースで permissionId として公開されます。ID は不透明な値として扱われるべきです。
displayName

string

出力専用。権限の値の「略式の」名前。各タイプの権限の例を以下に示します。

  • user - Google アカウントで定義されているユーザーのフルネーム（例: 「Dana A.」）。
  • group - Google グループの名前（「The Company Administrators」など）。
  • domain - 文字列のドメイン名（例: cymbalgroup.com）。
  • anyone - displayName が存在しません。
type

string

権限付与対象のタイプ。次の値がサポートされています。

  • user
  • group
  • domain
  • anyone

権限を作成するときに、type が user または group の場合は、ユーザーまたはグループの emailAddress を指定する必要があります。type が domain の場合は、domain を指定する必要があります。type が anyone の場合、追加情報は必要ありません。
kind

string

出力専用。リソースの種類を示します。値は固定文字列 "drive#permission" です。
emailAddress

string

この権限が参照するユーザーまたはグループのメールアドレス。
role

string

この権限によって付与されるロール。次の値がサポートされています。

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader

詳細については、ロールと権限をご覧ください。
allowFileDiscovery

boolean

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

string

この権限が参照するドメイン。
expirationTime

string

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

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

boolean

出力専用。この権限に関連付けられているアカウントが削除されたかどうか。このフィールドは、user または group タイプの権限にのみ適用されます。
view

string

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

サポートされている値は published と metadata のみです。

  • published: 権限のロールは publishedReader です。
  • metadata: アイテムのアクセスが制限されており、スコープに親に対する読み取りアクセス権があるため、アイテムは metadata ビューでのみ表示されます。metadata ビューはフォルダでのみサポートされています。

詳細については、ビューをご覧ください。
pendingOwner

boolean

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

boolean

true の場合、アイテムに直接権限を追加された主催者、所有者、ユーザーのみがアイテムにアクセスできます。

メソッド

create

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

delete

 権限を削除します。

get

 ID で権限を取得します。

list

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

update

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