Désactiver, activer et supprimer un libellé

Ce document explique comment effectuer les tâches suivantes impliquant des libellés :

  • Désactiver un libellé
  • Activer un libellé
  • Supprimer un libellé

Désactiver un libellé

La désactivation d'un libellé entraîne la création d'une nouvelle révision publiée désactivée basée sur la révision publiée actuelle. S'il existe une révision brouillon, une nouvelle révision brouillon désactivée est créée à partir de la dernière révision brouillon. Les anciennes révisions brouillon sont supprimées. Pour en savoir plus, consultez Cycle de vie des libellés.

Une fois désactivé, les utilisateurs peuvent toujours appliquer ce libellé via l'API Google Drive Labels. Le libellé apparaît toujours là où il a déjà été appliqué et dans vos résultats de recherche. Un libellé désactivé peut être supprimé.

Pour désactiver un libellé publié, utilisez la disable méthode sur la labels ressource.

Vous devez également spécifier les éléments suivants :

  • Une ressource labels représentant le libellé. Elle contient un name et un id, qui est un identifiant unique global pour le libellé.

  • Le paramètre de requête useAdminAccess est défini sur true pour utiliser les identifiants d'administrateur de l'utilisateur. Avant d'autoriser l'accès, le serveur vérifie que l'utilisateur dispose des droits d'administrateur requis pour gérer les libellés de classification.

L'exemple de code suivant montre comment utiliser l'id du libellé pour désactiver le libellé approprié :

Python

service.labels().disable(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.disable({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Remplacez ID par l'ID du libellé à désactiver.

Le libellé a le State de DISABLED et l'ID de révision du libellé est incrémenté. Les utilisateurs peuvent appliquer le libellé via l'API Drive Labels. Toutefois, un libellé désactivé n'est pas affiché dans une interface utilisateur, sauf si le showInApply champ de l' DisabledPolicy objet est configuré.

Activer un libellé

L'activation d'un libellé désactivé le rétablit à son état publié. Cela entraîne la création d'une nouvelle révision publiée basée sur la révision publiée désactivée actuelle. S'il existe une révision brouillon désactivée, une nouvelle révision est créée à partir de ce brouillon et est activée. Pour en savoir plus, consultez Cycle de vie des libellés.

Pour activer un libellé désactivé, utilisez la enable méthode sur la ressource labels.

Vous devez également spécifier les éléments suivants :

  • Une ressource labels représentant le libellé. Elle contient un name et un id, qui est un identifiant unique global pour le libellé.

  • Le paramètre de requête useAdminAccess est défini sur true pour utiliser les identifiants d'administrateur de l'utilisateur. Avant d'autoriser l'accès, le serveur vérifie que l'utilisateur dispose des droits d'administrateur requis pour gérer les libellés de classification.

L'exemple de code suivant montre comment utiliser l'id du libellé pour activer le libellé approprié :

Python

service.labels().enable(
    name='labels/ID',
    body={
        'useAdminAccess': True
    }
).execute()

Node.js

service.labels.enable({
  name: 'labels/ID',
  requestBody: {
    useAdminAccess: true
  }
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Remplacez ID par l'ID du libellé à activer.

Le libellé a le State de PUBLISHED et l'ID de révision du libellé est incrémenté. Les utilisateurs peuvent afficher et appliquer le libellé aux fichiers via l'API Drive Labels.

Supprimer un libellé

Seuls les libellés brouillons et désactivés peuvent être supprimés. Lorsqu'un libellé est supprimé, toutes les instances auxquelles il s'appliquait, y compris toutes les valeurs de champ correspondantes saisies par les utilisateurs, sont définitivement supprimées et retirées de ces fichiers Drive.

Pour supprimer un libellé, vous devez d'abord le désactiver, puis utiliser la delete méthode sur la ressource labels.

Vous devez également spécifier les éléments suivants :

  • Une ressource labels représentant le libellé. Elle contient un name et un id, qui est un identifiant unique global pour le libellé.

  • Le paramètre de requête useAdminAccess est défini sur true pour utiliser les identifiants d'administrateur de l'utilisateur. Avant d'autoriser l'accès, le serveur vérifie que l'utilisateur dispose des droits d'administrateur requis pour gérer les libellés de classification.

L'exemple de code suivant montre comment utiliser l'id du libellé pour supprimer le libellé approprié :

Python

response = service.labels().delete(
    name='labels/ID',
    useAdminAccess=True
).execute()

Node.js

service.labels.delete({
  name: 'labels/ID',
  useAdminAccess: true
}, (err, res) => {
  if (err) return console.error('The API returned an error: ' + err);
  console.log(res);
});

Remplacez ID par l'ID du libellé à supprimer.

Le libellé a le State de DELETED et l'ID de révision du libellé est incrémenté. Le libellé ne peut pas être appliqué et les libellés supprimés sont finalement purgés. Pour en savoir plus, consultez Cycle de vie des libellés.