Каждый файл, папка и общий диск Google Drive имеют связанные с ними ресурсы permissions . Каждый ресурс определяет разрешение для определенного type ( user , group , domain , anyone ) и role ( owner , organizer , организатор fileOrganizer , writer , commenter , reader ). Например, файл может иметь разрешение, предоставляющее определенному пользователю ( type=user ) доступ только для чтения ( role=reader ), в то время как другое разрешение предоставляет членам определенной группы ( type=group ) возможность добавлять комментарии к файлу ( role=commenter ).
Полный список ролей и разрешенных для каждой из них операций см. в разделе «Роли и разрешения» .
Как работают разрешения
Списки разрешений для папки распространяются вниз. Все дочерние файлы и папки наследуют разрешения от родительской папки. При каждом изменении разрешений или иерархии распространение происходит рекурсивно по всем вложенным папкам. Например, если файл существует в папке, а затем эта папка перемещается в другую папку, разрешения новой папки распространяются на файл. Если новая папка предоставляет пользователю файла новую роль, например, «писатель», она переопределяет его старую роль.
И наоборот, если файл наследует role=writer от папки и перемещается в другую папку, которая предоставляет роль "reader", то теперь файл наследует role=reader .
Унаследованные разрешения нельзя удалить или уменьшить для какого-либо элемента. Вместо этого эти разрешения необходимо скорректировать в родительском элементе, откуда они берутся, или же в папке в иерархии должна быть включена настройка ограниченного доступа .
Унаследованные права доступа можно увеличить для элемента. Если права доступа увеличиваются для дочернего элемента, изменение прав доступа родителя не влияет на права доступа дочернего элемента, если только права доступа нового родителя не превышают права доступа дочернего элемента.
Одновременные операции с правами доступа к одному и тому же файлу не поддерживаются. Применяется только последнее обновление.
Понимание возможностей файлов
Ресурс permissions в конечном итоге не определяет возможности текущего пользователя выполнять действия с файлом или папкой. Вместо этого ресурс files содержит набор логических полей capabilities , используемых для указания того, можно ли выполнить действие с файлом или папкой. API Google Drive устанавливает эти поля на основе ресурса permissions текущего пользователя, связанного с файлом или папкой.
Например, когда Алекс входит в ваше приложение и пытается поделиться файлом, проверяется наличие у Алекса прав доступа к файлу в соответствии с его ролью. Если роль позволяет ему делиться файлом, то capabilities , связанные с файлом, такие как canShare , устанавливаются относительно роли. Если Алекс хочет поделиться файлом, ваше приложение проверяет capabilities , чтобы убедиться, что canShare установлен в true .
Получить возможности файла
Когда ваше приложение открывает файл, оно должно проверить права доступа к файлу и отобразить пользовательский интерфейс в соответствии с разрешениями текущего пользователя. Например, если у пользователя нет права canComment к файлу, возможность комментирования должна быть отключена в пользовательском интерфейсе.
Чтобы проверить возможности, вызовите метод get ресурса files с параметром `path` fileId и параметром fields , установленным на поле capabilities . Дополнительную информацию о возврате полей с помощью параметра ` fields см. в разделе «Возврат определенных полей» .
Приведённый ниже пример кода демонстрирует проверку прав пользователя. В ответ возвращается список возможностей, которыми пользователь обладает при работе с файлом. Каждая возможность соответствует детальному действию, которое может выполнить пользователь. Некоторые поля заполняются только для элементов на общих дисках.
Запрос
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=capabilitiesОтвет
{ "capabilities": { "canAcceptOwnership": false, "canAddChildren": false, "canAddMyDriveParent": false, "canChangeCopyRequiresWriterPermission": true, "canChangeItemDownloadRestriction": true, "canChangeSecurityUpdateEnabled": false, "canChangeViewersCanCopyContent": true, "canComment": true, "canCopy": true, "canDelete": true, "canDisableInheritedPermissions": false, "canDownload": true, "canEdit": true, "canEnableInheritedPermissions": true, "canListChildren": false, "canModifyContent": true, "canModifyContentRestriction": true, "canModifyEditorContentRestriction": true, "canModifyOwnerContentRestriction": true, "canModifyLabels": true, "canMoveChildrenWithinDrive": false, "canMoveItemIntoTeamDrive": true, "canMoveItemOutOfDrive": true, "canMoveItemWithinDrive": true, "canReadLabels": true, "canReadRevisions": true, "canRemoveChildren": false, "canRemoveContentRestriction": false, "canRemoveMyDriveParent": true, "canRename": true, "canShare": true, "canTrash": true, "canUntrash": true } }
Сценарии совместного использования ресурсов Диска
Существует пять различных типов сценариев совместного использования:
Для предоставления общего доступа к файлу в разделе «Мой диск» пользователь должен иметь
role=writerилиrole=owner.Если для файла логическое значение
writersCanShareустановлено наfalse, значит, у пользователя должна бытьrole=owner).Если пользователь с
role=writerимеет временный доступ, ограниченный датой и временем истечения срока действия, он не может поделиться файлом. Дополнительную информацию см. в разделе «Установка даты истечения срока действия для ограничения доступа к элементам» .
Для предоставления общего доступа к папке в разделе «Мой диск» пользователь должен иметь
role=writerилиrole=owner.Если для файла логическое значение
writersCanShareустановлено наfalse, то пользователь должен иметь более разрешительнуюrole=owner.Временный доступ (с указанием даты и времени истечения срока действия) разрешен только для папок с
role=reader. Дополнительную информацию см. в разделе «Установка даты истечения срока действия для ограничения доступа к элементам» .
Для предоставления общего доступа к файлу на общем диске пользователь должен иметь
role=writer,role=fileOrganizerилиrole=organizer.- Параметр
writersCanShareне применяется к элементам на общих дисках. Он рассматривается как всегда имеющий значениеtrue.
- Параметр
Для предоставления общего доступа к папке на общем диске пользователь должен иметь
role=organizer.- Если для параметра
sharingFoldersRequiresOrganizerPermissionна общем диске установлено значениеfalse, пользователи сrole=fileOrganizerсмогут предоставлять общий доступ к папкам на этом общем диске.
- Если для параметра
Для управления членством в общих дисках пользователь должен иметь
role=organizer. Членами общих дисков могут быть только пользователи и группы.
Используйте параметр fields.
Если вы хотите указать поля, которые должны быть возвращены в ответе, вы можете задать системный параметр fields с помощью любого метода ресурса permissions . Если вы опустите параметр fields , сервер вернет набор полей по умолчанию, специфичных для данного метода. Например, метод list возвращает только поля id , type , kind и role для каждого файла. Чтобы вернуть другие поля, см. раздел «Возврат определенных полей» .
Создайте разрешение
При создании разрешения необходимо заполнить следующие два поля:
type:typeопределяет область действия разрешений (user,group,domainилиanyone). Разрешение сtype=userприменяется к конкретному пользователю, тогда как разрешение сtype=domainприменяется ко всем пользователям в конкретном домене.role: Полеroleопределяет операции, которые может выполнять данныйtype. Например, разрешение сtype=userиrole=readerпредоставляет конкретному пользователю доступ только для чтения к файлу или папке. Или разрешение сtype=domainиrole=commenterпозволяет всем пользователям домена добавлять комментарии к файлу. Полный список ролей и разрешенных для каждой из них операций см. в разделе «Роли и разрешения» .
При создании разрешения с type=user или type=group необходимо также указать emailAddress , чтобы связать конкретного пользователя или группу с этим разрешением.
При создании разрешения с type=domain необходимо также указать domain , чтобы связать конкретное доменное имя с этим разрешением.
Для создания разрешения:
- Используйте метод
createдля ресурсаpermissions, передав в качестве параметра путиfileIdсоответствующий файл или папку. - В теле запроса укажите
typeиrole. - Если
type=userилиtype=group, укажитеemailAddress. Еслиtype=domain, укажитеdomain.
Приведённый ниже пример кода демонстрирует, как создать разрешение. В ответ возвращается экземпляр ресурса permissions , включая присвоенный permissionId ).
Запрос
POST https://www.googleapis.com/drive/v3/files/FILE_ID/permissions{ "requests": [ { "type": "user", "role": "commenter", "emailAddress": "alex@altostrat.com" } ] }
Ответ
{
"kind": "drive#permission",
"id": "PERMISSION_ID",
"type": "user",
"role": "commenter"
}Используйте целевую аудиторию
Целевые аудитории — это группы людей, например, отделы или команды, которым вы можете рекомендовать пользователям делиться своими материалами. Вы можете поощрять пользователей делиться материалами с более конкретной или ограниченной аудиторией, а не со всей организацией. Целевые аудитории могут помочь вам повысить безопасность и конфиденциальность ваших данных, а также упростить для пользователей возможность надлежащего обмена информацией. Для получения дополнительной информации см. раздел «О целевых аудиториях» .
Для использования целевой аудитории:
В консоли администратора Google перейдите в > Каталог > Целевые аудитории .
Для выполнения этой задачи необходимо войти в систему, используя учетную запись с правами суперадминистратора .
В списке «Целевые аудитории» щелкните название целевой аудитории. Чтобы создать целевую аудиторию, см. раздел «Создание целевой аудитории».
Скопируйте уникальный идентификатор из URL-адреса целевой аудитории:
https://admin.google.com/ac/targetaudiences/ ID.Создайте разрешение с
type=domainи установите полеdomainвID .audience.googledomains.com.
Чтобы узнать, как пользователи взаимодействуют с целевой аудиторией, см. раздел «Пользовательский опыт при обмене ссылками» .
Получите разрешение
Чтобы получить разрешение, используйте метод get ресурса permissions с параметрами ` fileId и permissionId в качестве пути. Если идентификатор разрешения неизвестен, вы можете вывести список всех разрешений с помощью метода list .
Приведённый ниже пример кода демонстрирует, как получить разрешение по идентификатору. В ответе возвращается экземпляр ресурса permissions .
Запрос
GET https://www.googleapis.com/drive/v3/files/FILE_ID/permissionsPERMISSION_ID
Ответ
{
"kind": "drive#permissionList",
"permissions": [
{
"kind": "drive#permission",
"id": "PERMISSION_ID",
"type": "user",
"role": "commenter"
}
]
}Перечислите все разрешения.
Чтобы вывести список разрешений для файла, папки или общего диска, используйте метод ` list ресурса permissions с параметром fileId path`.
Передайте следующие параметры запроса , чтобы настроить пагинацию или фильтрацию разрешений:
pageSize: Максимальное количество разрешений, возвращаемых на странице. Если не задано для файлов на общем диске, возвращается не более 100 результатов. Если не задано для файлов, не находящихся на общем диске, возвращается весь список.pageToken: Токен страницы, полученный из предыдущего вызова списка. Предоставьте этот токен для получения следующей страницы.supportsAllDrives: Указывает, поддерживает ли запрашивающее приложение одновременно «Мои диски» и «Общие диски».useDomainAdminAccess: Установите значениеtrue, чтобы отправить запрос от имени администратора домена. Если параметрfileIdотносится к общему диску, а запрашивающий является администратором домена, к которому принадлежит общий диск. Для получения дополнительной информации см. раздел «Управление общими дисками от имени администраторов домена» .includePermissionsForView: Разрешения дополнительного представления, которые будут включены в ответ. Поддерживается толькоpublished.
Приведённый ниже пример кода показывает, как получить все права доступа. В ответе возвращается список прав доступа для файла, папки или общего диска.
Запрос
GET https://www.googleapis.com/drive/v3/files/FILE_ID/permissionsОтвет
{
"kind": "drive#permissionList",
"permissions": [
{
"id": "PERMISSION_ID",
"type": "user",
"kind": "drive#permission",
"role": "commenter"
}
]
}Обновить права доступа
Чтобы изменить права доступа к файлу или папке, можно изменить назначенную роль. Дополнительную информацию о том, как определить источник роли, см. в разделе «Определение источника роли» .
Вызовите метод
updateресурсаpermissions, указав в параметреfileIdpath` путь к связанному файлу, папке или общему диску, а в параметреpermissionIdpath` — разрешение на изменение. Чтобы найти `permissionId, используйте методlistресурсаpermissionsс параметром `fileIdpath`.В запросе укажите новую
role.
Вы можете предоставлять разрешения на отдельные файлы или папки на общем диске, даже если пользователь или группа уже являются его членами. Например, у Алекса есть role=commenter в рамках его членства на общем диске. Однако ваше приложение может предоставить Алексу role=writer для файла на общем диске. В этом случае, поскольку новая роль более разрешительная, чем роль, предоставленная в рамках его членства, новое разрешение становится фактической ролью для файла или папки.
Вы можете применять обновления с помощью семантики патчей, то есть вносить частичные изменения в ресурс. Необходимо явно указать поля, которые вы собираетесь изменить, в вашем запросе. Любые поля, не включенные в запрос, сохраняют свои существующие значения. Для получения дополнительной информации см. раздел «Работа с частично измененными ресурсами» .
Приведённый ниже пример кода демонстрирует, как изменить права доступа к файлу или папке с commenter на writer . В ответ возвращается экземпляр ресурса permissions .
Запрос
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID/permissions/PERMISSION_ID
{
"role": "writer"
}Ответ
{
"kind": "drive#permission",
"id": "PERMISSION_ID",
"type": "user",
"role": "writer"
}Определите источник роли
Чтобы изменить роль файла или папки, необходимо знать источник этой роли. Для общих дисков источником роли может быть членство в общем диске, роль папки или роль файла.
Чтобы определить источник ролей для общего диска или элементов на этом диске, вызовите метод get ресурса permissions с параметрами fileId и permissionId , а параметр ` fields установите равным полю permissionDetails .
Чтобы найти permissionId , используйте метод list ресурса permissions с параметром fileId path. Чтобы получить поле permissionDetails в запросе list , установите параметр fields в значение permissions/permissionDetails .
В этом поле перечислены все унаследованные и прямые права доступа к файлам для пользователя, группы или домена.
Приведенный ниже пример кода показывает, как определить источник роли. В ответ возвращается permissionDetails permissions ресурса. Поле inheritedFrom содержит идентификатор элемента, от которого наследуется разрешение.
Запрос
GET https://www.googleapis.com/drive/v3/files/FILE_ID/permissions/PERMISSION_ID?fields=permissionDetails&supportsAllDrives=true
Ответ
{
"permissionDetails": [
{
"permissionType": "member",
"role": "commenter",
"inheritedFrom": "INHERITED_FROM_ID",
"inherited": true
},
{
"permissionType": "file",
"role": "writer",
"inherited": false
}
]
}Обновление нескольких разрешений с помощью пакетных запросов
Мы настоятельно рекомендуем использовать пакетные запросы для изменения нескольких разрешений.
Ниже приведён пример пакетного изменения прав доступа к клиентской библиотеке.
Java
Python
Node.js
PHP
.СЕТЬ
Удалить разрешение
Чтобы отозвать доступ к файлу или папке, вызовите метод delete ресурса permissions , указав в качестве параметров fileId и permissionId path, чтобы удалить разрешение.
Унаследованные разрешения нельзя отозвать. Вместо этого обновите или удалите разрешения для родительского файла или папки. Удаление разрешения для папки отзывает доступ к этому элементу и дочерним элементам, если таковые имеются.
Для ограничения прав доступа по сравнению с родительским доступом необходимо использовать настройку ограниченного доступа .
Приведенный ниже пример кода показывает, как отозвать доступ, удалив permissionId . В случае успеха тело ответа будет представлять собой пустой JSON-объект. Чтобы подтвердить удаление разрешения, используйте метод list ресурса permissions с параметром fileId path.
Запрос
DELETE https://www.googleapis.com/drive/v3/files/FILE_ID/permissions/PERMISSION_ID
Установите срок действия, чтобы ограничить доступ к товару.
При работе над конфиденциальным проектом может возникнуть необходимость ограничить доступ к определенным элементам в Google Диска по истечении определенного периода времени. Для файлов и папок можно установить дату истечения срока действия, чтобы ограничить или запретить доступ к этому элементу.
Чтобы установить срок действия:
Используйте метод
createдля ресурсаpermissionsи задайте полеexpirationTime(а также другие обязательные поля). Для получения дополнительной информации см. раздел «Создание разрешения» .Используйте метод
updateдля ресурсаpermissionsи установите полеexpirationTime(вместе с другими обязательными полями). Для получения дополнительной информации см. раздел «Обновление разрешений» .
Поле expirationTime указывает, когда истекает срок действия разрешения, используя формат даты и времени RFC 3339. Время истечения срока действия имеет следующие ограничения:
- Их можно установить только для прав доступа пользователей и групп.
- Время должно быть в будущем.
- Этот период не может быть отложен более чем на один год.
- Только
readerимеет право на временное ограничение доступа к папке.
Для получения более подробной информации о сроке годности см. следующие статьи:
Связанные темы
- Управление ожидающими рассмотрения предложениями о доступе
- Управляйте папками с ограниченным и расширенным доступом.
- Передача прав собственности на файл.
- Защитить содержимое файла
- Доступ к файлам на общем диске осуществляется с помощью ключей ресурсов.
- Роли и права доступа