Label erstellen und veröffentlichen

Auf dieser Seite wird beschrieben, wie du ein Label erstellst und veröffentlichst.

Labels erstellen

Verwenden Sie zum Erstellen eines Labels die Methode create in der Sammlung labels. Labels können optional ein oder mehrere Fields enthalten.

Außerdem müssen Sie Folgendes angeben:

• Ein LabelType.

• Ein Label title über die Methode property

• useAdminAccess ist true, um die Administratoranmeldedaten des Nutzers zu verwenden. Der Server prüft, ob der Nutzer ein Administrator mit der Berechtigung „Labels verwalten“ ist, bevor er Zugriff gewährt.

In diesem Beispiel wird ein standardmäßiges Administratorlabel mit einem bestimmten Titel und ein SelectionOptions Field mit 2 Choices erstellt.

PythonNode.js

label_body = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
        'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
        'list_options': {},
        'choices': [{
            'properties': {
                'display_name': 'CHOICE_1'
            }
        }, {
            'properties': {
                'display_name': 'CHOICE_2'
            }
        }]
    }
}]
}
response = service.labels().create(
    body=label_body, useAdminAccess=True).execute()

var label = {
'label_type': 'ADMIN',
'properties': {
    'title': 'TITLE'
},
'fields': [{
    'properties': {
    'display_name': 'DISPLAY_NAME'
    },
    'selection_options': {
    'list_options': {},
    'choices': [{
        'properties': {
        'display_name': 'CHOICE_1'
        }
    }, {
        'properties': {
        'display_name': 'CHOICE_2'
        }
    }]
    }
}]
};

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

Das Label wird in UNPUBLISHED_DRAFT State erstellt. Sie muss PUBLISHED sein, damit sie in Dateien verwendet und für Nutzer sichtbar ist. Weitere Informationen finden Sie unter Labellebenszyklus.

Label limits

Beim Erstellen und Anwenden von Labels gelten die folgenden Einschränkungen:

• Standardlabels – 150
• Felder pro Label: 10
• Von Nutzern angewendete Labels pro Datei: 5

Mit Feldern in Labels arbeiten

Field Type	Optionen für Nutzer	Hinweise zu Formaten und Beschränkungen
SelectionOptions	Eine oder mehrere Optionen aus einer Liste auswählen	Es sind maximal 200 Optionen zulässig. Die maximale Anzahl von Auswahlen für eine Datei beträgt 10, wie in ListOptions konfiguriert.
IntegerOptions	Geben Sie einen numerischen Wert ein.	Es können nur ganze Zahlen eingegeben werden.
DateOptions	Kalenderdatum auswählen	Optional: Date format kann auf „Lang: Monat TT, JJJJ“ oder „Kurz: MM/TT/JJ“ festgelegt werden.
TextOptions	Text in ein Textfeld eingeben	Es können maximal 100 Zeichen eingegeben werden.
UserOptions	Wählen Sie einen oder mehrere Nutzer aus den Google Workspace-Kontakten aus.	Die maximale Anzahl von Nutzereinträgen für eine Datei beträgt 10, wie in ListOptions konfiguriert.

Label veröffentlichen

Mit der Labels API kannst du einen Labelentwurf veröffentlichen, sobald er fertig ist.

Verwenden Sie zum Veröffentlichen eines Labels die Methode publish und geben Sie Folgendes an:

• 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 mit der Berechtigung „Labels verwalten“ ist, bevor er Zugriff gewährt.

In diesem Beispiel wird das ID verwendet, um das richtige Label zu identifizieren und zu veröffentlichen.

PythonNode.js

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

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

Nach der Veröffentlichung wird das Label in den PUBLISHED State verschoben und die Überarbeitungs-ID des Labels wird erhöht. Das Label ist dann für Nutzer sichtbar und kann auf Dateien angewendet werden. Weitere Informationen finden Sie unter Labellebenszyklus.

Einschränkungen beim Veröffentlichen von Labels

• Nach der Veröffentlichung kann ein Label nicht mehr in den ursprünglichen Entwurfsstatus zurückversetzt werden. Weitere Informationen finden Sie unter Labellebenszyklus.

• Wenn Sie ein Label veröffentlichen, wird eine neu veröffentlichte Version erstellt. Alle vorherigen Überarbeitungen des Entwurfs werden gelöscht. Zuvor veröffentlichte Versionen werden beibehalten, können aber bei Bedarf automatisch gelöscht werden.

• Nach der Veröffentlichung sind einige Änderungen nicht mehr zulässig. Das bedeutet im Allgemeinen, dass jede Änderung abgelehnt wird, die vorhandene Metadaten im Zusammenhang mit dem Label ungültig macht oder neue Einschränkungen auslöst. Nach der Veröffentlichung eines Labels sind beispielsweise die folgenden Änderungen nicht zulässig:

  • Das Label wird direkt gelöscht. (Sie muss zuerst deaktiviert und dann gelöscht werden.)
  • Die Field.FieldType wird geändert.
  • Durch Änderungen an den Optionen für die Feldvalidierung werden zuvor akzeptierte Eingaben abgelehnt.
  • Die maximale Anzahl der Einträge wurde reduziert.