Ajouter des propriétés de fichier personnalisées

Les propriétés de fichier personnalisées sont des paires clé/valeur utilisées pour stocker les métadonnées personnalisées d'une les fichiers Google Drive (tels que les tags), les identifiants d'autres data stores, les informations partagés entre les applications de workflow, etc. Par exemple, vous pouvez ajouter un 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 Ressource files. Pour ajouter des propriétés limité à votre application, utilisez le champ appProperties de la ressource files.

Vous pouvez également utiliser les propriétés pour effectuer des recherches expressions.

Il s'agit de la structure d'une propriété typique pouvant servir à stocker ID de base de données du fichier Drive.

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

{
  '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 affecter 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 files.update pour définir Champ properties de files ressource.

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 des options avancées Service Drive dans Google Apps Script. Pour en savoir plus, consultez Ajouter des propriétés.

Obtenir ou répertorier des propriétés de fichier personnalisées

Pour afficher les propriétés visibles par toutes les applications, utilisez la files.get pour récupérer les personnalisées pour le fichier.

GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=properties

La réponse se compose d'un objet properties qui contient une collection de 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 files.update pour définir Champ properties de files la ressource sur "null".

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID

{
  "name": null
}

Pour afficher la modification, appelez la méthode files.get pour récupérer les properties pour le 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:

• Le nombre de propriétés personnalisées est limité à 100 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.
• Maximum de 124 octets par chaîne de propriété (clé et valeur incluses) dans Encodage UTF-8. Par exemple, une propriété avec une clé de 10 caractères ne peut comporter que 114 caractères. De même, une propriété requiert 100 caractères pour la valeur, vous pouvez utiliser jusqu'à 24 caractères pour la valeur .

Pour en savoir plus, consultez le files ressource. Pour l'API Drive v2, consultez les 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 via un protocole ID client. Vous ne pouvez pas utiliser une clé API pour récupérer des propriétés privées.