REST Resource: drives

リソース: ドライブ

共有ドライブを表している。

一部のリソース メソッド(drives.update など)には driveId が必要です。共有ドライブの ID を取得するには、drives.list メソッドを使用します。

JSON 表現
{
  "id": string,
  "name": string,
  "colorRgb": string,
  "kind": string,
  "backgroundImageLink": string,
  "capabilities": {
    "canAddChildren": boolean,
    "canComment": boolean,
    "canCopy": boolean,
    "canDeleteDrive": boolean,
    "canDownload": boolean,
    "canEdit": boolean,
    "canListChildren": boolean,
    "canManageMembers": boolean,
    "canReadRevisions": boolean,
    "canRename": boolean,
    "canRenameDrive": boolean,
    "canChangeDriveBackground": boolean,
    "canShare": boolean,
    "canChangeCopyRequiresWriterPermissionRestriction": boolean,
    "canChangeDomainUsersOnlyRestriction": boolean,
    "canChangeDriveMembersOnlyRestriction": boolean,
    "canChangeSharingFoldersRequiresOrganizerPermissionRestriction": boolean,
    "canResetDriveRestrictions": boolean,
    "canDeleteChildren": boolean,
    "canTrashChildren": boolean
  },
  "themeId": string,
  "backgroundImageFile": {
    "id": string,
    "xCoordinate": number,
    "yCoordinate": number,
    "width": number
  },
  "createdDate": string,
  "hidden": boolean,
  "restrictions": {
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean,
    "adminManagedRestrictions": boolean,
    "sharingFoldersRequiresOrganizerPermission": boolean
  },
  "orgUnitId": string
}
フィールド
id

string

出力のみ。この共有ドライブの ID。この共有ドライブの最上位フォルダの ID でもあります。

name

string

この共有ドライブの名前。

colorRgb

string

この共有ドライブの色(RGB 16 進数文字列)。themeId を設定しない drive.drives.update リクエストにのみ設定できます。

kind

string

出力のみ。常に drive#drive です

capabilities

object

出力のみ。現在のユーザーがこの共有ドライブで利用できる機能。

capabilities.canAddChildren

boolean

出力のみ。現在のユーザーが、この共有ドライブ内のフォルダにお子様を追加できるかどうか。

capabilities.canComment

boolean

出力のみ。この共有ドライブ内のファイルに対して現在のユーザーがコメントできるかどうか。

capabilities.canCopy

boolean

出力のみ。現在のユーザーが、この共有ドライブ内のファイルをコピーできるかどうか。

capabilities.canDeleteDrive

boolean

出力のみ。現在のユーザーがこの共有ドライブを削除できるかどうか。共有ドライブ内にゴミ箱内のアイテムがある場合、共有ドライブを削除しようとしても失敗することがあります。

capabilities.canDownload

boolean

出力のみ。現在のユーザーが、この共有ドライブ内のファイルをダウンロードできるかどうか。

capabilities.canEdit

boolean

出力のみ。現在のユーザーが、この共有ドライブ内のファイルを編集できるかどうか

capabilities.canListChildren

boolean

出力のみ。現在のユーザーが、この共有ドライブ内の子フォルダをリストできるかどうか。

capabilities.canManageMembers

boolean

出力のみ。現在のユーザーが、この共有ドライブにメンバーを追加、削除、または役割を変更できるかどうか。

capabilities.canReadRevisions

boolean

出力のみ。現在のユーザーが、この共有ドライブ内にあるファイルの変更履歴を読み取ることができるかどうか。

capabilities.canRename

boolean

出力のみ。現在のユーザーが、この共有ドライブ内のファイルやフォルダの名前を変更できるかどうか。

capabilities.canRenameDrive

boolean

出力のみ。現在のユーザーがこの共有ドライブの名前を変更できるかどうか。

capabilities.canChangeDriveBackground

boolean

出力のみ。現在のユーザーがこの共有ドライブの背景を変更できるかどうか。

capabilities.canShare

boolean

出力のみ。現在のユーザーが、この共有ドライブ内のファイルやフォルダを共有できるかどうか。

capabilities.canChangeCopyRequiresWriterPermissionRestriction

boolean

出力のみ。現在のユーザーが、この共有ドライブの copyRequiresWriterPermission の制限を変更できるかどうか。

capabilities.canChangeDomainUsersOnlyRestriction

boolean

出力のみ。現在のユーザーが、この共有ドライブの domainUsersOnly の制限を変更できるかどうか。

capabilities.canChangeDriveMembersOnlyRestriction

boolean

出力のみ。現在のユーザーが、この共有ドライブの driveMembersOnly の制限を変更できるかどうか。

capabilities.canChangeSharingFoldersRequiresOrganizerPermissionRestriction

boolean

出力のみ。現在のユーザーが、この共有ドライブの sharingFoldersRequiresOrganizerPermission の制限を変更できるかどうか。

capabilities.canResetDriveRestrictions

boolean

出力のみ。現在のユーザーが共有ドライブの制限をデフォルトにリセットできるかどうか。

capabilities.canDeleteChildren

boolean

出力のみ。現在のユーザーが、この共有ドライブ内のフォルダからお子様を削除できるかどうか。

capabilities.canTrashChildren

boolean

出力のみ。現在のユーザーが、この共有ドライブ内のフォルダから子をゴミ箱に移動できるかどうか。

themeId

string

背景画像と色を設定するテーマの ID です。有効な driveThemes のセットは drive.about.get レスポンスから取得できます。drive.drives.insert リクエストで指定されていない場合は、背景画像と色が設定されたランダムなテーマが選択されます。書き込み専用のフィールドです。colorRgb または backgroundImageFile を設定していないリクエストに対してのみ設定できます。

backgroundImageFile

object

この共有ドライブの背景画像を設定する画像ファイルと切り抜きパラメータ。これは書き込み専用フィールドです。themeId を設定していない drive.drives.update リクエストにのみ設定できます。指定する場合は、backgroundImageFile のすべてのフィールドを設定する必要があります。

backgroundImageFile.id

string

背景画像に使用する Google ドライブ内の画像ファイルの ID。

backgroundImageFile.xCoordinate

number

背景画像の切り抜き領域の左上隅の X 座標。これは 0 ~ 1 のクローズド範囲の値です。この値は、画像全体の左側と切り抜き領域の左側からの水平距離を画像全体の幅で割った値です。

backgroundImageFile.yCoordinate

number

背景画像の切り抜き領域の左上にある Y 座標。これは 0 ~ 1 のクローズド範囲の値です。この値は、画像全体の上端から切り抜き領域の上端までの垂直距離を画像全体の高さで割った値です。

backgroundImageFile.width

number

切り抜かれた画像の幅(0 ~ 1 の範囲)。切り抜いた画像の幅を画像全体の幅で割った値です。高さは、幅と高さのアスペクト比(80:9)を適用して計算されます。幅 1,280 ピクセル、高さ 144 ピクセル以上の画像を使用してください。

createdDate

string

出力のみ。共有ドライブが作成された時刻(RFC 3339 の日時)。

hidden

boolean

共有ドライブがデフォルトのビューで非表示になっているかどうか。

restrictions

object

この共有ドライブまたはこの共有ドライブ内のアイテムに適用される制限のセットです。

restrictions.copyRequiresWriterPermission

boolean

この共有ドライブ内のファイルのコピー、印刷、ダウンロードの各オプションを、閲覧者と閲覧者(コメント可)に対して無効にする必要があります。この制限を true に設定すると、この共有ドライブ内のどのファイルも、類似した名前のフィールドよりも true が優先されます。

restrictions.domainUsersOnly

boolean

この共有ドライブと、この共有ドライブ内のアイテムへのアクセス権を、この共有ドライブが属するドメインのユーザーのみに制限するかどうか。この制限は、この共有ドライブの外部で制御される他の共有ポリシーによってオーバーライドされる可能性があります。

restrictions.driveMembersOnly

boolean

この共有ドライブ内のアイテムへのアクセスをメンバーのみに制限するかどうか。

restrictions.adminManagedRestrictions

boolean

制限の変更にこの共有ドライブの管理者権限が必要かどうか。

restrictions.sharingFoldersRequiresOrganizerPermission

boolean

true の場合、主催者のロールを持つユーザーのみがフォルダを共有できます。false の場合、主催者またはファイル主催者の役割を持つユーザーは、フォルダを共有できます。

orgUnitId

string

出力のみ。この共有ドライブの組織部門。このフィールドは、useDomainAdminAccess パラメータが true に設定されている場合にのみ、drives.list レスポンスに入力されます。

Methods

delete

ユーザーが organizer となっている共有ドライブを完全に削除します。

get

ID で共有ドライブのメタデータを取得します。

hide

共有ドライブをデフォルトのビューで非表示にします。

insert

新しい共有ドライブを作成します。

list

ユーザーの共有ドライブを一覧表示します。

unhide

共有ドライブをデフォルトのビューに復元します。

update

共有ドライブのメタデータを更新します。