Ресурс: Файл
Метаданные файла.
Для некоторых методов ресурсов (например, files.update
) требуется fileId
. Используйте метод files.list
для получения идентификатора файла.
JSON-представление |
---|
{ "kind": string, "userPermission": { object ( |
Поля | |
---|---|
kind | Только вывод. Тип файла. Это всегда |
userPermission | Только вывод. Разрешения для аутентифицированного пользователя в этом файле. |
fileExtension | Только вывод. Последний компонент |
md5Checksum | Только вывод. Контрольная сумма MD5 содержимого этого файла. Это поле заполняется только для файлов, контент которых хранится на Google Диске; он не заполняется для редакторов документов или файлов ярлыков. |
selfLink | Только вывод. Ссылка на этот файл. |
ownerNames[] | Только вывод. Имя(а) владельца(ов) этого файла. Не заполняется для объектов на общих дисках. |
lastModifyingUserName | Только вывод. Имя последнего пользователя, изменившего этот файл. |
editable | Только вывод. Устарело: вместо этого используйте |
writersCanShare | Могут ли авторы делиться документом с другими пользователями. Не заполняется для объектов на общих дисках. |
downloadUrl | Только вывод. Кратковременный URL-адрес загрузки файла. Это поле заполняется только для файлов, контент которых хранится на Google Диске; он не заполняется для Документов Google или файлов ярлыков. |
mimeType | MIME-тип файла. Это значение меняется только при обновлении при загрузке нового контента. Это поле можно оставить пустым, и MIME-тип будет определяться на основе MIME-типа загруженного контента. |
exportLinks | Только вывод. Ссылки для экспорта файлов редакторов документов в определенные форматы. Объект, содержащий список пар |
driveId | Только вывод. Идентификатор общего диска, на котором находится файл. Заполняется только для элементов на общих дисках. |
parents[] | Идентификатор родительской папки, содержащей файл. У файла может быть только одна родительская папка; указание нескольких родителей не поддерживается. Если это не указано в запросе на вставку, файл помещается непосредственно в папку «Мой диск» пользователя. Если не указано в запросе на копирование, файл наследует любого обнаруживаемого родительского элемента исходного файла. Запросы files.update должны использовать параметры |
thumbnailLink | Только вывод. Кратковременная ссылка на миниатюру файла, если она доступна. Обычно длится порядка нескольких часов. Не предназначен для прямого использования в веб-приложениях из-за совместного использования ресурсов между источниками (CORS). Рассмотрите возможность использования прокси-сервера. Заполняется только тогда, когда запрашивающее приложение может получить доступ к содержимому файла. Если файл не является общедоступным, URL-адрес, возвращаемый в |
appDataContents | Только вывод. Находится ли этот файл в папке Application Data. |
webViewLink | Только вывод. Ссылка доступна только в общедоступных папках для просмотра их статических веб-ресурсов (HTML, CSS, JS и т. д.) через хостинг веб-сайтов Google Drive. |
iconLink | Только вывод. Ссылка на значок файла. |
shared | Только вывод. Был ли файл опубликован. Не заполняется для объектов на общих дисках. |
lastModifyingUser | Только вывод. Последний пользователь, изменивший этот файл. Это поле заполняется только в том случае, если последнее изменение было выполнено вошедшим в систему пользователем. |
owners[] | Только вывод. Владелец этого файла. Только некоторые устаревшие файлы могут иметь более одного владельца. Это поле не заполняется для объектов на общих дисках. |
openWithLinks | Только вывод. Сопоставление идентификатора каждого приложения пользователя со ссылкой для открытия этого файла с помощью этого приложения. Заполняется только при использовании области Drive.apps.readonly. Объект, содержащий список пар |
defaultOpenWithLink | Только вывод. Ссылка для открытия этого файла с помощью приложения пользователя по умолчанию для этого файла. Заполняется только при использовании области Drive.apps.readonly. |
headRevisionId | Только вывод. Идентификатор редакции заголовка файла. Это поле заполняется только для файлов, контент которых хранится на Google Диске; он не заполняется для редакторов документов или файлов ярлыков. |
properties[] | Список свойств. |
copyable | Только вывод. Устарело: вместо этого используйте |
etag | Только вывод. ETag файла. |
sharingUser | Только вывод. Пользователь, который поделился элементом с текущим пользователем, если доступен. |
alternateLink | Только вывод. Ссылка для открытия файла в соответствующем редакторе или средстве просмотра Google. |
embedLink | Только вывод. Ссылка для встраивания файла. |
webContentLink | Только вывод. Ссылка для загрузки содержимого файла в браузере с использованием аутентификации на основе файлов cookie. В тех случаях, когда контент публикуется публично, его можно загрузить без каких-либо учетных данных. |
fileSize | Только вывод. Размер больших двоичных объектов и файлов собственных редакторов в байтах. Не заполняется для файлов без размера, таких как ярлыки и папки. |
copyRequiresWriterPermission | Должны ли быть отключены возможности копирования, печати или загрузки этого файла для читателей и комментаторов. |
permissions[] | Только вывод. Список разрешений для пользователей, имеющих доступ к этому файлу. Не заполняется для объектов на общих дисках. |
hasThumbnail | Только вывод. Имеет ли этот файл миниатюру. Это не указывает на то, имеет ли запрашивающее приложение доступ к миниатюре. Для проверки доступа обратите внимание на наличие поля «thumbnailLink». |
spaces[] | Только вывод. Список пространств, содержащих файл. Поддерживаемые значения: |
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). Обратите внимание, что установка ModifiedDate также обновит дату ModifiedByMe для пользователя, который установил эту дату. |
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 | Только вывод. Может ли текущий пользователь перемещать дочерние элементы этой папки за пределы общего диска. Это неверно, если элемент не является папкой. Заполняется только для объектов на общих дисках. |
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 | Только вывод. Если файл был явно удален, указывается пользователь, который его удалил. Заполняется только для объектов на общих дисках. |
canReadRevisions | Только вывод. Устарело: вместо этого используйте |
thumbnailVersion | Только вывод. Версия миниатюры для использования при аннулировании кэша миниатюр. |
trashedDate | Только вывод. Время удаления элемента (метка времени в формате RFC 3339). Заполняется только для объектов на общих дисках. |
permissionIds[] | Только вывод. files.list идентификаторов разрешений для пользователей, имеющих доступ к этому файлу. |
thumbnail | Миниатюра файла. Это будет использоваться только в том случае, если невозможно создать стандартную миниатюру. |
thumbnail.image | Байты эскиза изображения, безопасные для URL-адресов в кодировке Base64. Он должен соответствовать разделу 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 | Только вывод. Наименьшее число 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 | Только вывод. Пользователь, установивший ограничение контента. Заполняется только в том случае, если |
restrictionDate | Только вывод. Время, когда было установлено ограничение контента (метка времени в формате RFC 3339). Заполняется только в том случае, если |
ownerRestricted | Может ли ограничение содержимого быть изменено или снято только пользователем, которому принадлежит файл. Для файлов на общих дисках любой пользователь с возможностями |
systemRestricted | Только вывод. Было ли ограничение по содержанию применено системой, например, из-за подписи. Пользователи не могут изменять или удалять ограничения на содержимое, ограниченное системой. |
Методы | |
---|---|
| Создает копию указанного файла. |
| Безвозвратно удаляет файл, принадлежащий пользователю, не перемещая его в корзину. |
| Безвозвратно удаляет все удаленные файлы пользователя. |
| Экспортирует документ Google Workspace в запрошенный тип MIME и возвращает экспортированное байтовое содержимое. |
| Генерирует набор идентификаторов файлов, которые могут быть предоставлены в запросах на вставку или копирование. |
| Получает метаданные или содержимое файла по идентификатору. |
| Вставляет новый файл. |
| Перечисляет файлы пользователя. |
| Перечисляет метки в файле. |
| Изменяет набор меток, примененных к файлу. |
| Обновляет метаданные и/или содержимое файла. |
| Установите время обновления файла на текущее время сервера. |
| Перемещает файл в корзину. |
| Восстанавливает файл из корзины. |
| Обновляет метаданные и/или содержимое файла. |
| Подписывается на изменения в файле. |