Ресурс: Файл
Метаданные файла.
Некоторые методы ресурсов (например, files.update
) требуют fileId
. Используйте метод files.list
для получения идентификатора файла.
JSON-представление |
---|
{ "ownerNames": [ string ], "exportLinks": { string: string, ... }, "parents": [ { object ( |
Поля | |
---|---|
ownerNames[] | Только вывод. Имя(-ена) владельца(-ев) этого файла. Не заполняется для элементов на общих дисках. |
exportLinks | Только вывод. Ссылки для экспорта файлов Docs Editors в определённые форматы. Объект, содержащий список пар |
parents[] | Идентификатор родительской папки, содержащей файл. Файл может иметь только одну родительскую папку; указание нескольких родительских папок не поддерживается. Если в запросе на вставку не указано иное, файл помещается непосредственно в папку «Мой диск» пользователя. Если в запросе на копирование не указано иное, файл наследует любой обнаруживаемый родительский элемент исходного файла. В запросах files.update необходимо использовать параметры |
owners[] | Только выходные данные. Владелец этого файла. Только некоторые устаревшие файлы могут иметь более одного владельца. Это поле не заполняется для объектов на общих дисках. |
openWithLinks | Только вывод. Сопоставление идентификатора каждого приложения пользователя со ссылкой для открытия файла с помощью этого приложения. Заполняется только при использовании области drive.apps.readonly. Объект, содержащий список пар |
properties[] | Список объектов недвижимости. |
permissions[] | Только вывод. Список разрешений для пользователей, имеющих доступ к этому файлу. Не заполняется для элементов на общих дисках. |
spaces[] | Только вывод. Список пространств, содержащих файл. Поддерживаемые значения: |
permissionIds[] | Только вывод. файлы.список идентификаторов разрешений для пользователей, имеющих доступ к этому файлу. |
contentRestrictions[] | Ограничения доступа к содержимому файла. Заполняется только при наличии такого ограничения. |
kind | Только вывод. Тип файла. Всегда |
userPermission | Только вывод. Разрешения для аутентифицированного пользователя на доступ к этому файлу. |
fileExtension | Только выходные данные. Последний компонент |
md5Checksum | Только выходные данные. Контрольная сумма MD5 для содержимого этого файла. Это поле заполняется только для файлов с содержимым, хранящимся на Google Диске; оно не заполняется для редакторов документов и файлов ярлыков. |
selfLink | Только вывод. Ссылка на этот файл. |
lastModifyingUserName | Только вывод. Имя последнего пользователя, изменившего этот файл. |
editable | Только вывод. Устарело: вместо этого используйте |
writersCanShare | Могут ли авторы делиться документом с другими пользователями. Не заполняется для элементов на общих дисках. |
downloadUrl | Только вывод. Краткосрочный URL-адрес для загрузки файла. Это поле заполняется только для файлов, содержимое которых хранится на Google Диске; оно не заполняется для файлов Google Docs или файлов ярлыков. |
mimeType | MIME-тип файла. Его можно изменить только при обновлении и загрузке нового контента. Это поле можно оставить пустым, и MIME-тип будет определен на основе MIME-типа загруженного контента. |
driveId | Только вывод. Идентификатор общего диска, на котором находится файл. Заполняется только для элементов на общих дисках. |
thumbnailLink | Только вывод. Кратковременная ссылка на миниатюру файла, если она доступна. Обычно она существует порядка нескольких часов. Не предназначена для прямого использования в веб-приложениях из-за Cross-Origin Resource Sharing (CORS) . Рассмотрите возможность использования прокси-сервера. Заполняется только в том случае, если запрашивающее приложение имеет доступ к содержимому файла. Если файл не находится в публичном доступе, URL-адрес, возвращаемый в |
appDataContents | Только вывод. Находится ли этот файл в папке Application Data. |
webViewLink | Только вывод. Ссылка доступна только для просмотра статических веб-ресурсов (HTML, CSS, JS и т. д.) в общедоступных папках через хостинг веб-сайтов Google Диска. |
iconLink | Только вывод. Ссылка на значок файла. |
shared | Только вывод. Был ли файл предоставлен в общий доступ. Не заполняется для объектов на общих дисках. |
lastModifyingUser | Только вывод. Последний пользователь, изменивший этот файл. Это поле заполняется только в том случае, если последнее изменение было внесено вошедшим в систему пользователем. |
defaultOpenWithLink | Только вывод. Ссылка для открытия этого файла в приложении пользователя по умолчанию. Заполняется только при использовании области drive.apps.readonly. |
headRevisionId | Только вывод. Идентификатор начальной версии файла. Это поле заполняется только для файлов с содержимым, хранящимся на Google Диске; оно не заполняется для редакторов документов и файлов ярлыков. |
copyable | Только вывод. Устарело: вместо этого используйте |
etag | Только вывод. ETag файла. |
sharingUser | Только вывод. Пользователь, который поделился элементом с текущим пользователем, если доступно. |
alternateLink | Только вывод. Ссылка для открытия файла в соответствующем редакторе или просмотрщике Google. |
embedLink | Только вывод. Ссылка для встраивания файла. |
webContentLink | Только вывод. Ссылка для загрузки содержимого файла в браузере с использованием аутентификации на основе cookie. В случаях, когда содержимое находится в открытом доступе, его можно загрузить без каких-либо учётных данных. |
fileSize | Только вывод. Размер в байтах для двоичных объектов (BLOB) и файлов редактора собственной разработки. Не заполняется для файлов без размера, таких как ярлыки и папки. |
copyRequiresWriterPermission | Следует ли отключить возможность копирования, печати или загрузки этого файла для читателей и комментаторов. |
hasThumbnail | Только вывод. Есть ли у этого файла миниатюра. Это не указывает, есть ли у запрашивающего приложения доступ к миниатюре. Чтобы проверить доступ, проверьте наличие поля thumbnailLink. |
folderColorRgb | Цвет папки в шестнадцатеричном формате RGB, если файл является папкой или ярлыком папки. Список поддерживаемых цветов доступен в поле folderColorPalette ресурса About. Если указан неподдерживаемый цвет, он будет заменен на ближайший цвет в палитре. |
id | Идентификатор файла. |
title | Название этого файла. Обратите внимание, что для неизменяемых элементов, таких как папки верхнего уровня общих дисков, корневая папка «Мой диск» и папка «Данные приложения», название постоянно. |
description | Краткое описание файла. |
labels | Группа меток для файла. |
labels.viewed | Был ли данный файл просмотрен данным пользователем. |
labels.restricted | Только вывод. Устарело: вместо этого используйте |
labels.starred | Отмечен ли этот файл пользователем. |
labels.hidden | Только вывод. Устарело. |
labels.trashed | Был ли этот файл удалён из корзины? Эта метка применяется ко всем пользователям, получающим доступ к файлу; однако только владельцы могут просматривать файлы и удалять их из корзины. |
labels.modified | Только вывод. Был ли файл изменён этим пользователем. |
explicitlyTrashed | Только вывод. Был ли этот файл удалён явно или рекурсивно. |
createdDate | Только вывод. Время создания этого файла (отформатированная временная метка RFC 3339). |
modifiedDate | Дата последнего изменения этого файла (отформатирована в соответствии с RFC 3339). Эта информация может быть изменена только при обновлении, если установлен параметр setModifiedDate. |
modifiedByMeDate | Только вывод. Время последнего изменения файла пользователем (отформатированная метка времени RFC 3339). Обратите внимание, что установка modificationDate также обновит дату modificationByMe для пользователя, установившего эту дату. |
lastViewedByMeDate | Последний раз пользователь просматривал этот файл (отформатированная временная метка RFC 3339). |
markedViewedByMeDate | Только вывод. Устарело. |
sharedWithMeDate | Только вывод. Время, когда файл был предоставлен пользователю (отформатированная временная метка RFC 3339). |
quotaBytesUsed | Только вывод. Количество байт квоты, используемых этим файлом. |
version | Только вывод. Монотонно увеличивающийся номер версии файла. Он отражает все изменения, внесённые в файл на сервере, даже те, которые не видны запрашивающему пользователю. |
indexableText | Индексируемые текстовые атрибуты для файла (можно только записывать) |
indexableText.text | Текст для индексации этого файла. |
originalFilename | Исходное имя файла загруженного контента (если доступно) или исходное значение поля |
ownedByMe | Только вывод. Принадлежит ли файл текущему пользователю. Не заполняется для объектов на общих дисках. |
canComment | Только вывод. Устарело: вместо этого используйте |
shareable | Только вывод. Устарело: вместо этого используйте |
fullFileExtension | Только выходные данные. Полное расширение файла, извлекаемое из заголовка. Может содержать несколько объединённых расширений, например, «tar.gz». Удаление расширения из заголовка не очищает это поле, однако изменение расширения в заголовке обновляет его. Это поле заполняется только для файлов с содержимым, хранящимся на Google Диске; оно не заполняется для редакторов документов и файлов ярлыков. |
isAppAuthorized | Только вывод. Был ли файл создан или открыт запрашивающим приложением. |
teamDriveId | Только вывод. Устарело: используйте |
capabilities | Только вывод. Возможности текущего пользователя для этого файла. Каждая возможность соответствует детальному действию, которое может выполнить пользователь. |
capabilities.canChangeRestrictedDownload | Только вывод. Устарело. |
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 | Только вывод. Может ли пользователь повторно включить унаследованные разрешения. |
hasAugmentedPermissions | Только вывод. Есть ли разрешения непосредственно на этот файл. Это поле заполняется только для объектов на общих дисках. |
trashingUser | Только вывод. Если файл был явно удалён, укажите пользователя, который его удалил. Заполняется только для объектов на общих дисках. |
canReadRevisions | Только вывод. Устарело: вместо этого используйте |
thumbnailVersion | Только вывод. Версия миниатюры для использования при аннулировании кэша миниатюр. |
trashedDate | Только вывод. Время удаления элемента (в формате RFC 3339). Заполняется только для элементов на общих дисках. |
thumbnail | Миниатюра файла. Будет использоваться только в том случае, если невозможно создать стандартную миниатюру. |
thumbnail.image | Байты миниатюры, закодированные в формате Base64 и безопасные для URL. Они должны соответствовать разделу 5 RFC 4648. Строка в кодировке base64. |
thumbnail.mimeType | Тип MIME миниатюры. |
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.date | Только вывод. Дата и время съёмки фотографии (формат EXIF). |
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 | Отключены ли для этого файла унаследованные разрешения. По умолчанию унаследованные разрешения включены. |
Ограничение контента
Ограничение доступа к содержимому файла.
JSON-представление |
---|
{
"readOnly": boolean,
"reason": string,
"type": string,
"restrictingUser": {
object ( |
Поля | |
---|---|
readOnly | Доступно ли содержимое файла только для чтения. Если файл доступен только для чтения, то нельзя добавлять новые версии файла, добавлять или изменять комментарии, а также изменять название файла. |
reason | Причина, по которой содержимое файла ограничено. Изменить его можно только в запросах, которые также устанавливают |
type | Только вывод. Тип ограничения контента. В настоящее время единственное возможное значение — |
restrictingUser | Только вывод. Пользователь, установивший ограничение на содержимое. Заполняется только в том случае, если |
restrictionDate | Только вывод. Время установки ограничения на контент (отформатированная временная метка RFC 3339). Заполняется только в том случае, если |
ownerRestricted | Может ли ограничение на доступ к контенту изменять или снимать только пользователь, которому принадлежит файл? Для файлов на общих дисках любой пользователь с правами |
systemRestricted | Только вывод. Было ли ограничение контента применено системой, например, из-за электронной подписи. Пользователи не могут изменять или удалять системные ограничения контента. |
Методы | |
---|---|
| Создает копию указанного файла. |
| Навсегда удаляет файл, принадлежащий пользователю, не перемещая его в корзину. |
| Навсегда удаляет все удаленные пользователем файлы. |
| Экспортирует документ Google Workspace в запрошенный тип MIME и возвращает экспортированное байтовое содержимое. |
| Генерирует набор идентификаторов файлов, которые могут быть предоставлены в запросах на вставку или копирование. |
| Получает метаданные или содержимое файла по идентификатору. |
| Вставляет новый файл. |
| Список файлов пользователя. |
| Выводит список меток файла. |
| Изменяет набор меток, примененных к файлу. |
| Обновляет метаданные и/или содержимое файла. |
| Установите время обновления файла в соответствии с текущим временем сервера. |
| Перемещает файл в корзину. |
| Восстанавливает файл из корзины. |
| Обновляет метаданные и/или содержимое файла. |
| Подписывается на изменения в файле. |