REST Resource: drives

リソース: ドライブ

共有ドライブを表します。

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

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
  },
  "createdTime": 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.create リクエストで指定しなかった場合、ランダムなテーマが選択され、背景画像と色が設定されます。これは書き込み専用のフィールドです。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 ピクセル以上である必要があります。
createdTime

string

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

boolean

デフォルトのビューで共有ドライブを非表示にするかどうか。
restrictions

object

この共有ドライブまたは共有ドライブ内のアイテムに適用される一連の制限。なお、共有ドライブの作成時に制限を設定することはできません。制限を追加するには、まず共有ドライブを作成してから、drives.update を使用して制限を追加します。
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

create

 共有ドライブを作成する。

delete

 ユーザーが organizer である共有ドライブを完全に削除します。

get

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

hide

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

list

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

unhide

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

update

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