Les propriétés de fichiers personnalisées sont des paires clé/valeur utilisées pour stocker les métadonnées personnalisées d'un fichier Google Drive (telles que les 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 des expressions de recherche.
Il s'agit de la structure d'une propriété classique pouvant être utilisée pour y stocker l'ID de base de données d'un fichier Drive.
API Drive v3
"appProperties": {
"additionalID": "ID",
}
API Drive v2
{
'key': 'additionalID',
'value': 'ID',
'visibility': 'PRIVATE'
}
Utiliser des propriétés de fichier personnalisées
Cette section explique comment effectuer certaines tâches liées aux propriétés de fichiers personnalisées 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 pour 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é de Google Apps Script. Pour en savoir plus, consultez 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 consiste en un objet properties contenant une collection de paires clé/valeur.
{
"properties": {
"name": "wrench",
"mass": "1.3kg",
"count": "3"
}
}
Supprimer des 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 la valeur "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:
- 100 propriétés personnalisées maximum par fichier, au total pour toutes les sources.
- Maximum de 30 propriétés publiques par fichier, toutes sources confondues.
- 30 propriétés privées au maximum par fichier pour une même application
- 124 octets maximum par chaîne de propriété (clé et valeur incluses) dans l'encodage UTF-8. Par exemple, la valeur d'une propriété avec une clé de 10 caractères ne peut pas dépasser 114 caractères. De même, une propriété qui requiert 100 caractères pour la valeur peut utiliser jusqu'à 24 caractères 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 des fichiers personnalisés privés
Vous ne pouvez récupérer des propriétés privées à l'aide du champ appProperties que 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 de clé API pour récupérer des propriétés privées.