Désactiver, activer et supprimer un libellé

Cette page explique comment effectuer ces tâches 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 sur la base de la révision publiée en cours. S'il existe un brouillon de révision, un nouveau brouillon désactivé est créé à partir de la dernière révision brouillon. Les révisions du brouillon plus anciennes sont supprimées. Pour en savoir plus, consultez la section Cycle de vie des étiquettes.

Une fois le libellé désactivé, les utilisateurs peuvent toujours l'appliquer via l'API. 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 méthode disable sur la collection labels.

Vous devez également spécifier les informations suivantes:

• Une ressource d'étiquette qui représente chaque étiquette. Il contient une ressource Name et ID, qui est l'identifiant unique du libellé.

• useAdminAccess est true pour utiliser les identifiants d'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 State du libellé est 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é ne s'affiche dans l'interface utilisateur que si la propriété showInApply de la méthode disabledPolicy est configurée.

Activer un libellé

Si vous activez un libellé désactivé, son état de publication sera rétabli. Il en résulte une nouvelle révision publiée basée sur la révision actuellement désactivée. S'il existe déjà une révision de brouillon désactivée, une révision est créée à partir de ce brouillon et est activée. Pour en savoir plus, consultez la section Cycle de vie des étiquettes.

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

Vous devez également spécifier les informations suivantes:

• Une ressource d'étiquette qui représente chaque étiquette. Il contient une ressource Name et ID, qui est l'identifiant unique du libellé.

• useAdminAccess est true pour utiliser les identifiants d'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 State du libellé est 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 brouillons et les libellés désactivés peuvent être supprimés. Lorsqu'un libellé est supprimé, toutes les instances auxquelles il était appliqué précédemment, y compris les valeurs de champs 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 méthode delete.

Vous devez également spécifier les informations suivantes:

• Une ressource d'étiquette qui représente chaque étiquette. Il contient une ressource Name et ID, qui est l'identifiant unique du libellé.

• useAdminAccess est true pour utiliser les identifiants d'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 State du libellé est 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 finissent par être définitivement supprimés. Pour en savoir plus, consultez la section Cycle de vie des étiquettes.