REST Resource: drives

リソース: Drive

共有ドライブの表現。

一部のリソース メソッド（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,
    "canChangeDownloadRestriction": 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,
    "downloadRestriction": {
      object (DownloadRestriction)
    }
  },
  "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

出力専用。現在のユーザーがこの共有ドライブのフォルダから子アイテムを削除できるかどうか。
capabilities.canChangeDownloadRestriction

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 の場合、主催者ロールまたはファイル主催者ロールを持つユーザーはフォルダを共有できます。
restrictions.downloadRestriction

object (DownloadRestriction)

共有ドライブの管理者が適用したダウンロード制限。
orgUnitId

string

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

メソッド

create

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

delete

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

get

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

hide

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

list

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

unhide

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

update

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