Ресурс: Файл
Метаданные файла.
Некоторые методы ресурсов (например, files.update
) требуют fileId
. Используйте метод files.list
для получения идентификатора файла.
JSON-представление |
---|
{ "exportLinks": { string: string, ... }, "parents": [ string ], "owners": [ { object ( |
Поля | |
---|---|
exportLinks | Только вывод. Ссылки для экспорта файлов Docs Editors в определённые форматы. Объект, содержащий список пар |
parents[] | Идентификатор родительской папки, содержащей файл. Файл может иметь только одну родительскую папку; указание нескольких родительских папок не поддерживается. Если не указано в запросе на создание, файл помещается непосредственно в папку «Мой диск» пользователя. Если не указано в запросе на копирование, файл наследует любой обнаруживаемый родительский элемент исходного файла. Запросы files.update должны использовать параметры |
owners[] | Только выходные данные. Владелец этого файла. Только некоторые устаревшие файлы могут иметь более одного владельца. Это поле не заполняется для объектов на общих дисках. |
permissions[] | Только вывод. Полный список разрешений для файла. Доступно только в том случае, если запрашивающий пользователь может предоставить общий доступ к файлу. Не заполняется для объектов на общих дисках. |
spaces[] | Только вывод. Список пространств, содержащих файл. В настоящее время поддерживаются значения «drive», «appDataFolder» и «photos». |
properties | Коллекция произвольных пар «ключ-значение», которые видны всем приложениям. Записи с нулевыми значениями удаляются в запросах на обновление и копирование. Объект, содержащий список пар |
appProperties | Коллекция произвольных пар «ключ-значение», которые являются конфиденциальными для запрашивающего приложения. Записи с нулевыми значениями удаляются в запросах на обновление и копирование. Эти свойства можно получить только с помощью аутентифицированного запроса. В аутентифицированном запросе используется токен доступа, полученный с помощью идентификатора клиента OAuth 2. Ключ API нельзя использовать для получения приватных свойств. Объект, содержащий список пар |
permissionIds[] | Только вывод. файлы.список идентификаторов разрешений для пользователей, имеющих доступ к этому файлу. |
contentRestrictions[] | Ограничения доступа к содержимому файла. Заполняется только при наличии такого ограничения. |
kind | Только вывод. Определяет тип ресурса. Значение: фиксированная строка |
driveId | Только вывод. Идентификатор общего диска, на котором находится файл. Заполняется только для элементов на общих дисках. |
fileExtension | Только вывод. Последний компонент |
copyRequiresWriterPermission | Следует ли отключить возможность копирования, печати или загрузки этого файла для читателей и комментаторов. |
md5Checksum | Только вывод. Контрольная сумма MD5 для содержимого файла. Применимо только к файлам с двоичным содержимым на Google Диске. |
contentHints | Дополнительная информация о содержимом файла. Эти поля никогда не заполняются в ответах. |
contentHints.indexableText | Текст, индексируемый для файла, для улучшения полнотекстовых запросов. Длина ограничена 128 КБ и может содержать элементы HTML. |
contentHints.thumbnail | Миниатюра файла. Будет использоваться только в том случае, если Google Диск не сможет создать стандартную миниатюру. |
contentHints.thumbnail.image | Данные миниатюры закодированы с помощью безопасного для URL Base64 (RFC 4648, раздел 5). Строка в кодировке base64. |
contentHints.thumbnail.mimeType | Тип MIME миниатюры. |
writersCanShare | Могут ли пользователи, имеющие только право |
viewedByMe | Только вывод. Был ли файл просмотрен этим пользователем. |
mimeType | MIME-тип файла. Если значение не указано, Google Диск автоматически определяет подходящее значение из загруженного контента. Значение нельзя изменить, пока не будет загружена новая версия. Если файл создан с MIME-типом Google Doc, загруженный контент импортируется, если это возможно. Поддерживаемые форматы импорта опубликованы в разделе «О проекте». |
thumbnailLink | Только выходные данные. Краткосрочная ссылка на миниатюру файла, если она доступна. Обычно она существует порядка нескольких часов. Не предназначена для прямого использования в веб-приложениях из-за политик Cross-Origin Resource Sharing (CORS) . Рассмотрите возможность использования прокси-сервера. Заполняется только в том случае, если запрашивающее приложение имеет доступ к содержимому файла. Если файл не находится в публичном доступе, URL-адрес, возвращаемый в |
iconLink | Только вывод. Статическая, неаутентифицированная ссылка на значок файла. |
shared | Только вывод. Был ли файл предоставлен в общий доступ. Не заполняется для объектов на общих дисках. |
lastModifyingUser | Только вывод. Последний пользователь, изменивший файл. Это поле заполняется только в том случае, если последнее изменение было внесено вошедшим в систему пользователем. |
headRevisionId | Только вывод. Идентификатор начальной версии файла. В настоящее время эта функция доступна только для файлов с двоичным содержимым на Google Диске. |
sharingUser | Только вывод. Пользователь, предоставивший файл запрашивающему пользователю (если применимо). |
webViewLink | Только вывод. Ссылка для открытия файла в соответствующем редакторе Google или просмотрщике в браузере. |
webContentLink | Только вывод. Ссылка для загрузки содержимого файла в браузере. Доступно только для файлов с двоичным содержимым на Google Диске. |
size | Только вывод. Размер в байтах для двоичных объектов (BLOB) и файлов редактора собственной разработки. Не заполняется для файлов без размера, таких как ярлыки и папки. |
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 | Только вывод. Полное расширение файла, извлечённое из поля Оно автоматически обновляется при изменении поля |
isAppAuthorized | Только вывод. Был ли файл создан или открыт запрашивающим приложением. |
teamDriveId | Устарело: только вывод. Вместо этого используйте |
capabilities | Только вывод. Возможности текущего пользователя для этого файла. Каждая возможность соответствует детальному действию, которое может выполнить пользователь. |
capabilities.canChangeViewersCanCopyContent | Устаревшее: только вывод. |
capabilities.canMoveChildrenOutOfDrive | Только вывод. Может ли текущий пользователь перемещать дочерние элементы этой папки за пределы общего диска. Значение false, если элемент не является папкой. Заполняется только для элементов на общих дисках. |
capabilities.canReadDrive | Только вывод. Может ли текущий пользователь читать общий диск, к которому принадлежит этот файл. Заполняется только для элементов на общих дисках. |
capabilities.canEdit | Только вывод. Может ли текущий пользователь редактировать этот файл. Другие факторы могут ограничивать типы изменений, которые пользователь может вносить в файл. Например, см. |
capabilities.canCopy | Только вывод. Может ли текущий пользователь копировать этот файл. Для элемента на общем диске: может ли текущий пользователь копировать потомков этого элемента, не являющихся папками, или сам элемент, если он не является папкой. |
capabilities.canComment | Только вывод. Может ли текущий пользователь комментировать этот файл. |
capabilities.canAddChildren | Только вывод. Может ли текущий пользователь добавлять дочерние элементы в эту папку. Всегда имеет значение false, если элемент не является папкой. |
capabilities.canDelete | Только вывод. Может ли текущий пользователь удалить этот файл. |
capabilities.canDownload | Только вывод. Может ли текущий пользователь загрузить этот файл. |
capabilities.canListChildren | Только вывод. Может ли текущий пользователь вывести список дочерних элементов этой папки. Всегда имеет значение false, если элемент не является папкой. |
capabilities.canRemoveChildren | Только вывод. Может ли текущий пользователь удалять дочерние элементы из этой папки. Значение всегда равно false, если элемент не является папкой. Для папки на общем диске используйте |
capabilities.canRename | Только вывод. Может ли текущий пользователь переименовать этот файл. |
capabilities.canTrash | Только вывод. Может ли текущий пользователь переместить этот файл в корзину. |
capabilities.canReadRevisions | Только вывод. Может ли текущий пользователь читать ресурс версий этого файла. Для элемента общего диска — можно ли читать версии потомков этого элемента, не являющихся папками, или сам этот элемент, если он не является папкой. |
capabilities.canReadTeamDrive | Устарело: только вывод. Вместо этого используйте |
capabilities.canMoveTeamDriveItem | Устарело: только вывод. Вместо этого используйте |
capabilities.canChangeCopyRequiresWriterPermission | Только вывод. Может ли текущий пользователь изменить ограничение |
capabilities.canMoveItemIntoTeamDrive | Устарело: только вывод. Вместо этого используйте |
capabilities.canUntrash | Только вывод. Может ли текущий пользователь восстановить этот файл из корзины. |
capabilities.canModifyContent | Только вывод. Может ли текущий пользователь изменять содержимое этого файла. |
capabilities.canMoveItemWithinTeamDrive | Устарело: только вывод. Вместо этого используйте |
capabilities.canMoveItemOutOfTeamDrive | Устарело: только вывод. Вместо этого используйте |
capabilities.canDeleteChildren | Только вывод. Может ли текущий пользователь удалять дочерние элементы этой папки. Значение false, если элемент не является папкой. Заполняется только для элементов на общих дисках. |
capabilities.canMoveChildrenOutOfTeamDrive | Устарело: только вывод. Вместо этого используйте |
capabilities.canMoveChildrenWithinTeamDrive | Устарело: только вывод. Вместо этого используйте |
capabilities.canTrashChildren | Только вывод. Может ли текущий пользователь удалять дочерние элементы этой папки. Значение false, если элемент не является папкой. Заполняется только для элементов на общих дисках. |
capabilities.canMoveItemOutOfDrive | Только вывод. Может ли текущий пользователь переместить этот элемент за пределы этого диска, изменив его родительский элемент. Обратите внимание, что запрос на изменение родительского элемента может по-прежнему завершаться ошибкой в зависимости от добавляемого нового родительского элемента. |
capabilities.canAddMyDriveParent | Только вывод. Может ли текущий пользователь добавить родительский элемент для элемента, не удаляя существующий родительский элемент в том же запросе. Не заполняется для файлов на общем диске. |
capabilities.canRemoveMyDriveParent | Только вывод. Может ли текущий пользователь удалить родительский элемент из элемента, не добавляя другой родительский элемент в том же запросе. Не заполняется для файлов на общем диске. |
capabilities.canMoveItemWithinDrive | Только вывод. Может ли текущий пользователь перемещать этот элемент в пределах этого диска. Обратите внимание, что запрос на изменение родительского элемента может по-прежнему завершаться ошибкой в зависимости от добавляемого и удаляемого родительского элемента. |
capabilities.canShare | Только вывод. Может ли текущий пользователь изменять настройки общего доступа к этому файлу. |
capabilities.canMoveChildrenWithinDrive | Только вывод. Может ли текущий пользователь перемещать дочерние элементы этой папки в пределах этого диска. Значение false, если элемент не является папкой. Обратите внимание, что запрос на перемещение дочернего элемента может по-прежнему завершаться ошибкой в зависимости от уровня доступа текущего пользователя к дочернему элементу и к целевой папке. |
capabilities.canModifyContentRestriction | Устарело: только вывод. Используйте один из методов |
capabilities.canAddFolderFromAnotherDrive | Только вывод. Может ли текущий пользователь добавлять папку с другого диска (другого общего диска или из раздела «Мой диск») в эту папку. Значение false, если элемент не является папкой. Заполняется только для элементов на общих дисках. |
capabilities.canChangeSecurityUpdateEnabled | Только вывод. Может ли текущий пользователь изменять поле securityUpdateEnabled в метаданных ссылки общего доступа. |
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 для целевого файла. |
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 | Только вывод. Было ли ограничение контента применено системой, например, из-за электронной подписи. Пользователи не могут изменять или удалять системные ограничения контента. |
ЗагрузкаОграниченияМетаданные
К файлу применены ограничения на загрузку.
JSON-представление |
---|
{ "itemDownloadRestriction": { object ( |
Поля | |
---|---|
itemDownloadRestriction | Ограничение на загрузку файла, наложенное непосредственно владельцем или организатором. Оно не учитывает настройки общего диска или правила DLP. |
effectiveDownloadRestrictionWithContext | Только вывод. Действующее ограничение на загрузку, применяемое к этому файлу. Учитываются все настройки ограничений и правила DLP. |
Ограничение загрузки
Ограничение на копирование и скачивание файла.
JSON-представление |
---|
{ "restrictedForReaders": boolean, "restrictedForWriters": boolean } |
Поля | |
---|---|
restrictedForReaders | Ограничено ли скачивание и копирование для читателей. |
restrictedForWriters | Ограничено ли скачивание и копирование для писателей. Если да, скачивание также ограничено для читателей. |
Методы | |
---|---|
| Создает копию файла и применяет все запрошенные обновления с семантикой исправлений. |
| Создает новый файл. |
| Навсегда удаляет файл, принадлежащий пользователю, не перемещая его в корзину. |
| Загружает содержимое файла. |
| Навсегда удаляет все удаленные пользователем файлы. |
| Экспортирует документ Google Workspace в запрошенный тип MIME и возвращает экспортированное байтовое содержимое. |
| Генерирует набор идентификаторов файлов, которые могут быть предоставлены в запросах на создание или копирование. |
| Получает метаданные или содержимое файла по идентификатору. |
| Список файлов пользователя. |
| Выводит список меток файла. |
| Изменяет набор меток, примененных к файлу. |
| Обновляет метаданные и/или содержимое файла. |
| Подписывается на изменения в файле. |