В этом руководстве содержатся задачи, связанные с управлением общими дисками, такие как создание общих дисков и управление участниками и разрешениями с помощью API Google Drive.
Если вы хотите указать поля, возвращаемые в ответе, вы можете задать системный параметр fields с помощью любого метода ресурса drives . Если параметр fields не указан, сервер вернет набор полей по умолчанию, специфичный для данного метода. Например, метод list возвращает только поля kind , id и name для каждого общего диска. Подробнее см. в разделе Возврат определённых полей .
Дополнительную информацию об ограничениях папок на общих дисках см. в разделе Ограничения папок на общих дисках .
Создать общий диск
Чтобы создать общий диск, используйте метод create на ресурсе drives с параметром requestId .
Параметр requestId идентифицирует логическую попытку идемпотентного создания общего диска. Если запрос истёк по тайм-ауту или возвращает неопределённую ошибку бэкенда, тот же запрос можно повторить, не создавая дубликатов. requestId и тело запроса должны оставаться неизменными.
В следующем примере кода показано, как создать общий диск:
Ява
Питон
Node.js
PHP
.СЕТЬ
Вызовы метода create идемпотентны.
Если общий диск был успешно создан в предыдущем запросе или при повторной попытке, метод возвращает экземпляр ресурса drives . Иногда, например, после длительного времени или при изменении текста запроса, может быть возвращена ошибка 409 , указывающая на необходимость удаления requestId .
Получите совместный диск
Чтобы получить метаданные общего диска, используйте метод get ресурса drives с параметром path driveId . Если вы не знаете идентификатор диска, вы можете получить список всех общих дисков с помощью метода list .
Метод get возвращает общий диск как экземпляр ресурса drives .
Чтобы выполнить запрос от имени администратора домена, установите для параметра запроса useDomainAdminAccess значение true . Подробнее см. в статье Управление общими дисками от имени администраторов домена .
Список общих дисков
Чтобы вывести список общих дисков пользователя, используйте метод list ресурса drives . Этот метод возвращает список общих дисков.
Передайте следующие параметры запроса для настройки пагинации или фильтрации общих дисков:
pageSize: максимальное количество общих дисков, возвращаемых на странице.pageToken: токен страницы, полученный при предыдущем вызове списка. Укажите этот токен для получения следующей страницы.q: Строка запроса для поиска общих дисков. Подробнее см. в разделе Поиск общих дисков .useDomainAdminAccess: установите значениеtrue, чтобы выполнить запрос от имени администратора домена и получить все общие диски домена, в котором запрашивающая сторона является администратором. Подробнее см. в разделе Управление общими дисками от имени администраторов домена .
Обновить общий диск
Чтобы обновить метаданные общего диска, используйте метод update ресурса drives с параметром пути driveId .
Метод возвращает общий диск как экземпляр ресурса drives .
Чтобы выполнить запрос от имени администратора домена, установите для параметра запроса useDomainAdminAccess значение true . Подробнее см. в статье Управление общими дисками от имени администраторов домена .
Скрыть и показать общий диск
Чтобы скрыть общий диск из представления по умолчанию, используйте метод hide на ресурсе drives с параметром driveId .
Когда общий диск скрыт, Диск помечает ресурс общего диска как hidden=true . Скрытые общие диски не отображаются в пользовательском интерфейсе Диска или в списке возвращаемых файлов.
Чтобы восстановить вид общего диска по умолчанию, используйте метод unhide на ресурсе drives с параметром driveId .
Оба метода возвращают общий диск как экземпляр ресурса drives .
Удалить общий диск
Чтобы окончательно удалить общий диск, используйте метод delete на ресурсе drives с параметром driveId .
Перед удалением общего диска всё его содержимое необходимо переместить в корзину или удалить. Пользователь также должен иметь role=organizer в папке общего диска. Подробнее см. в разделе Корзина или удаление файлов и папок .
Передайте следующие параметры запроса для фильтрации общих дисков:
useDomainAdminAccess: установите значениеtrue, чтобы выполнить запрос от имени администратора домена и получить все общие диски домена, в котором запрашивающая сторона является администратором. Подробнее см. в разделе Управление общими дисками от имени администраторов домена .allowItemDeletion: установите значениеtrue, чтобы удалить элементы на общем диске. Поддерживается только в том случае, еслиuseDomainAdminAccessтакже установлен вtrue.
Добавить или удалить участников общего диска
Добавляйте или удаляйте участников общего диска с помощью ресурса permissions .
Чтобы добавить участника, создайте разрешение на общем диске. Методы разрешения также можно использовать для отдельных файлов на общем диске, чтобы предоставить участникам дополнительные привилегии или разрешить не участникам совместно работать над определёнными объектами.
Дополнительную информацию и пример кода см. в разделе Общий доступ к файлам, папкам и дискам .
Управляйте общими дисками как администраторы домена
Примените параметр useDomainAdminAccess к ресурсам drives и permissions для управления общими дисками в организации.
Пользователи, вызывающие эти методы с параметром useDomainAdminAccess=true должны иметь права администратора Drive and Docs . Администраторы могут выполнять поиск общих дисков или обновлять разрешения для общих дисков, принадлежащих их организации, независимо от членства администратора в том или ином общем диске.
При использовании сервисных учётных записей вам может потребоваться выдать себя за аутентифицированного администратора, используя функцию олицетворения сервисных учётных записей . Обратите внимание, что сервисные учётные записи, в отличие от учётных записей пользователей, не принадлежат вашему домену Google Workspace. Если вы делитесь ресурсами Google Workspace, такими как документы или события, со всем своим доменом Google Workspace, они не будут доступны сервисным учётным записям. Подробнее см. в разделе Обзор сервисных учётных записей .
Восстановление общего диска, у которого нет органайзера
В следующем примере кода показано, как восстановить общие диски, у которых больше нет организатора.
Ява
Питон
Node.js
PHP
.СЕТЬ
Запретите пользователям загружать, печатать или копировать ваш файл
Вы можете ограничить возможности пользователей по загрузке, печати и копированию файлов на общих дисках.
Чтобы определить, может ли пользователь изменять ограничения загрузки, установленные организатором для общего диска, проверьте логическое поле capabilities.canChangeDownloadRestriction . Если значение capabilities.canChangeDownloadRestriction равно true , ограничения загрузки могут быть применены к общему диску. Подробнее см. в разделе «Общие сведения о возможностях файлов» .
Ресурс drives содержит набор полей с логическими restrictions которые указывают, можно ли выполнить действие на общем диске. Ограничения применяются к общему диску или элементам на нём. Ограничения можно задать с помощью метода drives.update .
Чтобы применить ограничения загрузки к общему диску, менеджер общих дисков может задать поле restrictions.downloadRestriction ресурса drives с помощью объекта DownloadRestriction . Установка логического поля restrictedForReaders в значение true означает, что и загрузка, и копирование ограничены для читателей. Установка логического поля restrictedForWriters в true означает, что и загрузка, и копирование ограничены для писателей. Обратите внимание: если поле restrictedForWriters имеет значение true , загрузка и копирование также ограничены для читателей. Аналогично, установка restrictedForWriters в true и restrictedForReaders в значение false эквивалентна установке обоих restrictedForWriters и restrictedForReaders в true .
Обратная совместимость
С введением объекта DownloadRestriction была обновлена функциональность логического поля restrictions.copyRequiresWriterPermission .
Теперь установка restrictions.copyRequiresWriterPermission в true обновляет логическое поле restrictedForReaders объекта DownloadRestriction до значения true , объявляя, что и загрузка, и копирование ограничены для читателей.
Установка поля copyRequiresWriterPermission в значение false меняет значения полей restrictedForWriters и restrictedForReaders на false . Это означает, что настройки ограничений на загрузку и копирование будут сняты для всех пользователей.
Поля, управляющие функциями загрузки, печати и копирования
В следующей таблице перечислены поля ресурсов drives , которые влияют на функциональность загрузки, печати и копирования:
| Поле | Описание | Версия |
|---|---|---|
capabilities.canCopy | Может ли текущий пользователь копировать файлы на общем диске. | версии 2 и 3 |
capabilities.canDownload | Может ли текущий пользователь загружать файлы на общий диск. | версии 2 и 3 |
capabilities.canChangeCopyRequiresWriterPermission | Может ли текущий пользователь изменить ограничение copyRequiresWriterPermission общего диска. | версии 2 и 3 |
capabilities.canResetDriveRestrictions | Может ли текущий пользователь сбросить ограничения общего диска до значений по умолчанию. | версии 2 и 3 |
capabilities.canChangeDownloadRestriction | Может ли текущий пользователь изменить ограничение загрузки для общего диска. | только v3 |
restrictions.copyRequiresWriterPermission | Отключены ли возможности копирования, печати или загрузки файлов на общем диске для читателей и комментаторов? Если true , то для любого файла на этом общем диске поле с таким же именем устанавливается в значение true . | версии 2 и 3 |
restrictions.downloadRestriction | Ограничения на загрузку, накладываемые менеджерами общих дисков. | только v3 |
Ограничения папок
Папки общего диска имеют определённые ограничения по объёму хранилища. Подробнее см. в статье Ограничения общего диска в Google Диске .
Ограничение по количеству предметов
Общий диск каждого пользователя имеет ограничение в 500 000 элементов, включая файлы, папки и ярлыки.
При достижении лимита общий диск больше не может принимать файлы. Чтобы возобновить приём файлов, пользователи должны безвозвратно удалить элементы с общего диска. Обратите внимание, что элементы в корзине учитываются при подсчёте лимита, а безвозвратно удалённые — нет. Подробнее см. в разделе Корзина или удаление файлов и папок .
Ограничение глубины папки
Папка на общем диске не может содержать более 100 уровней вложенности папок. Это означает, что дочерняя папка не может находиться в папке, глубина вложенности которой превышает 99 уровней. Это ограничение применяется только к дочерним папкам.
Попытка добавить более 100 уровней папок возвращает ответ с кодом состояния HTTP teamDriveHierarchyTooDeep .