Ресурс: Файл
Метаданные для файла.
Для некоторых методов ресурсов (таких как 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 | Только вывод. Кратковременная ссылка на миниатюру файла, если она доступна. Обычно длится порядка часов. Заполняется только в том случае, если запрашивающее приложение может получить доступ к содержимому файла. Если файл не является общедоступным, URL-адрес, возвращенный в |
iconLink | Только вывод. Статическая неаутентифицированная ссылка на значок файла. |
shared | Только вывод. Был ли файл предоставлен в общий доступ. Не заполняется для элементов на общих дисках. |
lastModifyingUser | Только вывод. Последний пользователь, изменивший файл. |
owners[] | Только вывод. Владелец этого файла. Только у некоторых устаревших файлов может быть более одного владельца. Это поле не заполняется для элементов на общих дисках. |
headRevisionId | Только вывод. Идентификатор версии заголовка файла. В настоящее время это доступно только для файлов с двоичным содержимым на Google Диске. |
sharingUser | Только вывод. Пользователь, который поделился файлом с запрашивающим пользователем, если применимо. |
webViewLink | Только вывод. Ссылка для открытия файла в соответствующем редакторе или просмотрщике Google в браузере. |
webContentLink | Только вывод. Ссылка для загрузки содержимого файла в браузере. Это доступно только для файлов с двоичным содержимым на Google Диске. |
size | Только вывод. Размер больших двоичных объектов и файлов основного редактора в байтах. Не будет заполняться для файлов без размера, таких как ярлыки и папки. |
viewersCanCopyContent | Устарело: вместо этого используйте |
permissions[] | Только вывод. Полный список разрешений для файла. Это доступно только в том случае, если запрашивающий пользователь может поделиться файлом. Не заполняется для элементов на общих дисках. |
hasThumbnail | Только вывод. Имеет ли этот файл миниатюру. Это не указывает, имеет ли запрашивающее приложение доступ к миниатюре. Для проверки доступа ищите наличие поля thumbnailLink. |
spaces[] | Только вывод. Список пространств, которые содержат файл. В настоящее время поддерживаются значения «диск», «appDataFolder» и «фотографии». |
folderColorRgb | Цвет папки или ярлыка папки в виде шестнадцатеричной строки RGB. Поддерживаемые цвета публикуются в поле Если указан неподдерживаемый цвет, вместо него используется ближайший цвет в палитре. |
id | Идентификатор файла. |
name | Имя файла. Это не обязательно уникально внутри папки. Обратите внимание, что для неизменяемых элементов, таких как папки верхнего уровня общих дисков, корневая папка My Drive и папка Application Data, имя является постоянным. |
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 | Только вывод. Может ли текущий пользователь добавить папку с другого диска (другого общего диска или My Drive) в эту папку. Это неверно, если элемент не является папкой. Заполняется только для элементов на общих дисках. |
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 Диске; он не заполняется для редакторов документов или файлов ярлыков. |
ContentRestriction
Ограничение доступа к содержимому файла.
Представление JSON |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
Поля | |
---|---|
readOnly | Является ли содержимое файла доступным только для чтения. Если файл доступен только для чтения, новая версия файла не может быть добавлена, комментарии не могут быть добавлены или изменены, а заголовок файла не может быть изменен. |
reason | Причина, по которой содержимое файла ограничено. Это можно изменить только для запросов, которые также устанавливают |
type | Только вывод. Тип ограничения контента. В настоящее время единственное возможное значение — |
restrictingUser | Только вывод. Пользователь, установивший ограничение контента. Заполняется только в том случае, если |
restrictionTime | Только вывод. Время, когда было установлено ограничение содержимого (временная метка в формате RFC 3339). Заполняется только в том случае, если |
ownerRestricted | Может ли ограничение содержимого быть изменено или удалено только пользователем, которому принадлежит файл. Для файлов на общих дисках любой пользователь с возможностями |
Методы | |
---|---|
| Создает копию файла и применяет любые запрошенные обновления с семантикой исправления. |
| Создает новый файл. |
| Безвозвратно удаляет файл, принадлежащий пользователю, не перемещая его в корзину. |
| Безвозвратно удаляет все файлы пользователя, находящиеся в корзине. |
| Экспортирует документ Google Workspace в запрошенный тип MIME и возвращает экспортированное байтовое содержимое. |
| Создает набор идентификаторов файлов, которые можно указать в запросах на создание или копирование. |
| Получает метаданные или содержимое файла по идентификатору. |
| Список файлов пользователя. |
| Список меток в файле. |
| Изменяет набор меток, применяемых к файлу. |
| Обновляет метаданные и/или содержимое файла. |
| Подписывается на изменения в файле. |