Labels deaktivieren, aktivieren und löschen

Auf dieser Seite wird beschrieben, wie Sie die folgenden Aufgaben mit Labels ausführen:

  • Label deaktivieren
  • Label aktivieren
  • Labels löschen

Label deaktivieren

Wenn Sie ein Label deaktivieren, wird eine neue deaktivierte veröffentlichte Version basierend auf der aktuellen veröffentlichten Version erstellt. Wenn es eine Entwurfsversion gibt, wird eine neue deaktivierte Entwurfsversion basierend auf der neuesten Entwurfsversion erstellt. Ältere Entwurfsüberarbeitungen werden gelöscht. Weitere Informationen finden Sie unter Labellebenszyklus.

Nach der Deaktivierung können Nutzer dieses Label weiterhin über die API anwenden. Das Label wird weiterhin dort angezeigt, wo es bereits angewendet wurde, und in den Suchergebnissen. Deaktivierte Labels können gelöscht werden.

Wenn Sie ein veröffentlichtes Label deaktivieren möchten, verwenden Sie die Methode disable für die Sammlung labels.

Außerdem müssen Sie Folgendes angeben:

  • Eine Labelressource, die jedes Label darstellt. Es enthält die Ressourcen Name und ID, die eine global eindeutige Kennzeichnung für das Label sind.

  • useAdminAccess ist true, um die Administratoranmeldedaten des Nutzers zu verwenden. Der Server prüft, ob der Nutzer ein Administrator für das Label ist, bevor er Zugriff gewährt.

In diesem Beispiel wird das richtige Label mit ID deaktiviert.

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);
});

Das Label hat die State von DISABLED und die Revisions-ID des Labels wird erhöht. Nutzer können das Label über die API anwenden. Ein deaktiviertes Label wird jedoch nur dann in einer Benutzeroberfläche angezeigt, wenn die Eigenschaft showInApply der Methode disabledPolicy konfiguriert ist.

Label aktivieren

Wenn Sie ein deaktiviertes Label aktivieren, wird es in den veröffentlichten Zustand zurückversetzt. Dies führt zu einer neuen veröffentlichten Version, die auf der aktuellen deaktivierten veröffentlichten Version basiert. Wenn es bereits eine deaktivierte Entwurfsversion gibt, wird eine neue Version basierend auf diesem Entwurf erstellt und aktiviert. Weitere Informationen finden Sie unter Labellebenszyklus.

Verwenden Sie die Methode enable, um ein deaktiviertes Label zu aktivieren.

Außerdem müssen Sie Folgendes angeben:

  • Eine Labelressource, die jedes Label darstellt. Es enthält die Ressourcen Name und ID, die eine global eindeutige Kennzeichnung für das Label sind.

  • useAdminAccess ist true, um die Administratoranmeldedaten des Nutzers zu verwenden. Der Server prüft, ob der Nutzer ein Administrator für das Label ist, bevor er Zugriff gewährt.

In diesem Beispiel wird das ID verwendet, um das richtige Label zu aktivieren.

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);
});

Das Label hat die State von PUBLISHED und die Revisions-ID des Labels wird erhöht. Nutzer können das Label über die API aufrufen und auf Dateien anwenden.

Labels löschen

Nur Labels im Entwurfsstatus und deaktivierte Labels können gelöscht werden. Wenn ein Label gelöscht wird, werden alle Instanzen, in denen es zuvor angewendet wurde, einschließlich aller von Nutzern eingegebenen Feldwerte, endgültig gelöscht und aus den entsprechenden Google Drive-Dateien entfernt.

Wenn Sie ein Label löschen möchten, müssen Sie es zuerst deaktivieren und dann die Methode delete verwenden.

Außerdem müssen Sie Folgendes angeben:

  • Eine Labelressource, die jedes Label darstellt. Es enthält die Ressourcen Name und ID, die eine global eindeutige Kennzeichnung für das Label sind.

  • useAdminAccess ist true, um die Administratoranmeldedaten des Nutzers zu verwenden. Der Server prüft, ob der Nutzer ein Administrator für das Label ist, bevor er Zugriff gewährt.

In diesem Beispiel wird das richtige Label mit ID gelöscht.

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);
});

Das Label hat die State von DELETED und die Revisions-ID des Labels wird erhöht. Das Label kann nicht angewendet werden und gelöschte Labels werden irgendwann gelöscht. Weitere Informationen finden Sie unter Labellebenszyklus.