Désactiver, activer et supprimer un libellé

Cette page explique comment effectuer les tâches suivantes concernant les 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 publication d'une nouvelle révision 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 de brouillons sont supprimées. Pour en savoir plus, consultez Cycle de vie des libellés.

Une fois cette étiquette désactivée, les utilisateurs peuvent toujours l'appliquer via l'API. Le libellé apparaît toujours là où il a déjà été appliqué, ainsi que dans vos résultats de recherche. Vous pouvez supprimer un libellé désactivé.

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

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

• Une ressource Label qui représente chaque libellé. Il contient une ressource Name et ID, qui est un identifiant unique global pour le libellé.

• useAdminAccess est true pour utiliser les identifiants administrateur de l'utilisateur. Le serveur vérifie que l'utilisateur est un administrateur du libellé avant d'autoriser l'accès.

Cet exemple utilise ID pour désactiver le libellé approprié.

Python

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

Node.js

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

Le libellé comporte le State de DISABLED et l'ID de révision du libellé est incrémenté. Les utilisateurs peuvent appliquer le libellé via l'API. Toutefois, un libellé désactivé n'est pas affiché dans une UI, sauf si la propriété showInApply de la méthode disabledPolicy est configurée.

Activer un libellé

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

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

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

• Une ressource Label qui représente chaque libellé. Il contient une ressource Name et ID, qui est un identifiant unique global pour le libellé.

• useAdminAccess est true pour utiliser les identifiants administrateur de l'utilisateur. Le serveur vérifie que l'utilisateur est un administrateur du libellé avant d'autoriser l'accès.

Cet exemple utilise ID pour activer le libellé approprié.

Python

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

Node.js

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

Le libellé comporte 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.

Supprimer un libellé

Seuls les libellés en brouillon 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 des fichiers Drive.

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

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

• Une ressource Label qui représente chaque libellé. Il contient une ressource Name et ID, qui est un identifiant unique global pour le libellé.

• useAdminAccess est true pour utiliser les identifiants administrateur de l'utilisateur. Le serveur vérifie que l'utilisateur est un administrateur du libellé avant d'autoriser l'accès.

Cet exemple utilise ID pour supprimer le libellé approprié.

Python

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

Node.js

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

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