Ресурс: Файл
Метаданные файла.
Для некоторых методов ресурсов (например, files.update
) требуется fileId
. Используйте метод files.list
для получения идентификатора файла.
JSON-представление |
---|
{ "kind": string, "driveId": string, "fileExtension": string, "copyRequiresWriterPermission": boolean, "md5Checksum": string, "contentHints": { "indexableText": string, "thumbnail": { "image": string, "mimeType": string } }, "writersCanShare": boolean, "viewedByMe": boolean, "mimeType": string, "exportLinks": { string: string, ... }, "parents": [ string ], "thumbnailLink": string, "iconLink": string, "shared": boolean, "lastModifyingUser": { object ( |
Поля | |
---|---|
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, загруженный контент, если это возможно, импортируется. Поддерживаемые форматы импорта опубликованы на ресурсе «О программе». |
exportLinks | Только вывод. Ссылки для экспорта файлов редакторов документов в определенные форматы. Объект, содержащий список пар |
parents[] | Идентификатор родительской папки, содержащей файл. У файла может быть только одна родительская папка; указание нескольких родителей не поддерживается. Если это не указано в запросе на создание, файл помещается непосредственно в папку «Мой диск» пользователя. Если не указано в запросе на копирование, файл наследует любого обнаруживаемого родительского элемента исходного файла. Запросы files.update должны использовать параметры |
thumbnailLink | Только вывод. Кратковременная ссылка на миниатюру файла, если она доступна. Обычно длится порядка нескольких часов. Не предназначен для прямого использования в веб-приложениях из-за политик совместного использования ресурсов между источниками (CORS) , рассмотрите возможность использования прокси-сервера. Заполняется только тогда, когда запрашивающее приложение может получить доступ к содержимому файла. Если файл не является общедоступным, URL-адрес, возвращаемый в |
iconLink | Только вывод. Статическая неаутентифицированная ссылка на значок файла. |
shared | Только вывод. Был ли файл опубликован. Не заполняется для объектов на общих дисках. |
lastModifyingUser | Только вывод. Последний пользователь, изменивший файл. Это поле заполняется только в том случае, если последнее изменение было выполнено вошедшим в систему пользователем. |
owners[] | Только вывод. Владелец этого файла. Только некоторые устаревшие файлы могут иметь более одного владельца. Это поле не заполняется для объектов на общих дисках. |
headRevisionId | Только вывод. Идентификатор редакции заголовка файла. В настоящее время это доступно только для файлов с двоичным содержимым на Google Диске. |
sharingUser | Только вывод. Пользователь, который поделился файлом с запрашивающим пользователем, если применимо. |
webViewLink | Только вывод. Ссылка для открытия файла в соответствующем редакторе Google или средстве просмотра в браузере. |
webContentLink | Только вывод. Ссылка для скачивания содержимого файла в браузере. Это доступно только для файлов с двоичным содержимым на Google Диске. |
size | Только вывод. Размер больших двоичных объектов и файлов собственных редакторов в байтах. Не заполняется для файлов без размера, таких как ярлыки и папки. |
viewersCanCopyContent | Устарело: вместо этого используйте |
permissions[] | Только вывод. Полный список разрешений для файла. Это доступно только в том случае, если запрашивающий пользователь может поделиться файлом. Не заполняется для объектов на общих дисках. |
hasThumbnail | Только вывод. Имеет ли этот файл миниатюру. Это не указывает на то, имеет ли запрашивающее приложение доступ к миниатюре. Для проверки доступа обратите внимание на наличие поля «thumbnailLink». |
spaces[] | Только вывод. Список пространств, содержащих файл. В настоящее время поддерживаются значения «диск», «appDataFolder» и «фотографии». |
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 | Только вывод. Полное расширение файла, извлеченное из поля Оно автоматически обновляется при изменении поля |
properties | Коллекция произвольных пар ключ-значение, видимых всем приложениям. Записи с нулевыми значениями удаляются в запросах на обновление и копирование. Объект, содержащий список пар |
appProperties | Коллекция произвольных пар «ключ-значение», которые являются личными для запрашивающего приложения. Записи с нулевыми значениями удаляются в запросах на обновление и копирование. Эти свойства можно получить только с помощью аутентифицированного запроса. Аутентифицированный запрос использует токен доступа, полученный с идентификатором клиента OAuth 2. Вы не можете использовать ключ API для получения частных свойств. Объект, содержащий список пар |
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 | Только вывод. Может ли текущий пользователь изменить поле SecurityUpdateEnabled в метаданных общего ресурса. |
capabilities.canAcceptOwnership | Только вывод. Является ли текущий пользователь предполагаемым владельцем файла. Не заполняется для файлов на общих дисках. |
capabilities.canReadLabels | Только вывод. Может ли текущий пользователь читать метки в файле. |
capabilities.canModifyLabels | Только вывод. Может ли текущий пользователь изменять метки в файле. |
capabilities.canModifyEditorContentRestriction | Только вывод. Может ли текущий пользователь добавлять или изменять ограничения на содержимое файла, доступ к которому ограничен редактором. |
capabilities.canModifyOwnerContentRestriction | Только вывод. Может ли текущий пользователь добавлять или изменять ограничения контента, которые ограничены владельцем. |
capabilities.canRemoveContentRestriction | Только вывод. Существует ли ограничение на содержимое файла, которое может быть удалено текущим пользователем. |
hasAugmentedPermissions | Только вывод. Есть ли разрешения непосредственно на этот файл. Это поле заполняется только для объектов на общих дисках. |
trashingUser | Только вывод. Если файл был явно удален, указывается пользователь, который его удалил. Заполняется только для объектов на общих дисках. |
thumbnailVersion | Только вывод. Версия миниатюры для использования при аннулировании кэша миниатюр. |
trashedTime | Только вывод. Время удаления элемента (дата-время RFC 3339). Заполняется только для объектов на общих дисках. |
modifiedByMe | Только вывод. Был ли файл изменен этим пользователем. |
permissionIds[] | Только вывод. files.list идентификаторов разрешений для пользователей, имеющих доступ к этому файлу. |
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 | Только вывод. Наименьшее число f объектива на фокусном расстоянии, использованном для создания фотографии (значение APEX). |
imageMediaMetadata.subjectDistance | Только вывод. Расстояние до объекта фотографии в метрах. |
imageMediaMetadata.lens | Только вывод. Объектив, использованный для создания фотографии. |
videoMediaMetadata | Только вывод. Дополнительные метаданные о видеоносителях. Это может быть недоступно сразу после загрузки. |
videoMediaMetadata.width | Только вывод. Ширина видео в пикселях. |
videoMediaMetadata.height | Только вывод. Высота видео в пикселях. |
videoMediaMetadata.durationMillis | Только вывод. Длительность видео в миллисекундах. |
shortcutDetails | Сведения о файле ярлыка. Заполняется только для файлов ярлыков, у которых в поле mimeType установлено значение |
shortcutDetails.targetId | Идентификатор файла, на который указывает этот ярлык. Может быть установлен только для запросов |
shortcutDetails.targetMimeType | Только вывод. MIME-тип файла, на который указывает этот ярлык. Значением этого поля является снимок целевого MIME-типа, полученный при создании ярлыка. |
shortcutDetails.targetResourceKey | Только вывод. ResourceKey для целевого файла. |
contentRestrictions[] | Ограничения доступа к содержимому файла. Заполняется только в том случае, если такое ограничение существует. |
resourceKey | Только вывод. Ключ, необходимый для доступа к элементу по общей ссылке. |
linkShareMetadata | Только вывод. LinkShare связанные подробности. Содержит сведения об URL-адресах ссылок, которые клиенты используют для обращения к этому элементу. |
linkShareMetadata.securityUpdateEligible | Только вывод. Имеет ли файл право на обновление безопасности. |
linkShareMetadata.securityUpdateEnabled | Только вывод. Включено ли обновление безопасности для этого файла. |
labelInfo | Только вывод. Обзор меток в файле. |
labelInfo.labels[] | Только вывод. Набор меток в файле, запрошенный идентификаторами меток в параметре |
sha1Checksum | Только вывод. Контрольная сумма SHA1, связанная с этим файлом, если она доступна. Это поле заполняется только для файлов, контент которых хранится на Google Диске; он не заполняется для редакторов документов или файлов ярлыков. |
sha256Checksum | Только вывод. Контрольная сумма SHA256, связанная с этим файлом, если она доступна. Это поле заполняется только для файлов, контент которых хранится на Google Диске; он не заполняется для редакторов документов или файлов ярлыков. |
СодержаниеОграничение
Ограничение доступа к содержимому файла.
JSON-представление |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
Поля | |
---|---|
readOnly | Доступно ли содержимое файла только для чтения. Если файл доступен только для чтения, нельзя добавить новую версию файла, нельзя добавлять или изменять комментарии, а также нельзя изменять заголовок файла. |
reason | Причина, по которой содержимое файла ограничено. Это изменение доступно только для запросов, которые также устанавливают |
type | Только вывод. Тип ограничения контента. В настоящее время единственным возможным значением является |
restrictingUser | Только вывод. Пользователь, установивший ограничение контента. Заполняется только в том случае, если |
restrictionTime | Только вывод. Время, когда было установлено ограничение контента (метка времени в формате RFC 3339). Заполняется только в том случае, если |
ownerRestricted | Может ли ограничение содержимого быть изменено или снято только пользователем, которому принадлежит файл. Для файлов на общих дисках любой пользователь с возможностями |
systemRestricted | Только вывод. Было ли ограничение по содержанию применено системой, например, из-за подписи. Пользователи не могут изменять или удалять ограничения на содержимое, ограниченное системой. |
Методы | |
---|---|
| Создает копию файла и применяет все запрошенные обновления с семантикой исправлений. |
| Создает новый файл. |
| Безвозвратно удаляет файл, принадлежащий пользователю, не перемещая его в корзину. |
| Загружает содержимое файла. |
| Безвозвратно удаляет все удаленные файлы пользователя. |
| Экспортирует документ Google Workspace в запрошенный тип MIME и возвращает экспортированное байтовое содержимое. |
| Генерирует набор идентификаторов файлов, которые могут быть предоставлены в запросах на создание или копирование. |
| Получает метаданные или содержимое файла по идентификатору. |
| Перечисляет файлы пользователя. |
| Перечисляет метки в файле. |
| Изменяет набор меток, примененных к файлу. |
| Обновляет метаданные и/или содержимое файла. |
| Подписывается на изменения в файле. |