Пользовательские свойства файла — это пары «ключ-значение», используемые для хранения пользовательских метаданных для файла Google Диска (например, тегов), идентификаторов из других хранилищ данных, информации, совместно используемой приложениями рабочих процессов, и т. д. Например, вы можете добавить свойства файлов ко всем документам, созданным отделом продаж в первом квартале.
Чтобы добавить свойства, видимые всем приложениям, используйте поле properties ресурса files . Чтобы добавить свойства, ограниченные вашим приложением, используйте поле appProperties ресурса files .
Свойства также можно использовать в выражениях поиска .
Это структура типичного свойства, которое можно использовать для хранения идентификатора базы данных файла Диска в файле.
API Диска 3.
"appProperties": {
"additionalID": "ID",
}
API Диска 2.
{
'key': 'additionalID',
'value': 'ID',
'visibility': 'PRIVATE'
}
Работа с пользовательскими свойствами файла
В этом разделе объясняется, как выполнять некоторые пользовательские задачи, связанные со свойствами файлов, которые влияют на все приложения.
Добавить или обновить пользовательские свойства файла
Чтобы добавить или обновить свойства, видимые для всех приложений, используйте метод files.update , чтобы задать поле properties files ресурса.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}Вы также можете добавить к файлу пользовательское свойство с помощью расширенной службы Диска в скрипте Google Apps. Дополнительную информацию см. в разделе Добавление пользовательских свойств .
Получить или вывести список пользовательских свойств файла
Чтобы просмотреть свойства, видимые всем приложениям, используйте метод files.get для получения пользовательских свойств файла.
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties Ответ состоит из объекта properties , содержащего коллекцию пар ключ-значение.
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}Удаление пользовательских свойств файла
Чтобы удалить значения свойств, видимые всем приложениям, используйте метод files.update , чтобы установить для поля properties ресурса files значение null.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID{
"name": null
} Чтобы просмотреть изменение, вызовите метод files.get чтобы получить объект properties файла.
{
"properties": {
"mass": "1.3kg",
"count": "3"
}
}Ограничения пользовательских свойств файла
Пользовательские свойства имеют следующие ограничения:
- Максимум 100 пользовательских свойств на файл, всего из всех источников.
- Максимум 30 общедоступных свойств на файл, всего из всех источников.
- Максимум 30 частных свойств на файл из любого приложения.
- Максимум 124 байта на строку свойства (включая ключ и значение) в кодировке UTF-8. Например, значение свойства с ключом длиной 10 символов может содержать только 114 символов. Аналогично, свойство, для значения которого требуется 100 символов, может использовать в качестве ключа до 24 символов.
Для получения дополнительной информации см. ресурс files . Для Drive API v2 см. ресурс properties .
Доступ к личным пользовательским свойствам файла
Вы можете получить частные свойства, используя поле appProperties только посредством аутентифицированного запроса, который использует токен доступа, полученный с идентификатором клиента OAuth 2.0. Вы не можете использовать ключ API для получения частных свойств.