Les propriétés de fichier personnalisées sont des paires clé/valeur utilisées pour stocker les métadonnées personnalisées d'un fichier Google Drive (telles que des tags), les ID d'autres datastores, les informations partagées entre les applications de workflow, etc. Par exemple, vous pouvez ajouter des propriétés de fichier à tous les documents générés par le service commercial au premier trimestre.
Pour ajouter des propriétés visibles par toutes les applications, utilisez le champ properties de la ressource files. Pour ajouter des propriétés limitées à votre application, utilisez le champ appProperties de la ressource files.
Les propriétés peuvent également être utilisées dans les expressions de recherche.
Il s'agit de la structure d'une propriété type permettant de stocker l'ID de base de données d'un fichier Drive dans un fichier.
API Drive version 3
"appProperties": {
"additionalID": "ID",
}
API Drive version 2
{
'key': 'additionalID',
'value': 'ID',
'visibility': 'PRIVATE'
}
Utiliser des propriétés de fichier personnalisées
Cette section explique comment effectuer des tâches personnalisées liées aux propriétés de fichier qui affectent toutes les applications.
Ajouter ou mettre à jour des propriétés de fichier personnalisées
Pour ajouter ou mettre à jour des propriétés visibles par toutes les applications, utilisez la méthode files.update afin de définir le champ properties de la ressource files.
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}
Vous pouvez également ajouter une propriété personnalisée à un fichier à l'aide du service Drive avancé dans Google Apps Script. Pour en savoir plus, consultez la section Ajouter des propriétés personnalisées.
Obtenir ou répertorier des propriétés de fichier personnalisées
Pour afficher les propriétés visibles par toutes les applications, récupérez les propriétés personnalisées du fichier à l'aide de la méthode files.get.
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties
La réponse se compose d'un objet properties qui contient un ensemble de paires clé/valeur.
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}
Supprimer les propriétés de fichier personnalisées
Pour supprimer les valeurs de propriété visibles par toutes les applications, utilisez la méthode files.update afin de définir le champ properties de la ressource files sur "null".
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID
{
"name": null
}
Pour afficher la modification, appelez la méthode files.get afin de récupérer l'objet properties du fichier.
{
"properties": {
"mass": "1.3kg",
"count": "3"
}
}
Limites des propriétés de fichier personnalisées
Les limites suivantes s'appliquent aux propriétés personnalisées:
- Maximum de 100 propriétés personnalisées par fichier, toutes sources confondues.
- Un fichier ne peut pas contenir plus de 30 propriétés publiques, toutes sources confondues.
- Un maximum de 30 propriétés privées par fichier et par application.
- 124 octets maximum par chaîne de propriété (clé et valeur incluses) en encodage UTF-8. Par exemple, une propriété avec une clé comportant 10 caractères ne peut pas comporter plus de 114 caractères. De même, une propriété dont la valeur doit comporter 100 caractères peut en utiliser jusqu'à 24 pour la clé.
Pour en savoir plus, consultez la ressource files. Pour l'API Drive v2, consultez la ressource properties.
Accéder aux propriétés privées des fichiers personnalisés
Vous ne pouvez récupérer des propriétés privées qu'à l'aide du champ appProperties via une requête authentifiée qui utilise un jeton d'accès obtenu avec un ID client OAuth 2.0. Vous ne pouvez pas utiliser une clé API pour récupérer des propriétés privées.