REST Resource: drives

Ресурс: Драйв

Представление общего диска.

Для некоторых методов ресурсов (например, drives.update ) требуется driveId . Используйте 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
  },
  "createdTime": string,
  "hidden": boolean,
  "restrictions": {
    "copyRequiresWriterPermission": boolean,
    "domainUsersOnly": boolean,
    "driveMembersOnly": boolean,
    "adminManagedRestrictions": boolean,
    "sharingFoldersRequiresOrganizerPermission": boolean
  },
  "orgUnitId": string
}
Поля
id

string

Только вывод. Идентификатор этого общего диска, который также является идентификатором папки верхнего уровня этого общего диска.

name

string

Имя этого общего диска.

colorRgb

string

Цвет этого общего диска в виде шестнадцатеричной строки RGB. Его можно установить только по запросу drive.drives.update , который не устанавливает themeId .

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

Идентификатор темы, из которой будут установлены фоновое изображение и цвет. Набор возможных driveThemes можно получить из ответа drive.about.get . Если это не указано в запросе drive.drives.create , выбирается случайная тема, из которой задаются фоновое изображение и цвет. Это поле доступно только для записи; его можно установить только для запросов, которые не устанавливают colorRgb или backgroundImageFile .

backgroundImageFile

object

Файл изображения и параметры обрезки, на основе которых задается фоновое изображение для этого общего диска. Это поле доступно только для записи; его можно установить только для запросов drive.drives.update , которые не устанавливают themeId . Если указано, все поля backgroundImageFile должны быть установлены.

backgroundImageFile.id

string

Идентификатор файла изображения на Google Диске, который будет использоваться в качестве фонового изображения.

backgroundImageFile.xCoordinate

number

Координата X верхнего левого угла области обрезки фонового изображения. Это значение находится в закрытом диапазоне от 0 до 1. Это значение представляет собой расстояние по горизонтали от левой стороны всего изображения до левой стороны области обрезки, разделенное на ширину всего изображения.

backgroundImageFile.yCoordinate

number

Координата Y верхнего левого угла области обрезки фонового изображения. Это значение находится в закрытом диапазоне от 0 до 1. Это значение представляет собой расстояние по вертикали от верхней стороны всего изображения до верхней стороны области обрезки, разделенное на высоту всего изображения.

backgroundImageFile.width

number

Ширина обрезанного изображения в закрытом диапазоне от 0 до 1. Это значение представляет собой ширину обрезанного изображения, деленную на ширину всего изображения. Высота вычисляется путем применения соотношения ширины к высоте 80 к 9. Полученное изображение должно быть не менее 1280 пикселей в ширину и 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

Если это правда, только пользователи с ролью организатора могут делиться папками. Если значение равно false, пользователи с ролью организатора или организатора файлов могут совместно использовать папки.

orgUnitId

string

Только вывод. Организационное подразделение этого общего диска. Это поле заполняется только в drives.list , если для параметра useDomainAdminAccess установлено значение true .

Методы

create

Создает общий диск.

delete

Безвозвратно удаляет общий диск, organizer которого является пользователь.

get

Получает метаданные общего диска по идентификатору.

hide

Скрывает общий диск из представления по умолчанию.

list

Перечисляет общие диски пользователя.

unhide

Восстанавливает общий диск к виду по умолчанию.

update

Обновляет метаданные общего диска.