Добавить пользовательские свойства файла

Пользовательские свойства файла — это пары «ключ-значение», используемые для хранения пользовательских метаданных файла Google Диска (например, тегов), идентификаторов из других хранилищ данных, информации, передаваемой между приложениями рабочих процессов, и т. д. Например, вы можете добавить свойства файла ко всем документам, созданным отделом продаж в первом квартале.

Чтобы добавить свойства, видимые всем приложениям, используйте поле properties ресурса « files . Чтобы добавить свойства, доступные только вашему приложению, используйте поле appProperties ресурса files .

Свойства также можно использовать в поисковых выражениях .

Это структура типичного свойства, которое может использоваться для хранения идентификатора базы данных файла Диска в файле.

"appProperties": {
  "additionalID": "ID",
}

{
  '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 Script. Подробнее см. в разделе Добавление пользовательских свойств .

Получить или перечислить пользовательские свойства файла

Чтобы просмотреть свойства, видимые всем приложениям, используйте метод 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 частных объектов в одном файле из одного приложения.
• Максимальная длина строки свойства (включая ключ и значение) в кодировке UTF-8 составляет 124 байта. Например, свойство с ключом длиной 10 символов может содержать значение длиной не более 114 символов. Аналогично, свойство, значение которого требует 100 символов, может содержать до 24 символов в качестве ключа.

Дополнительную информацию см. в разделе « files ». Для Drive API v2 см. в разделе « properties .

Доступ к личным пользовательским свойствам файла

Извлечь приватные свойства можно только с помощью поля appProperties через аутентифицированный запрос, использующий токен доступа, полученный с помощью идентификатора клиента OAuth 2.0. Использовать ключ API для извлечения приватных свойств невозможно.