Ресурс: Файл
Метаданные файла.
Некоторые методы работы с ресурсами (например, files.update ) требуют указания fileId . Используйте метод files.list для получения идентификатора файла.
| JSON-представление |
|---|
{ "exportLinks": { string: string, ... }, "parents": [ string ], "owners": [ { object ( |
| Поля | |
|---|---|
exportLinks | Только вывод. Ссылки для экспорта файлов редактора документов в определенные форматы. Объект, содержащий список пар |
parents[] | Идентификатор родительской папки, содержащей файл. У файла может быть только одна родительская папка; указание нескольких родительских папок не поддерживается. Если это не указано в запросе на создание, файл помещается непосредственно в папку «Мой диск» пользователя. Если это не указано в запросе на копирование, файл наследует любого доступного родительского файла от исходного. Запросы на обновление должны использовать параметры |
owners[] | Только для вывода. Владелец этого файла. Только некоторые устаревшие файлы могут иметь более одного владельца. Это поле не заполняется для элементов на общих дисках. |
permissions[] | Только вывод. Полный список прав доступа к файлу. Эта информация доступна только в том случае, если запрашивающий пользователь имеет право предоставить доступ к файлу. Не заполняется для файлов на общих дисках. |
spaces[] | Только вывод. Список пространств, содержащих файл. В настоящее время поддерживаются значения |
properties | Набор произвольных пар ключ-значение, видимых всем приложениям. Записи с нулевыми значениями удаляются в запросах на обновление и копирование. Объект, содержащий список пар |
appProperties | Набор произвольных пар ключ-значение, являющихся приватными для запрашивающего приложения. Записи с нулевыми значениями удаляются в запросах на обновление и копирование. Эти свойства можно получить только с помощью аутентифицированного запроса. Аутентифицированный запрос использует токен доступа, полученный с помощью идентификатора клиента OAuth 2.0. Вы не можете использовать ключ API для получения закрытых свойств. Объект, содержащий список пар |
permissionIds[] | Только вывод. Список идентификаторов разрешений для пользователей, имеющих доступ к этому файлу. |
contentRestrictions[] | Ограничения на доступ к содержимому файла. Заполняется только при наличии такого ограничения. |
kind | Только вывод. Указывает, к какому типу ресурсов относится данный ресурс. Значение: фиксированная строка |
driveId | Только для вывода. Идентификатор общего диска, на котором находится файл. Заполняется только для элементов, находящихся на общих дисках. |
fileExtension | Только для вывода. Заключительный компонент функции |
copyRequiresWriterPermission | Следует ли отключить для читателей и комментаторов возможность копирования, печати или загрузки этого файла. |
md5Checksum | Только вывод. Контрольная сумма MD5 для содержимого файла. Это применимо только к файлам с бинарным содержимым в Google Диске. |
contentHints | Дополнительная информация о содержимом файла. Эти поля никогда не заполняются в ответах. |
contentHints.indexableText | Текст, подлежащий индексации для файла с целью повышения эффективности полнотекстовых запросов. Длина текста ограничена 128 КБ, и он может содержать элементы HTML. |
contentHints.thumbnail | Миниатюра для файла. Она будет использоваться только в том случае, если Google Drive не сможет сгенерировать стандартную миниатюру. |
contentHints.thumbnail.image | Данные миниатюр закодированы с использованием URL-безопасного Base64 ( раздел 5 RFC 4648 ). Строка, закодированная в формате Base64. |
contentHints.thumbnail.mimeType | MIME-тип миниатюры. |
writersCanShare | Позволяет ли пользователям с правами только |
viewedByMe | Только вывод. Указывает, был ли файл просмотрен этим пользователем. |
mimeType | MIME-тип файла. Если значение не указано, Google Drive пытается автоматически определить подходящее значение в загруженном контенте. Изменить значение можно только после загрузки новой версии. Если файл создан с MIME-типом Google Docs, загруженное содержимое импортируется, если это возможно. Поддерживаемые форматы импорта указаны в разделе |
thumbnailLink | Только вывод. Кратковременная ссылка на миниатюру файла, если она доступна. Обычно действует несколько часов. Не предназначено для прямого использования в веб-приложениях из-за политики CORS (Cross-Origin Resource Sharing) . Рекомендуется использовать прокси-сервер. Заполняется только тогда, когда запрашивающее приложение имеет доступ к содержимому файла. Если файл не является общедоступным, URL-адрес, возвращаемый в |
iconLink | Только для вывода. Статическая, не требующая аутентификации ссылка на значок файла. |
shared | Только для вывода. Указывает, был ли файл предоставлен в общий доступ. Не заполняется для файлов на общих дисках. |
lastModifyingUser | Только для вывода. Последний пользователь, внесший изменения в файл. Это поле заполняется только в том случае, если последнее изменение было выполнено авторизованным пользователем. |
headRevisionId | Только для вывода. Идентификатор заголовочной ревизии файла. В настоящее время эта функция доступна только для файлов с бинарным содержимым в Google Drive. |
sharingUser | Только вывод. Пользователь, предоставивший доступ к файлу запрашивающему пользователю (если применимо). |
webViewLink | Только для вывода. Ссылка для открытия файла в соответствующем редакторе или программе просмотра Google в браузере. |
webContentLink | Только для вывода. Ссылка для загрузки содержимого файла в браузере. Эта функция доступна только для файлов с бинарным содержимым в Google Диск. |
size | Только для вывода. Размер в байтах для больших двоичных объектов и файлов редактора Google Workspace. Не будет заполняться для файлов, размер которых не указан, таких как ярлыки и папки. |
viewersCanCopyContent | Устарело: используйте |
hasThumbnail | Только вывод. Указывает, есть ли у этого файла миниатюра. Это не говорит о том, имеет ли запрашивающее приложение доступ к миниатюре. Чтобы проверить доступ, найдите поле thumbnailLink. |
folderColorRgb | Цвет папки или ярлыка папки в виде шестнадцатеричной строки RGB. Поддерживаемые цвета указаны в поле Если указан неподдерживаемый цвет, вместо него используется ближайший цвет из палитры. |
id | Идентификатор файла. |
name | Имя файла. Оно не обязательно уникально в пределах папки. Обратите внимание, что для неизменяемых элементов, таких как папки верхнего уровня общих дисков, корневая папка «Мой диск» и папка «Данные приложения», имя является постоянным. |
description | Краткое описание файла. |
starred | Указано, отметил ли пользователь файл звездочкой. |
trashed | Файл может быть удален из корзины, либо явно, либо из удаленной родительской папки. Удалить файл может только владелец, но другие пользователи по-прежнему смогут получить к нему доступ, пока он не будет окончательно удален. |
explicitlyTrashed | Только вывод. Указывает, был ли файл удален явно, или же он был удален рекурсивно из родительской папки. |
createdTime | Время создания файла ( RFC 3339 дата-время ). |
modifiedTime | Последнее изменение файла кем-либо ( RFC 3339 дата-время ). Обратите внимание, что установка параметра |
modifiedByMeTime | Только вывод. Время последнего изменения файла пользователем ( RFC 3339 дата-время ). |
viewedByMeTime | Последнее время просмотра файла пользователем ( RFC 3339 дата-время ). |
sharedWithMeTime | Только вывод. Время, когда файл был предоставлен пользователю, если применимо ( RFC 3339 дата-время ). |
quotaBytesUsed | Только вывод. Количество байтов квоты хранения, используемых файлом. Сюда входит как последняя версия, так и предыдущие версии с включенной функцией |
version | Только для вывода. Монотонно возрастающий номер версии файла. Это отражает все изменения, внесенные в файл на сервере, даже те, которые не видны пользователю. |
originalFilename | Исходное имя файла загруженного контента, если оно доступно, или же исходное значение поля |
ownedByMe | Только для вывода. Указывает, является ли файл собственностью пользователя. Не заполняется для файлов на общих дисках. |
fullFileExtension | Output only. The full file extension extracted from the Это поле автоматически обновляется при изменении |
isAppAuthorized | Только вывод. Указывает, был ли файл создан или открыт запрашивающим приложением. |
teamDriveId | Устарело: Только вывод. Используйте |
capabilities | Только для вывода. Возможности, которыми обладает текущий пользователь в отношении этого файла. Каждая возможность соответствует детальному действию, которое может выполнить пользователь. Для получения дополнительной информации см. раздел «Понимание возможностей файла» . |
capabilities.canChangeViewersCanCopyContent | Устарело: Только вывод. |
capabilities.canMoveChildrenOutOfDrive | Только для вывода. Позволяет ли текущий пользователь перемещать дочерние элементы этой папки за пределы общего диска. Значение |
capabilities.canReadDrive | Только для вывода. Указывает, может ли текущий пользователь читать общий диск, к которому принадлежит этот файл. Заполняется только для элементов на общих дисках. |
capabilities.canEdit | Только вывод. Указывает, может ли текущий пользователь редактировать этот файл. Другие факторы могут ограничивать тип изменений, которые пользователь может вносить в файл. Например, см. |
capabilities.canCopy | Только вывод. Может ли текущий пользователь скопировать этот файл. Для элемента на общем диске — может ли текущий пользователь скопировать элементы, не являющиеся папками, или сам этот элемент, если он не является папкой. |
capabilities.canComment | Только вывод. Позволяет ли текущий пользователь оставлять комментарии к этому файлу. |
capabilities.canAddChildren | Только вывод. Указывает, может ли текущий пользователь добавлять дочерние элементы в эту папку. Это значение всегда |
capabilities.canDelete | Только вывод. Указывает, может ли текущий пользователь удалить этот файл. |
capabilities.canDownload | Только вывод. Указывает, может ли текущий пользователь загрузить этот файл. |
capabilities.canListChildren | Только вывод. Указывает, может ли текущий пользователь вывести список дочерних элементов этой папки. Это значение всегда |
capabilities.canRemoveChildren | Только вывод. Указывает, может ли текущий пользователь удалять дочерние элементы из этой папки. Это значение всегда равно |
capabilities.canRename | Только вывод. Позволяет ли текущий пользователь переименовывать этот файл. |
capabilities.canTrash | Только вывод. Указывает, может ли текущий пользователь переместить этот файл в корзину. |
capabilities.canReadRevisions | Только вывод. Может ли текущий пользователь читать ресурс ревизий этого файла. Для элемента общего диска — может ли он читать ревизии потомков этого элемента, не являющихся папками, или самого элемента, если он не является папкой. |
capabilities.canReadTeamDrive | Устарело: Только вывод. Используйте |
capabilities.canMoveTeamDriveItem | Устарело: Только для вывода. Используйте |
capabilities.canChangeCopyRequiresWriterPermission | Только вывод. Указывает, может ли текущий пользователь изменить ограничение |
capabilities.canMoveItemIntoTeamDrive | Устарело: Только для вывода. Используйте |
capabilities.canUntrash | Только вывод. Возможность восстановления этого файла из корзины текущим пользователем. |
capabilities.canModifyContent | Только вывод. Позволяет ли текущий пользователь изменять содержимое этого файла. |
capabilities.canMoveItemWithinTeamDrive | Устарело: Только для вывода. Используйте |
capabilities.canMoveItemOutOfTeamDrive | Устарело: Только для вывода. Используйте |
capabilities.canDeleteChildren | Только для вывода. Позволяет ли текущий пользователь удалять дочерние элементы этой папки. Значение |
capabilities.canMoveChildrenOutOfTeamDrive | Устарело: Только для вывода. Используйте |
capabilities.canMoveChildrenWithinTeamDrive | Устарело: Только для вывода. Используйте |
capabilities.canTrashChildren | Только для вывода. Позволяет ли текущий пользователь удалять дочерние элементы этой папки. Значение |
capabilities.canMoveItemOutOfDrive | Только вывод. Позволяет ли текущий пользователь переместить этот элемент за пределы этого диска, изменив его родительский элемент. Обратите внимание, что запрос на изменение родительского элемента может завершиться неудачей в зависимости от того, какой новый родительский элемент добавляется. |
capabilities.canAddMyDriveParent | Только для вывода. Позволяет ли текущий пользователь добавить родительский элемент, не удаляя существующий родительский элемент в том же запросе. Не заполняется для файлов на общих дисках. |
capabilities.canRemoveMyDriveParent | Только для вывода. Позволяет ли текущий пользователь удалить родительский элемент без добавления другого родительского элемента в том же запросе. Не заполняется для файлов на общих дисках. |
capabilities.canMoveItemWithinDrive | Только вывод. Может ли текущий пользователь перемещать этот элемент в пределах данного диска. Обратите внимание, что запрос на изменение родительского элемента может завершиться неудачей в зависимости от того, какой родительский элемент добавляется и какой удаляется. |
capabilities.canShare | Только вывод. Позволяет ли текущий пользователь изменять параметры доступа к этому файлу. |
capabilities.canMoveChildrenWithinDrive | Только вывод. Указывает, может ли текущий пользователь перемещать дочерние элементы этой папки на этом диске. Это значение равно |
capabilities.canModifyContentRestriction | Устарело: Только для вывода. Используйте один из методов: |
capabilities.canAddFolderFromAnotherDrive | Только для вывода. Позволяет ли текущий пользователь добавлять папку с другого диска (другого общего диска или «Мой диск») в эту папку. Значение |
capabilities.canChangeSecurityUpdateEnabled | Только вывод. Позволяет ли текущий пользователь изменять поле |
capabilities.canAcceptOwnership | Только для вывода. Указывает, является ли текущий пользователь потенциальным владельцем файла. Не заполняется для файлов на общих дисках. |
capabilities.canReadLabels | Только вывод. Позволяет ли текущий пользователь прочитать метки в файле. |
capabilities.canModifyLabels | Только вывод. Позволяет ли текущий пользователь изменять метки в файле. |
capabilities.canModifyEditorContentRestriction | Только для вывода. Позволяет ли текущий пользователь добавлять или изменять ограничения на содержимое файла, доступ к которому ограничен редактором. |
capabilities.canModifyOwnerContentRestriction | Только вывод. Позволяет ли текущий пользователь добавлять или изменять ограничения на контент, установленные владельцем. |
capabilities.canRemoveContentRestriction | Только вывод. Указывает, существует ли ограничение на содержимое файла, которое может быть снято текущим пользователем. |
capabilities.canDisableInheritedPermissions | Возможность отключения унаследованных разрешений пользователем. |
capabilities.canEnableInheritedPermissions | Возможность повторного включения унаследованных разрешений пользователем. |
capabilities.canChangeItemDownloadRestriction | Только для вывода. Позволяет ли текущий пользователь изменять ограничения на скачивание файла, установленные владельцем или организатором. |
hasAugmentedPermissions | Только вывод. Указывает, имеются ли прямые права доступа к этому файлу. Это поле заполняется только для элементов на общих дисках. |
trashingUser | Только для вывода. Если файл был явно удален, указывается пользователь, который его удалил. Заполняется только для элементов на общих дисках. |
thumbnailVersion | Только для вывода. Миниатюрная версия для использования при аннулировании кэша миниатюр. |
trashedTime | Только вывод. Время удаления элемента ( RFC 3339 дата-время ). Заполняется только для элементов на общих дисках. |
modifiedByMe | Только вывод. Указывает, был ли файл изменен этим пользователем. |
imageMediaMetadata | Только для вывода. Дополнительные метаданные о медиафайлах изображений, если таковые имеются. |
imageMediaMetadata.flashUsed | Только вывод. Использовалась ли вспышка при создании фотографии. |
imageMediaMetadata.meteringMode | Только вывод. Режим замера экспозиции, использованный для создания фотографии. |
imageMediaMetadata.sensor | Только выходные данные. Тип датчика, использованного для создания фотографии. |
imageMediaMetadata.exposureMode | Только результат. Режим экспозиции, использованный для создания фотографии. |
imageMediaMetadata.colorSpace | Только вывод. Цветовое пространство фотографии. |
imageMediaMetadata.whiteBalance | Только вывод. Режим баланса белого, использованный для создания фотографии. |
imageMediaMetadata.width | Только для вывода. Ширина изображения в пикселях. |
imageMediaMetadata.height | Только для вывода. Высота изображения в пикселях. |
imageMediaMetadata.location | Только для вывода. Информация о географическом местоположении хранится в изображении. |
imageMediaMetadata.location.latitude | Только для вывода. Широта, хранящаяся в изображении. |
imageMediaMetadata.location.longitude | Только вывод. Долгота, хранящаяся в изображении. |
imageMediaMetadata.location.altitude | Только вывод. Высота сохранена в изображении. |
imageMediaMetadata.rotation | Только для вывода. Количество поворотов на 90 градусов по часовой стрелке, примененных к исходной ориентации изображения. |
imageMediaMetadata.time | Только вывод. Дата и время съемки фотографии (EXIF DateTime). |
imageMediaMetadata.cameraMake | Только выходной сигнал. Марка камеры, использованной для создания фотографии. |
imageMediaMetadata.cameraModel | Только выходные данные. Модель камеры, использованной для создания фотографии. |
imageMediaMetadata.exposureTime | Только вывод. Длительность экспозиции в секундах. |
imageMediaMetadata.aperture | Только выходной сигнал. Диафрагма, использованная для создания фотографии (число f). |
imageMediaMetadata.focalLength | Только для вывода. Фокусное расстояние, использованное для создания фотографии, в миллиметрах. |
imageMediaMetadata.isoSpeed | Только для вывода. Чувствительность ISO, использованная при создании фотографии. |
imageMediaMetadata.exposureBias | Только вывод. Смещение экспозиции фотографии (значение APEX). |
imageMediaMetadata.maxApertureValue | Только для вывода. Наименьшее значение диафрагмы объектива на фокусном расстоянии, использованном для создания фотографии (значение APEX). |
imageMediaMetadata.subjectDistance | Только вывод. Расстояние до объекта съемки, в метрах. |
imageMediaMetadata.lens | Только результат съемки. Объектив, использованный для создания фотографии. |
videoMediaMetadata | Только для вывода. Дополнительные метаданные о видеофайле. Они могут быть недоступны сразу после загрузки. |
videoMediaMetadata.width | Только для вывода. Ширина видео в пикселях. |
videoMediaMetadata.height | Только вывод. Высота видео в пикселях. |
videoMediaMetadata.durationMillis | Только вывод. Длительность видео в миллисекундах. |
shortcutDetails | Сведения о файле ярлыка. Заполняется только для файлов ярлыков, у которых поле mimeType установлено на |
shortcutDetails.targetId | Идентификатор файла, на который указывает этот ярлык. Может быть задан только в запросах |
shortcutDetails.targetMimeType | Только для вывода. MIME-тип файла, на который указывает этот ярлык. Значение этого поля представляет собой снимок MIME-типа целевого файла, полученный при создании ярлыка. |
shortcutDetails.targetResourceKey | Только для вывода. |
resourceKey | Только для вывода. Ключ, необходимый для доступа к элементу по общей ссылке. |
linkShareMetadata | Только вывод. Подробная информация, связанная с LinkShare. Содержит сведения об URL-адресах ссылок, которые клиенты используют для перехода к этому товару. |
linkShareMetadata.securityUpdateEligible | Только вывод. Указывает, подлежит ли файл обновлению безопасности. |
linkShareMetadata.securityUpdateEnabled | Только вывод. Указывает, включено ли обновление безопасности для этого файла. |
labelInfo | Только вывод. Краткий обзор меток в файле. |
labelInfo.labels[] | Только для вывода. Набор меток в файле, запрошенный идентификаторами меток в параметре |
sha1Checksum | Только вывод. Контрольная сумма SHA1, связанная с этим файлом, если она доступна. Это поле заполняется только для файлов, содержимое которых хранится в Google Диск; оно не заполняется для редакторов документов или файлов ярлыков. |
sha256Checksum | Только вывод. Контрольная сумма SHA256, связанная с этим файлом, если она доступна. Это поле заполняется только для файлов, содержимое которых хранится в Google Диск; оно не заполняется для редакторов документов или файлов ярлыков. |
inheritedPermissionsDisabled | Отключено ли наследование прав доступа к этому файлу? Наследование прав доступа включено по умолчанию. |
downloadRestrictions | К файлу применены ограничения на скачивание. |
Ограничение контента
Ограничение на доступ к содержимому файла.
| JSON-представление |
|---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
| Поля | |
|---|---|
readOnly | Указывается, доступно ли содержимое файла только для чтения. Если файл доступен только для чтения, добавление новых версий файла, добавление или изменение комментариев, а также изменение заголовка файла не допускается. |
reason | Причина ограничения доступа к содержимому файла. Это можно изменить только в запросах, в которых также установлен |
type | Только вывод. Тип ограничения контента. В настоящее время единственное возможное значение — |
restrictingUser | Только для вывода. Пользователь, установивший ограничение на доступ к контенту. Заполняется только если |
restrictionTime | Только для вывода. Время, когда было установлено ограничение на содержимое (формат даты и времени RFC 3339 ). Заполняется только если |
ownerRestricted | Ограничение на содержимое может быть изменено или снято только пользователем, являющимся владельцем файла. Для файлов на общих дисках любой пользователь с правами |
systemRestricted | Только вывод. Указывается, было ли ограничение на контент применено системой, например, из-за электронной подписи. Пользователи не могут изменять или удалять системные ограничения на контент. |
DownloadRestrictionsMetadata
К файлу применены ограничения на скачивание.
| JSON-представление |
|---|
{ "itemDownloadRestriction": { object ( |
| Поля | |
|---|---|
itemDownloadRestriction | Ограничение на скачивание файла устанавливается непосредственно владельцем или организатором. При этом не учитываются настройки общего доступа к дискам или правила защиты от утечки данных (DLP). |
effectiveDownloadRestrictionWithContext | Только для вывода. Действующее ограничение на скачивание, примененное к этому файлу. Учитываются все настройки ограничений и правила DLP. |
Ограничение на скачивание
Ограничение на копирование и скачивание файла.
| JSON-представление |
|---|
{ "restrictedForReaders": boolean, "restrictedForWriters": boolean } |
| Поля | |
|---|---|
restrictedForReaders | Ограничения на скачивание и копирование для читателей. |
restrictedForWriters | Ограничено ли скачивание и копирование для писателей? Если |
Методы | |
|---|---|
| Создает копию файла и применяет все запрошенные обновления с использованием семантики патчей. |
| Создает файл. |
| Удаляет файл, принадлежащий пользователю, без перемещения в корзину. |
| Загружает содержимое файла. |
| Удаляет безвозвратно все файлы пользователя из корзины. |
| Экспортирует документ Google Workspace в запрошенный MIME-тип и возвращает экспортированное содержимое в байтах. |
| Генерирует набор идентификаторов файлов, которые можно указывать в запросах на создание или копирование. |
| Получает метаданные или содержимое файла по идентификатору. |
| Отображает список файлов пользователя. |
| Выводит список меток в файле. |
| Изменяет набор меток, применяемых к файлу. |
| Обновляет метаданные, содержимое файла или и то, и другое. |
| Подписывается на изменения файла. |