このページは Cloud Translation API によって翻訳されました。

REST Resource: drives

リソース: Drive
- JSON 表現
メソッド

リソース: 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 }, "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 }

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` です。
`backgroundImageLink`	`string` 出力専用。この共有ドライブの背景画像への有効期間の短いリンク。
`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` レスポンスに入力されます。

メソッド
`delete`	ユーザーが `organizer` である共有ドライブを完全に削除します。
`get`	ID で共有ドライブのメタデータを取得します。
`hide`	共有ドライブをデフォルトビューから非表示にします。
`insert`	新しい共有ドライブを作成します。
`list`	ユーザーの共有ドライブを一覧表示します。
`unhide`	共有ドライブをデフォルトのビューに復元します。
`update`	共有ドライブのメタデータを更新します。

REST Resource: drives

リソース: Drive

メソッド

`delete`

`get`

`hide`

`insert`

`list`

`unhide`

`update`